{"id":27629365,"url":"https://github.com/pashpiter/tron_service","last_synced_at":"2025-06-30T10:35:55.909Z","repository":{"id":289283087,"uuid":"970731853","full_name":"pashpiter/tron_service","owner":"pashpiter","description":"Микросервис, который выводит информацию по адресу в сети трон, его bandwidth, energy, и баланс trx.","archived":false,"fork":false,"pushed_at":"2025-04-22T14:19:18.000Z","size":70,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-23T15:16:42.028Z","etag":null,"topics":["asyncpg","fastapi","postgresql","pytest","python","sqlalchemy","tronpy","uvicorn"],"latest_commit_sha":null,"homepage":"","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/pashpiter.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,"zenodo":null}},"created_at":"2025-04-22T13:02:39.000Z","updated_at":"2025-04-22T14:19:21.000Z","dependencies_parsed_at":"2025-04-22T14:36:46.332Z","dependency_job_id":null,"html_url":"https://github.com/pashpiter/tron_service","commit_stats":null,"previous_names":["pashpiter/tron_service"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pashpiter/tron_service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashpiter%2Ftron_service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashpiter%2Ftron_service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashpiter%2Ftron_service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashpiter%2Ftron_service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pashpiter","download_url":"https://codeload.github.com/pashpiter/tron_service/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashpiter%2Ftron_service/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262756738,"owners_count":23359569,"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":["asyncpg","fastapi","postgresql","pytest","python","sqlalchemy","tronpy","uvicorn"],"created_at":"2025-04-23T15:16:40.059Z","updated_at":"2025-06-30T10:35:55.878Z","avatar_url":"https://github.com/pashpiter.png","language":"Python","readme":"# tron_service\n\n#### Стек: Python, FastAPI, uvicorn, sqlalchemy, tronpy, postgresql, asyncpg, pytest\n\n## О проекте\nМикросервис, который выводит информацию по адресу в сети трон, его bandwidth, energy, и баланс trx. \n\n\n## Запуск проекта\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003e🐳 Запуск через Docker (рекомендуется)\u003c/b\u003e\u003c/summary\u003e\n\n\n1. Установите Docker согласно инструкции с официального сайта: https://docs.docker.com/\n2. Клонировать репозиторий\n```\ngit clone git@github.com:pashpiter/tron_service.git\n```\n3. Перейти в папку tron_service\n```\ncd tron_service\n```\n4. В папке создайте файл `.env` с переменных окружения\n```\ntouch .env\n```\n5. Заполните по примеру своими значениями как в этом [файле](example.env)\n6. Для запуска проекта введите команду:\n```\ndocker compose up -d\n```\nили если локально установлен Make:\n```\nmake up\n```\n\u003e **Тесты.** Проект покрыт тестами, которые выполняются при сборке контейнеров.\n\n\u003c/details\u003e\u003cdetails\u003e \u003csummary\u003e\u003cb\u003e💻 Локальный запуск (без Docker)\u003c/b\u003e\u003c/summary\u003e\n\n1. Клонировать репозиторий\n```\ngit clone git@github.com:pashpiter/tron_service.git\n```\n2. Перейти в папку tron_service\n```\ncd tron_service\n```\n3. В папке создайте файл `.env` с переменных окружения\n```\ntouch .env\n```\n4. Заполните по примеру своими значениями как в этом [файле](example.env)\n5. Создать и активировать вирутальное окружение\n```\npython3 -m venv venv\nacivate .venv/bin/activate\n```\n6. Установить зависимости\n```\npip install -r requirements.txt\n```\n7. Запустить приложение\n```\nuvicorn app.main:app --reload\n```\n\u003e **Тесты.** Для запуска тестов используйте команду `pytest -v`.\n\u003c/details\u003e\n\n## Документация\nПосле запуска документация доступна по адресу:\n```\n{FASAPI_HOST}:{FASAPI_PORT}/docs\n{FASAPI_HOST}:{FASAPI_PORT}/redoc\n```\n\n## Энодпоинты API\n### 1. Получение информации о кошельке TRON\n`POST /`\n\n**Описание**:  \nВозвращает баланс TRX, bandwidth, energy и другую информацию по указанному адресу в сети TRON.\n\n**Параметры запроса** (JSON):\n```\n{\n  \"address\": \"TQjaZ9FD473QBTdUzMLmSyoGB6Yz1CGpux\"\n}\n```\nПример успешного ответа:\n```\n{\n  \"address\": \"TQjaZ9FD473QBTdUzMLmSyoGB6Yz1CGpux\",\n  \"trx_balance\": 89898.03202,\n  \"bandwidth\": 600,\n  \"energy\": 0\n}\n```\n### 2. Получение истории запросов\n`GET /`\n\n**Описание**: \nВозвращает историю запросов с пагинацией.\nПараметры запроса (query params):\n```\noffset - Количество пропускаемых элементов (default: 0)\nlimit - Количество элементов на странице (default: 10)\n```\nПример успешного ответа:\n```\n{\n  \"items\": [\n    {\n      \"address\": \"TQjaZ9FD473QBTdUzMLmSyoGB6Yz1CGpux\",\n      \"trx_balance\": 1250.5,\n      \"bandwidth\": 4900,\n      \"energy\": 950,\n      \"id\": 1,\n      \"timestamp\": \"2025-04-22T11:26:50.621134Z\"\n    }\n  ]\n}\n```\n#### Pavel Drovnin [@pashpiter](http://t.me/pashpiter)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpashpiter%2Ftron_service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpashpiter%2Ftron_service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpashpiter%2Ftron_service/lists"}