{"id":19059533,"url":"https://github.com/vaibhavpandeyvpz/starter-python","last_synced_at":"2026-01-25T15:03:28.006Z","repository":{"id":241583950,"uuid":"805200881","full_name":"vaibhavpandeyvpz/starter-python","owner":"vaibhavpandeyvpz","description":"Starter template for kick-starting Python API projects.","archived":false,"fork":false,"pushed_at":"2024-06-24T06:17:22.000Z","size":83,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-15T13:09:44.471Z","etag":null,"topics":["boilerplace","bootstrap","fastapi","poetry","python","sqlalchemy","starter-project","starter-template"],"latest_commit_sha":null,"homepage":"https://vaibhavpandey.com/","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/vaibhavpandeyvpz.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":"2024-05-24T04:59:07.000Z","updated_at":"2024-06-24T06:17:26.000Z","dependencies_parsed_at":"2024-05-29T06:08:46.837Z","dependency_job_id":"a803715b-faf5-4cbd-aa03-9fc3133b544d","html_url":"https://github.com/vaibhavpandeyvpz/starter-python","commit_stats":null,"previous_names":["vaibhavpandeyvpz/starter-python"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/vaibhavpandeyvpz/starter-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavpandeyvpz%2Fstarter-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavpandeyvpz%2Fstarter-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavpandeyvpz%2Fstarter-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavpandeyvpz%2Fstarter-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vaibhavpandeyvpz","download_url":"https://codeload.github.com/vaibhavpandeyvpz/starter-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaibhavpandeyvpz%2Fstarter-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28754807,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T13:59:49.818Z","status":"ssl_error","status_checked_at":"2026-01-25T13:59:33.728Z","response_time":113,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["boilerplace","bootstrap","fastapi","poetry","python","sqlalchemy","starter-project","starter-template"],"created_at":"2024-11-09T00:10:27.714Z","updated_at":"2026-01-25T15:03:27.989Z","avatar_url":"https://github.com/vaibhavpandeyvpz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# starter-python\n\nStarter template for kick-starting [Python](https://www.python.org/) API projects.\n\n## Prepare\n\nBefore running the project, go to [ngrok](https://ngrok.com/) and create a free account.\nOnce logged in, make note of the auth token.\n\n## Usage\n\nRun below commands in project folder:\n\n```shell\n# create ngrok config\ncp ngrok.dist.yml ngrok.yml\n\n# update values in ngrok.yml file e.g., your_authtoken_here and domain (optional)\n\n# create app config\ncp config.dist.ini config.ini\n\n# start the services\ndocker compose up -d\n```\n\nServer should be up \u0026 running on [127.0.0.1:8000](http://127.0.0.1:8000/).\n\nIf you are using [MySQL](https://www.mysql.com) database (powered by [SQLAlchemy](https://www.sqlalchemy.org)), run migrations using below commands:\n\n```shell\n# spawn a shell\ndocker compose exec cron sh -c \"poetry shell\"\n\n# run all migrations\nalembic upgrade head\n```\n\n## Development\n\nThis project includes a cron job scheduled to run `poe welcome` command (see `app/cli.py`) every hour.\nYou can also use below command to run it on demand (or any added command) anytime.\n\n```shell\n# spawn a shell\ndocker compose exec cron sh -c \"poetry shell\"\n\n# run \"welcome\" command\npoe welcome\n```\n\nYou can test the API by calling `/` endpoint as below:\n\n```shell\ncurl -X GET \\\n  -H \"accept: application/json\" \\\n  http://127.0.0.1:8000/\n```\n\nTo get [ngrok](https://ngrok.com/) public URL from container, use below command (requires [jq](https://jqlang.github.io/jq/)):\n\n```shell\ncurl --silent -X GET http://localhost:4040/api/tunnels | jq -r '.tunnels[0].public_url'\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaibhavpandeyvpz%2Fstarter-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvaibhavpandeyvpz%2Fstarter-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaibhavpandeyvpz%2Fstarter-python/lists"}