Initial version proposal #6
Conversation
| # - name: Install Pip | ||
| # run: | | ||
| # python -m pip install --upgrade pip | ||
| # | ||
| # - name: "Install Test Dependencies" | ||
| # run: | | ||
| # python -m pip install wheel | ||
| # python -m pip install pytest | ||
| # python -m pip install pytest-cov | ||
| # | ||
| # - name: "Install dependencies" | ||
| # run: | | ||
| # python -m pip install -r requirements.txt | ||
| # | ||
| # - name: Test with pytest | ||
| # run: | | ||
| # pytest tests |
There was a problem hiding this comment.
Testing works locally only, currently.
yannicschroeer
force-pushed
the
v0.0.1a
branch
8 times, most recently
from
057951d to
81ba1e4
Compare
yannicschroeer
force-pushed
the
v0.0.1a
branch
from
81ba1e4 to
d5b2955
Compare
mkdocs.yaml
Outdated
| @@ -0,0 +1,81 @@ | |||
| site_name: FastAPI Keycloak Integration | |||
| site_url: https://docs.tebuto.com | |||
fastapi_keycloak/__init__.py
Outdated
| from fastapi_keycloak.api import FastAPIKeycloak | ||
| from fastapi_keycloak.model import OIDCUser, UsernamePassword, HTTPMethod | ||
|
|
||
| __all__ = [FastAPIKeycloak, OIDCUser, UsernamePassword, HTTPMethod] |
There was a problem hiding this comment.
__all__ has to contain stings (the names of the variables), so I would suggest to use the __name__ property of the classes
| name='fastapi-keycloak', | ||
| version='0.0.1a', | ||
| packages=get_packages(), | ||
| description='Keycloak integration for FastAPI', | ||
| long_description=read_description(), | ||
| long_description_content_type="text/markdown", | ||
| url='https://github.com/code-specialist/fastapi-keycloak', | ||
| install_requires=read_dependencies(), | ||
| python_requires='>=3.8', | ||
| classifiers=[ | ||
| "Programming Language :: Python :: 3", | ||
| "Operating System :: OS Independent", | ||
| ], | ||
| ) |
There was a problem hiding this comment.
When we publish this package on PyPI, we an and should add some more information, but we can do this later in another PR, just wanted to mention it
There was a problem hiding this comment.
What kind of information would you add?
|
Btw, let's have a discussion about die the naming / categorization of tests :D I think the naming here doesn't fit to the type of tests. For instance: functional tests are a kind of black box tests where you call a system or a (bigger) system component and expect a specific output. You don't care about what happens inside. The word "funcional" is realated to the specified functional requirements and not meant as a function in the source code. The current tests in the functional-tests folder are clearly unit tests in my opinion 😄 |
For me, a unit is a collection of functions, a class so to say, that fully sustains itself. A functional test tests functional behavior. I'm aware this is not common sense and that my personal interpretation of these two terms might irritate any logical thinking human being which is why I will rename them correspondingly |
…est coverage @ 90%
Done
TODO before merging
- [ ] 100% test coverage- [ ] Test infrastructure running on actions runner