https://github.com/s3rius/github_test
https://github.com/s3rius/github_test
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/s3rius/github_test
- Owner: s3rius
- Created: 2021-08-29T21:56:24.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-15T21:47:15.000Z (over 1 year ago)
- Last Synced: 2025-03-02T14:42:47.165Z (over 1 year ago)
- Language: Python
- Size: 838 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# hui
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 hui
```
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 up --build
```
If you want to develop in docker with autoreload and exposed ports add `-f deploy/docker-compose.dev.yml` to your docker command.
Like this:
```bash
docker-compose -f 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 build
```
## Project structure
```bash
$ tree "hui"
hui
├── conftest.py # Fixtures for all tests.
├── db # module contains db configurations
│ ├── dao # Data Access Objects. Contains different classes to interact with database.
│ └── models # Package contains different models for ORMs.
├── __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.
├── static # 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.
└── lifespan.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 "HUI_" prefix.
For example if you see in your "hui/settings.py" a variable named like
`random_parameter`, you should provide the "HUI_RANDOM_PARAMETER"
variable to configure the value. This behaviour can be changed by overriding `env_prefix` property
in `hui.settings.Settings.Config`.
An example of .env file:
```bash
HUI_RELOAD="True"
HUI_PORT="8000"
HUI_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/
## Migrations
If you want to migrate your database, you should run following commands:
```bash
# To run all migrations until the migration with revision_id.
alembic upgrade ""
# To perform all pending migrations.
alembic upgrade "head"
```
### Reverting migrations
If you want to revert migrations, you should run:
```bash
# revert all migrations up to: revision_id.
alembic downgrade
# Revert everything.
alembic downgrade base
```
### Migration generation
To generate migrations you should run:
```bash
# For automatic change detection.
alembic revision --autogenerate
# For empty file generation.
alembic revision
```
## Running tests
If you want to run it in docker, simply run:
```bash
docker-compose run --build --rm api pytest -vv .
docker-compose down
```
For running tests on your local machine.
1. you need to start a database.
I prefer doing it with docker:
```
docker run -p "5432:5432" -e "POSTGRES_PASSWORD=hui" -e "POSTGRES_USER=hui" -e "POSTGRES_DB=hui" postgres:16.3-bullseye
```
2. Run the pytest.
```bash
pytest -vv .
```