| Name | fastapi-launchpad JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A CLI tool to quickly scaffold FastAPI projects |
| upload_time | 2025-08-13 08:45:10 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License
Copyright (c) 2025 Talha Jamil
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
boilerplate
cli
fastapi
scaffold
starter
template
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# FastAPI Launchpad
A command-line tool to quickly scaffold FastAPI projects with best practices and common patterns.
## Features
- Quick project scaffolding with best practices
- Health check endpoint included by default
- Modern project structure following FastAPI recommendations
- Optional database setup: Postgres, MySQL, MongoDB
- Clear `.env` and `.env.example`
## Installation
```bash
pip install fastapi-launchpad
```
## Usage
- Create a new FastAPI project in a directory named `my_project`:
```bash
fastapi-launch project my-project
```
- Create with a specific database:
```bash
fastapi-launch project my-project --database postgres
# or --database mysql
# or --database mongodb
```
- Scaffold into the current directory:
```bash
mkdir my-project && cd my-project
fastapi-launch project .
```
- Show version:
```bash
fastapi-launch version
```
## Generated Project Structure
```
my_project/
├── src/
│ ├── dependencies/
│ ├── models/
│ ├── routers/
│ │ └── health.py
│ ├── schemas/
│ └── main.py
├── tests/
├── .env
├── .env.example
└── requirements.txt
```
## Running the generated app
```bash
python -m venv venv
# Windows
.\venv\Scripts\activate
# Unix/Mac
source venv/bin/activate
pip install -r requirements.txt
uvicorn src.main:app --reload
```
Then visit `http://127.0.0.1:8000/docs`.
## Development
```bash
python -m venv .venv
. .venv/Scripts/activate # Windows
# or
source .venv/bin/activate # Unix/Mac
pip install -e .[dev]
pytest -q
```
## License
MIT License
Raw data
{
"_id": null,
"home_page": null,
"name": "fastapi-launchpad",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "boilerplate, cli, fastapi, scaffold, starter, template",
"author": null,
"author_email": "Talha Jamil <t.jamil05@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d0/d4/714de6207697bd8966284c28bdf27ee5c28a5784e7e2919bc6636f73a610/fastapi_launchpad-0.1.0.tar.gz",
"platform": null,
"description": "# FastAPI Launchpad\n\nA command-line tool to quickly scaffold FastAPI projects with best practices and common patterns.\n\n## Features\n\n- Quick project scaffolding with best practices\n- Health check endpoint included by default\n- Modern project structure following FastAPI recommendations\n- Optional database setup: Postgres, MySQL, MongoDB\n- Clear `.env` and `.env.example`\n\n## Installation\n\n```bash\npip install fastapi-launchpad\n```\n\n## Usage\n\n- Create a new FastAPI project in a directory named `my_project`:\n\n```bash\nfastapi-launch project my-project\n```\n\n- Create with a specific database:\n\n```bash\nfastapi-launch project my-project --database postgres\n# or --database mysql\n# or --database mongodb\n```\n\n- Scaffold into the current directory:\n\n```bash\nmkdir my-project && cd my-project\nfastapi-launch project .\n```\n\n- Show version:\n\n```bash\nfastapi-launch version\n```\n\n## Generated Project Structure\n\n```\nmy_project/\n\u251c\u2500\u2500 src/\n\u2502 \u251c\u2500\u2500 dependencies/\n\u2502 \u251c\u2500\u2500 models/\n\u2502 \u251c\u2500\u2500 routers/\n\u2502 \u2502 \u2514\u2500\u2500 health.py\n\u2502 \u251c\u2500\u2500 schemas/\n\u2502 \u2514\u2500\u2500 main.py\n\u251c\u2500\u2500 tests/\n\u251c\u2500\u2500 .env\n\u251c\u2500\u2500 .env.example\n\u2514\u2500\u2500 requirements.txt\n```\n\n## Running the generated app\n\n```bash\npython -m venv venv\n# Windows\n.\\venv\\Scripts\\activate\n# Unix/Mac\nsource venv/bin/activate\n\npip install -r requirements.txt\nuvicorn src.main:app --reload\n```\n\nThen visit `http://127.0.0.1:8000/docs`.\n\n## Development\n\n```bash\npython -m venv .venv\n. .venv/Scripts/activate # Windows\n# or\nsource .venv/bin/activate # Unix/Mac\n\npip install -e .[dev]\npytest -q\n```\n\n## License\n\nMIT License",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Talha Jamil\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "A CLI tool to quickly scaffold FastAPI projects",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://github.com/talhajamil05/fastapi-launchpad#readme",
"Homepage": "https://github.com/talhajamil05/fastapi-launchpad",
"Issues": "https://github.com/talhajamil05/fastapi-launchpad/issues",
"Source": "https://github.com/talhajamil05/fastapi-launchpad"
},
"split_keywords": [
"boilerplate",
" cli",
" fastapi",
" scaffold",
" starter",
" template"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "54339f464fcb66cc46f0f10c33de5c0535a64fe38d5cc18b4ab085b59b27f3b4",
"md5": "c00139b75bc30280a42a3b216e33005a",
"sha256": "f3e05a5fbde61f3fc5044b831bc8363751140305f2b5c0ed2cfa0772d7712a97"
},
"downloads": -1,
"filename": "fastapi_launchpad-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c00139b75bc30280a42a3b216e33005a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8098,
"upload_time": "2025-08-13T08:45:08",
"upload_time_iso_8601": "2025-08-13T08:45:08.578997Z",
"url": "https://files.pythonhosted.org/packages/54/33/9f464fcb66cc46f0f10c33de5c0535a64fe38d5cc18b4ab085b59b27f3b4/fastapi_launchpad-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d0d4714de6207697bd8966284c28bdf27ee5c28a5784e7e2919bc6636f73a610",
"md5": "338d774b05abbba716f7d6e76126cab4",
"sha256": "5806b3ce64b5f43717fff0803b83707647e9246a6f2bb3930c95c12365aba249"
},
"downloads": -1,
"filename": "fastapi_launchpad-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "338d774b05abbba716f7d6e76126cab4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7420,
"upload_time": "2025-08-13T08:45:10",
"upload_time_iso_8601": "2025-08-13T08:45:10.119896Z",
"url": "https://files.pythonhosted.org/packages/d0/d4/714de6207697bd8966284c28bdf27ee5c28a5784e7e2919bc6636f73a610/fastapi_launchpad-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-13 08:45:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "talhajamil05",
"github_project": "fastapi-launchpad#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "fastapi-launchpad"
}
