You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
27 lines
713 B
Markdown
27 lines
713 B
Markdown
# learn_litestar
|
|
|
|
Learning Litestar API framework
|
|
|
|
## First time setup
|
|
|
|
Create a virtual environment and activate it. Now from the root project directory run `./scripts/bootstrap`. This will install `pip-tools` and sync any dependencies for the first time.
|
|
|
|
## Dependency management
|
|
|
|
Dependencies are managed via [pip-tools].
|
|
|
|
### Adding a dependency
|
|
|
|
To add a dependency, edit `requirements.in` (or `dev-requirements.in`
|
|
for dev dependencies) and add your dependency then run `pip-compile
|
|
requirements.in`.
|
|
|
|
### Syncing dependencies
|
|
|
|
Run `pip-sync requirements.txt dev_requirements.txt`.
|
|
|
|
## Testing
|
|
|
|
Run the tests by invoking `py.test` in the project root. Make sure you
|
|
run any pending migrations beforehand.
|