Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rochacbruno/fastapi-workshop-template
⬅️ Click on Use This Template - Template para o workshop de FastAPI da Codecon 2021
https://github.com/rochacbruno/fastapi-workshop-template
codecon rochacbruno-template
Last synced: 2 days ago
JSON representation
⬅️ Click on Use This Template - Template para o workshop de FastAPI da Codecon 2021
- Host: GitHub
- URL: https://github.com/rochacbruno/fastapi-workshop-template
- Owner: rochacbruno
- License: unlicense
- Created: 2021-09-21T14:49:13.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-09-24T19:18:20.000Z (about 3 years ago)
- Last Synced: 2024-05-02T04:51:00.146Z (5 months ago)
- Topics: codecon, rochacbruno-template
- Language: Python
- Homepage:
- Size: 85.9 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# project_name
[](https://codecov.io/gh/author_name/project_urlname)
[](https://github.com/author_name/project_urlname/actions/workflows/main.yml)
project_description
## Install
### Running on gitpod
[](https://gitpod.io/#https://github.com/author_name/project_urlname)
### from source
```bash
git clone https://github.com/author_name/project_urlname project_name
cd project_name
make install
```
## Executing
```bash
$ project_name run --port 8080
```
or
```bash
python -m project_name run --port 8080
```
or
```bash
$ uvicorn project_name:app
```
## CLI
```bash
❯ project_name --help
Usage: project_name [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion [bash|zsh|fish|powershell|pwsh]
Install completion for the specified shell.
--show-completion [bash|zsh|fish|powershell|pwsh]
Show completion for the specified shell, to
copy it or customize the installation.
--help Show this message and exit.
Commands:
create-user Create user
run Run the API server.
shell Opens an interactive shell with objects auto imported
```
### Creating a user
```bash
❯ project_name create-user --help
Usage: project_name create-user [OPTIONS] USERNAME PASSWORD
Create user
Arguments:
USERNAME [required]
PASSWORD [required]
Options:
--superuser / --no-superuser [default: no-superuser]
--help
```
**IMPORTANT** To create an admin user on the first run:
```bash
project_name create-user admin admin --superuser
```
### The Shell
You can enter an interactive shell with all the objects imported.
```bash
❯ project_name shell
Auto imports: ['app', 'settings', 'User', 'engine', 'cli', 'create_user', 'select', 'session', 'Content']
In [1]: session.query(Content).all()
Out[1]: [Content(text='string', title='string', created_time='2021-09-14T19:25:00.050441', user_id=1, slug='string', id=1, published=False, tags='string')]
In [2]: user = session.get(User, 1)
In [3]: user.contents
Out[3]: [Content(text='string', title='string', created_time='2021-09-14T19:25:00.050441', user_id=1, slug='string', id=1, published=False, tags='string')]
```
## API
Run with `project_name run` and access http://127.0.0.1:8000/docs
**For some api calls you must authenticate** using the user created with `project_name create-user`.
## Testing
``` bash
❯ make test
Black All done! ✨ 🍰 ✨
13 files would be left unchanged.
Isort All done! ✨ 🍰 ✨
6 files would be left unchanged.
Success: no issues found in 13 source files
================================ test session starts ===========================
platform linux -- Python 3.9.6, pytest-6.2.5, py-1.10.0, pluggy-1.0.0 --
/fastapi-project-template/.venv/bin/python3
cachedir: .pytest_cache
rootdir: /fastapi-project-template
plugins: cov-2.12.1
collected 10 items
tests/test_app.py::test_using_testing_db PASSED [ 10%]
tests/test_app.py::test_index PASSED [ 20%]
tests/test_cli.py::test_help PASSED [ 30%]
tests/test_cli.py::test_cmds_help[run-args0---port] PASSED [ 40%]
tests/test_cli.py::test_cmds_help[create-user-args1-create-user] PASSED [ 50%]
tests/test_cli.py::test_cmds[create-user-args0-created admin2 user] PASSED[ 60%]
tests/test_content_api.py::test_content_create PASSED [ 70%]
tests/test_content_api.py::test_content_list PASSED [ 80%]
tests/test_user_api.py::test_user_list PASSED [ 90%]
tests/test_user_api.py::test_user_create PASSED [100%]
----------- coverage: platform linux, python 3.9.6-final-0 -----------
Name Stmts Miss Cover
-----------------------------------------------------
project_name/__init__.py 4 0 100%
project_name/app.py 16 1 94%
project_name/cli.py 21 0 100%
project_name/config.py 5 0 100%
project_name/db.py 10 0 100%
project_name/models/__init__.py 0 0 100%
project_name/models/content.py 47 1 98%
project_name/routes/__init__.py 11 0 100%
project_name/routes/content.py 52 25 52%
project_name/routes/security.py 15 1 93%
project_name/routes/user.py 52 26 50%
project_name/security.py 103 12 88%
-----------------------------------------------------
TOTAL 336 66 80%
========================== 10 passed in 2.34s ==================================
```
## Linting and Formatting
```bash
make lint # checks for linting errors
make fmt # formats the code
```
## Configuration
This project uses [Dynaconf](https://dynaconf.com) to manage configuration.
```py
from project_name.config import settings
```
## Acessing variables
```py
settings.get("SECRET_KEY", default="sdnfjbnfsdf")
settings["SECRET_KEY"]
settings.SECRET_KEY
settings.db.uri
settings["db"]["uri"]
settings["db.uri"]
settings.DB__uri
```
## Defining variables
### On files
settings.toml
```toml
[development]
dynaconf_merge = true
[development.db]
echo = true
```
> `dynaconf_merge` is a boolean that tells if the settings should be merged with the default settings defined in project_name/default.toml.
### As environment variables
```bash
export PROJECT_NAME_KEY=value
export PROJECT_NAME_KEY="@int 42"
export PROJECT_NAME_KEY="@jinja {{ this.db.uri }}"
export PROJECT_NAME_DB__uri="@jinja {{ this.db.uri | replace('db', 'data') }}"
```
### Secrets
There is a file `.secrets.toml` where your sensitive variables are stored,
that file must be ignored by git. (add that to .gitignore)
Or store your secrets in environment variables or a vault service, Dynaconf
can read those variables.
### Switching environments
```bash
PROJECT_NAME_ENV=production project_name run
```
Read more on https://dynaconf.com
## Development
Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.