https://github.com/dev-connor/reverse1999-damage-calculator
https://github.com/dev-connor/reverse1999-damage-calculator
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dev-connor/reverse1999-damage-calculator
- Owner: dev-connor
- Created: 2023-12-26T13:40:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-30T04:26:33.000Z (over 1 year ago)
- Last Synced: 2025-01-11T07:43:57.107Z (5 months ago)
- Language: HTML
- Size: 645 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# reverse1999_damage_calculator
This project was generated using fastapi_template.
## Poetry
This project uses poetry. It's a modern dependency management
tool.
To run the project use this set of commands:
```bash
poetry install
poetry run python -m reverse1999_damage_calculator
```
This will start the server on the configured host.
You can find swagger documentation at `/api/docs`.
You can read more about poetry here: https://python-poetry.org/
## Docker
You can start the project with docker using this command:
```bash
docker-compose -f deploy/docker-compose.yml --project-directory . up --build
```
If you want to develop in docker with autoreload add `-f deploy/docker-compose.dev.yml` to your docker command.
Like this:
```bash
docker-compose -f deploy/docker-compose.yml -f deploy/docker-compose.dev.yml --project-directory . up --build
```
This command exposes the web application on port 8000, mounts current directory and enables autoreload.
But you have to rebuild image every time you modify `poetry.lock` or `pyproject.toml` with this command:
```bash
docker-compose -f deploy/docker-compose.yml --project-directory . build
```
## Project structure
```bash
$ tree "reverse1999_damage_calculator"
reverse1999_damage_calculator
├── conftest.py # Fixtures for all tests.
├── __main__.py # Startup script. Starts uvicorn.
├── services # Package for different external services such as rabbit or redis etc.
├── settings.py # Main configuration settings for project.
├── templates # Static content.
├── tests # Tests for project.
└── web # Package contains web server. Handlers, startup config.
├── api # Package with all handlers.
│ └── router.py # Main router.
├── application.py # FastAPI application configuration.
└── lifetime.py # Contains actions to perform on startup and shutdown.
```
## Configuration
This application can be configured with environment variables.
You can create `.env` file in the root directory and place all
environment variables here.
All environment variables should start with "REVERSE1999_DAMAGE_CALCULATOR_" prefix.
For example if you see in your "reverse1999_damage_calculator/settings.py" a variable named like
`random_parameter`, you should provide the "REVERSE1999_DAMAGE_CALCULATOR_RANDOM_PARAMETER"
variable to configure the value. This behaviour can be changed by overriding `env_prefix` property
in `reverse1999_damage_calculator.settings.Settings.Config`.
An example of .env file:
```bash
REVERSE1999_DAMAGE_CALCULATOR_RELOAD="True"
REVERSE1999_DAMAGE_CALCULATOR_PORT="8000"
REVERSE1999_DAMAGE_CALCULATOR_ENVIRONMENT="dev"
```
You can read more about BaseSettings class here: https://pydantic-docs.helpmanual.io/usage/settings/
## Pre-commit
To install pre-commit simply run inside the shell:
```bash
pre-commit install
```
pre-commit is very useful to check your code before publishing it.
It's configured using .pre-commit-config.yaml file.
By default it runs:
* black (formats your code);
* mypy (validates types);
* isort (sorts imports in all files);
* flake8 (spots possible bugs);
You can read more about pre-commit here: https://pre-commit.com/
## Running tests
If you want to run it in docker, simply run:
```bash
docker-compose -f deploy/docker-compose.yml -f deploy/docker-compose.dev.yml --project-directory . run --build --rm api pytest -vv .
docker-compose -f deploy/docker-compose.yml -f deploy/docker-compose.dev.yml --project-directory . down
```
For running tests on your local machine.
2. Run the pytest.
```bash
pytest -vv .
```