{"id":16543185,"url":"https://github.com/s3rius/github_test","last_synced_at":"2026-05-11T00:45:56.535Z","repository":{"id":107290568,"uuid":"401150094","full_name":"s3rius/github_test","owner":"s3rius","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-15T21:47:15.000Z","size":858,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-02T14:42:47.165Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/s3rius.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-29T21:56:24.000Z","updated_at":"2024-12-15T21:47:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"3ad6e7e5-a656-4008-8b15-c9add9fb8907","html_url":"https://github.com/s3rius/github_test","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s3rius%2Fgithub_test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s3rius%2Fgithub_test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s3rius%2Fgithub_test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s3rius%2Fgithub_test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/s3rius","download_url":"https://codeload.github.com/s3rius/github_test/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241801257,"owners_count":20022390,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-11T18:59:34.930Z","updated_at":"2025-12-02T06:06:19.557Z","avatar_url":"https://github.com/s3rius.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hui\n\nThis project was generated using fastapi_template.\n\n## Poetry\n\nThis project uses poetry. It's a modern dependency management\ntool.\n\nTo run the project use this set of commands:\n\n```bash\npoetry install\npoetry run python -m hui\n```\n\nThis will start the server on the configured host.\n\nYou can find swagger documentation at `/api/docs`.\n\nYou can read more about poetry here: https://python-poetry.org/\n\n## Docker\n\nYou can start the project with docker using this command:\n\n```bash\ndocker-compose up --build\n```\n\nIf you want to develop in docker with autoreload and exposed ports add `-f deploy/docker-compose.dev.yml` to your docker command.\nLike this:\n\n```bash\ndocker-compose -f docker-compose.yml -f deploy/docker-compose.dev.yml --project-directory . up --build\n```\n\nThis command exposes the web application on port 8000, mounts current directory and enables autoreload.\n\nBut you have to rebuild image every time you modify `poetry.lock` or `pyproject.toml` with this command:\n\n```bash\ndocker-compose build\n```\n\n## Project structure\n\n```bash\n$ tree \"hui\"\nhui\n├── conftest.py  # Fixtures for all tests.\n├── db  # module contains db configurations\n│   ├── dao  # Data Access Objects. Contains different classes to interact with database.\n│   └── models  # Package contains different models for ORMs.\n├── __main__.py  # Startup script. Starts uvicorn.\n├── services  # Package for different external services such as rabbit or redis etc.\n├── settings.py  # Main configuration settings for project.\n├── static  # Static content.\n├── tests  # Tests for project.\n└── web  # Package contains web server. Handlers, startup config.\n    ├── api  # Package with all handlers.\n    │   └── router.py  # Main router.\n    ├── application.py  # FastAPI application configuration.\n    └── lifespan.py  # Contains actions to perform on startup and shutdown.\n```\n\n## Configuration\n\nThis application can be configured with environment variables.\n\nYou can create `.env` file in the root directory and place all\nenvironment variables here. \n\nAll environment variables should start with \"HUI_\" prefix.\n\nFor example if you see in your \"hui/settings.py\" a variable named like\n`random_parameter`, you should provide the \"HUI_RANDOM_PARAMETER\" \nvariable to configure the value. This behaviour can be changed by overriding `env_prefix` property\nin `hui.settings.Settings.Config`.\n\nAn example of .env file:\n```bash\nHUI_RELOAD=\"True\"\nHUI_PORT=\"8000\"\nHUI_ENVIRONMENT=\"dev\"\n```\n\nYou can read more about BaseSettings class here: https://pydantic-docs.helpmanual.io/usage/settings/\n\n## Pre-commit\n\nTo install pre-commit simply run inside the shell:\n```bash\npre-commit install\n```\n\npre-commit is very useful to check your code before publishing it.\nIt's configured using .pre-commit-config.yaml file.\n\nBy default it runs:\n* black (formats your code);\n* mypy (validates types);\n* isort (sorts imports in all files);\n* flake8 (spots possible bugs);\n\n\nYou can read more about pre-commit here: https://pre-commit.com/\n\n## Migrations\n\nIf you want to migrate your database, you should run following commands:\n```bash\n# To run all migrations until the migration with revision_id.\nalembic upgrade \"\u003crevision_id\u003e\"\n\n# To perform all pending migrations.\nalembic upgrade \"head\"\n```\n\n### Reverting migrations\n\nIf you want to revert migrations, you should run:\n```bash\n# revert all migrations up to: revision_id.\nalembic downgrade \u003crevision_id\u003e\n\n# Revert everything.\n alembic downgrade base\n```\n\n### Migration generation\n\nTo generate migrations you should run:\n```bash\n# For automatic change detection.\nalembic revision --autogenerate\n\n# For empty file generation.\nalembic revision\n```\n\n\n## Running tests\n\nIf you want to run it in docker, simply run:\n\n```bash\ndocker-compose run --build --rm api pytest -vv .\ndocker-compose down\n```\n\nFor running tests on your local machine.\n1. you need to start a database.\n\nI prefer doing it with docker:\n```\ndocker run -p \"5432:5432\" -e \"POSTGRES_PASSWORD=hui\" -e \"POSTGRES_USER=hui\" -e \"POSTGRES_DB=hui\" postgres:16.3-bullseye\n```\n\n\n2. Run the pytest.\n```bash\npytest -vv .\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs3rius%2Fgithub_test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fs3rius%2Fgithub_test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs3rius%2Fgithub_test/lists"}