{"id":26167410,"url":"https://github.com/devroopsaha744/fastapi-scaffold","last_synced_at":"2025-12-25T05:10:41.074Z","repository":{"id":281837573,"uuid":"946587022","full_name":"devroopsaha744/fastapi-scaffold","owner":"devroopsaha744","description":"FastAPI Scaffold is a CLI tool to quickly generate FastAPI project structures with optional features like authentication, database integration, machine learning model setup, and Docker support.","archived":false,"fork":false,"pushed_at":"2025-03-12T07:24:37.000Z","size":54,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-27T12:09:37.518Z","etag":null,"topics":["auth","backend-development","cli","db","docker","docker-compose","fastapi","project-management","python"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/fastapi-scaffold/","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/devroopsaha744.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":"2025-03-11T11:23:08.000Z","updated_at":"2025-10-18T14:18:18.000Z","dependencies_parsed_at":"2025-03-11T12:39:59.665Z","dependency_job_id":null,"html_url":"https://github.com/devroopsaha744/fastapi-scaffold","commit_stats":null,"previous_names":["devroopsaha744/fastapi-scaffold"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/devroopsaha744/fastapi-scaffold","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devroopsaha744%2Ffastapi-scaffold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devroopsaha744%2Ffastapi-scaffold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devroopsaha744%2Ffastapi-scaffold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devroopsaha744%2Ffastapi-scaffold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devroopsaha744","download_url":"https://codeload.github.com/devroopsaha744/fastapi-scaffold/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devroopsaha744%2Ffastapi-scaffold/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28020071,"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-12-25T02:00:05.988Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","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":["auth","backend-development","cli","db","docker","docker-compose","fastapi","project-management","python"],"created_at":"2025-03-11T17:35:55.874Z","updated_at":"2025-12-25T05:10:41.069Z","avatar_url":"https://github.com/devroopsaha744.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fastapi-scaffold\r\n\r\n[![PyPI Version](https://img.shields.io/pypi/v/fastapi-scaffold.svg)](https://pypi.org/project/fastapi-scaffold/)\r\n[![Python Version](https://img.shields.io/badge/python-%3E=3.7-blue)](https://www.python.org/)\r\n[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)\r\n\r\nfastapi-scaffold is a CLI tool that generates a scalable FastAPI project template with advanced features including authentication, machine learning endpoints, background tasks, caching, rate limiting, and more.\r\n\r\n## Installation\r\n\r\nInstall the CLI tool via pip:\r\n\r\n```sh\r\npip install fastapi-scaffold\r\n```\r\n\r\n## Usage\r\n\r\n### Create a New FastAPI Project\r\n\r\nTo create a new project, run:\r\n\r\n```sh\r\nfastapi-scaffold create my_project\r\n```\r\n\r\nThis command generates a new project with optional features:\r\n\r\n- `--ml` → Includes machine learning endpoints and model setup.\r\n- `--db` → Adds database configuration and ORM setup.\r\n- `--auth` → Includes authentication endpoints.\r\n- `--docker` → Generates Dockerfile and docker-compose.yml for container support.\r\n\r\nExample:\r\n\r\n```sh\r\nfastapi-scaffold create my_project --ml --db --auth --docker\r\n```\r\n\r\n### Install Project Dependencies\r\n\r\nAfter generating your project, navigate into the project directory and install dependencies:\r\n\r\n```sh\r\nfastapi-scaffold install\r\n```\r\n\r\nAlternatively, run:\r\n\r\n```sh\r\npip install -r requirements.txt\r\n```\r\n\r\n### Delete an Existing Project\r\n\r\nTo delete a project directory, use:\r\n\r\n```sh\r\nfastapi-scaffold delete my_project\r\n```\r\n\r\n## Project Structure\r\n\r\nA generated project will have the following structure:\r\n\r\n```\r\nmy_project/\r\n├── app/\r\n│   ├── api/\r\n│   │   ├── __init__.py\r\n│   │   ├── users.py\r\n│   │   ├── items.py\r\n│   │   ├── admin.py\r\n│   │   ├── ml.py\r\n│   │   └── health.py\r\n│   ├── schemas/\r\n│   │   ├── __init__.py\r\n│   │   ├── user.py\r\n│   │   ├── item.py\r\n│   │   ├── ml.py\r\n│   │   └── stats.py\r\n│   ├── models/\r\n│   │   ├── __init__.py\r\n│   │   ├── user.py\r\n│   │   ├── item.py\r\n│   │   └── ml_model.pkl\r\n│   ├── crud/\r\n│   │   ├── __init__.py\r\n│   │   ├── user.py\r\n│   │   ├── item.py\r\n│   │   └── stats.py\r\n│   ├── services/\r\n│   │   ├── __init__.py\r\n│   │   ├── auth.py\r\n│   │   ├── tasks.py\r\n│   │   └── ml.py\r\n│   ├── utils/\r\n│   │   ├── __init__.py\r\n│   │   ├── dependencies.py\r\n│   │   ├── cache.py\r\n│   │   └── rate_limit.py\r\n│   ├── middleware.py\r\n│   ├── database.py\r\n│   ├── auth.py\r\n│   ├── logger.py\r\n│   ├── config.py\r\n│   └── main.py\r\n├── tests/\r\n│   ├── test_main.py\r\n│   └── test_users.py\r\n├── .env\r\n├── requirements.txt\r\n├── Dockerfile\r\n├── docker-compose.yml\r\n└── README.md\r\n```\r\n\r\n## Running the Project\r\n\r\n1. Navigate to the project directory:\r\n    ```sh\r\n    cd my_project\r\n    ```\r\n2. Install dependencies:\r\n    ```sh\r\n    pip install -r requirements.txt\r\n    ```\r\n3. Start the FastAPI server:\r\n    ```sh\r\n    uvicorn app.main:app --reload\r\n    ```\r\n\r\nThe API will be available at [http://127.0.0.1:8000](http://127.0.0.1:8000).\r\n\r\n## Contributing\r\n\r\nContributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevroopsaha744%2Ffastapi-scaffold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevroopsaha744%2Ffastapi-scaffold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevroopsaha744%2Ffastapi-scaffold/lists"}