{"id":20927272,"url":"https://github.com/fergusdixon/fastapi-example","last_synced_at":"2026-04-12T18:57:34.809Z","repository":{"id":52569900,"uuid":"361397583","full_name":"fergusdixon/fastapi-example","owner":"fergusdixon","description":"An example of FastAPI basics","archived":false,"fork":false,"pushed_at":"2023-02-11T02:40:21.000Z","size":75,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-22T16:41:27.984Z","etag":null,"topics":["fastapi","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fergusdixon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-04-25T10:28:47.000Z","updated_at":"2021-04-25T17:16:59.000Z","dependencies_parsed_at":"2024-11-19T06:03:25.106Z","dependency_job_id":null,"html_url":"https://github.com/fergusdixon/fastapi-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fergusdixon/fastapi-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fergusdixon%2Ffastapi-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fergusdixon%2Ffastapi-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fergusdixon%2Ffastapi-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fergusdixon%2Ffastapi-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fergusdixon","download_url":"https://codeload.github.com/fergusdixon/fastapi-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fergusdixon%2Ffastapi-example/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266732856,"owners_count":23976115,"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","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"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":["fastapi","python"],"created_at":"2024-11-18T20:47:12.563Z","updated_at":"2026-04-12T18:57:29.772Z","avatar_url":"https://github.com/fergusdixon.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fastapi-example\nAn example of FastAPI basics\n\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/0e332b810fbe47f8962f04e2c5e9fc54)](https://www.codacy.com/gh/fergusdixon/fastapi-example/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=fergusdixon/fastapi-example\u0026amp;utm_campaign=Badge_Grade)\n[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/0e332b810fbe47f8962f04e2c5e9fc54)](https://www.codacy.com/gh/fergusdixon/fastapi-example/dashboard?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=fergusdixon/fastapi-example\u0026utm_campaign=Badge_Coverage)\n\n## Getting set up\n\nCheck the Makefile for useful macros\n\nUsing [Poetry](https://python-poetry.org/) install dependencies\n\n```shell\npoetry install\npoetry shell\n```\n\nRun migrations\n\n```shell\nmake migrate\n```\n\n### Structure\n\n```\n-- .github      : Github Actions defintions\n-- alembic      : Database table definitions\n-- app\n---- api        : Endpoint defintions and routes\n---- core       : Configuration management\n---- crud       : Tools for performing CRUD ops on various models\n---- db         : Boilerplate sqlalchemy set up\n---- schemas    : Pydantic definitions for models and API requests/responses\n---- tests      : Unit and BDD tests\n```\n\n\n### Build the docker image\n\n```shell\nmake docker-build\n```\n\nStart the docker image\n```shell\nmake docker-run\n```\n\nThe API will be available at http://localhost (port 80)\nDocs are at http://localhost/docs\n\n### Tests\n\nRun unittests with coverage (in `app/tests`):\n\n```shell\nmake test-cov\n```\n\nOr with pytest-watch to rerun tests every time a change is made:\n\n```shell\nmake test-watch\n```\n\nRun Behave tests (in `app/tests/features`):\n\n```shell\nmake bdd\n```\n\n### Linting\n\nYou can check if your code is up to scratch:\n\n```shell\nmake lint\n```\n\nFix it automatically:\n\n```shell\nmake format-imports\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffergusdixon%2Ffastapi-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffergusdixon%2Ffastapi-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffergusdixon%2Ffastapi-example/lists"}