{"id":27603534,"url":"https://github.com/taskiq-python/taskiq-collector","last_synced_at":"2025-04-22T19:17:22.064Z","repository":{"id":142762314,"uuid":"524213731","full_name":"taskiq-python/taskiq-collector","owner":"taskiq-python","description":"Taskiq runtime info collector","archived":false,"fork":false,"pushed_at":"2022-08-17T08:41:57.000Z","size":990,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-10T04:08:50.807Z","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/taskiq-python.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}},"created_at":"2022-08-12T20:16:48.000Z","updated_at":"2023-05-07T08:19:09.000Z","dependencies_parsed_at":"2023-03-18T16:38:29.454Z","dependency_job_id":null,"html_url":"https://github.com/taskiq-python/taskiq-collector","commit_stats":{"total_commits":3,"total_committers":1,"mean_commits":3.0,"dds":0.0,"last_synced_commit":"37c3e3695f8ae895c205d32672b06899dc05cb3b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskiq-python%2Ftaskiq-collector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskiq-python%2Ftaskiq-collector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskiq-python%2Ftaskiq-collector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskiq-python%2Ftaskiq-collector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taskiq-python","download_url":"https://codeload.github.com/taskiq-python/taskiq-collector/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249981844,"owners_count":21355579,"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":"2025-04-22T19:17:21.489Z","updated_at":"2025-04-22T19:17:22.056Z","avatar_url":"https://github.com/taskiq-python.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# taskiq_collector\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 taskiq_collector\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 -f deploy/docker-compose.yml --project-directory . up --build\n```\n\nIf you want to develop in docker with autoreload add `-f deploy/docker-compose.dev.yml` to your docker command.\nLike this:\n\n```bash\ndocker-compose -f deploy/docker-compose.yml -f deploy/docker-compose.dev.yml --project-directory . up\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 -f deploy/docker-compose.yml --project-directory . build\n```\n\n## Project structure\n\n```bash\n$ tree \"taskiq_collector\"\ntaskiq_collector\n├── conftest.py  # Fixtures for all tests.\n├── db  # module contains db configurations\n│   ├── dao  # Data Access Objects. Contains different classes to inteact 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    └── lifetime.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 variabels should start with \"TASKIQ_COLLECTOR_\" prefix.\n\nFor example if you see in your \"taskiq_collector/settings.py\" a variable named like\n`random_parameter`, you should provide the \"TASKIQ_COLLECTOR_RANDOM_PARAMETER\"\nvariable to configure the value. This behaviour can be changed by overriding `env_prefix` property\nin `taskiq_collector.settings.Settings.Config`.\n\nAn exmaple of .env file:\n```bash\nTASKIQ_COLLECTOR_RELOAD=\"True\"\nTASKIQ_COLLECTOR_PORT=\"8000\"\nTASKIQ_COLLECTOR_ENVIRONMENT=\"dev\"\n```\n\nYou can read more about BaseSettings class here: https://pydantic-docs.helpmanual.io/usage/settings/\n## Opentelemetry\n\nIf you want to start your project with opentelemetry collector\nyou can add `-f ./deploy/docker-compose.otlp.yml` to your docker command.\n\nLike this:\n\n```bash\ndocker-compose -f deploy/docker-compose.yml -f deploy/docker-compose.otlp.yml --project-directory . up\n```\n\nThis command will start opentelemetry collector and jaeger.\nAfter sending a requests you can see traces in jaeger's UI\nat http://localhost:16686/.\n\nThis docker configuration is not supposed to be used in production.\nIt's only for demo purpose.\n\nYou can read more about opentelemetry here: https://opentelemetry.io/\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 possibe bugs);\n* yesqa (removes useless `# noqa` comments).\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 untill 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 -f deploy/docker-compose.yml --project-directory . run --rm api pytest -vv .\ndocker-compose -f deploy/docker-compose.yml --project-directory . 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=taskiq_collector\" -e \"POSTGRES_USER=taskiq_collector\" -e \"POSTGRES_DB=taskiq_collector\" postgres:13.6-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%2Ftaskiq-python%2Ftaskiq-collector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaskiq-python%2Ftaskiq-collector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaskiq-python%2Ftaskiq-collector/lists"}