# FastAPI EasyStart
FastAPI EasyStart is a streamlined library designed to help developers quickly set up and configure a FastAPI project with essential components. It simplifies the process of creating APIs by providing ready-to-use templates and configurations for common tasks such as authentication, database integration, and CORS settings.
## Features
- 🚀 Quick Start Templates: Get started with FastAPI in seconds using predefined project structures and configurations.
- 🔧 Environment Management: Easily manage environment variables and settings.
- 🌍 CORS Configuration: Simplify CORS setup with built-in configurations.
- 📦 Modular Components: Use only what you need with modular and customizable components.
- 💡 Custom Exception Classes: Enhance error handling with predefined, customizable exception classes tailored for FastAPI.
- 🔐 Authentication: Easily integrate JWT-based authentication. (Coming Soon)
- 💾 Database Support: Seamless integration with popular databases like SQLite, PostgreSQL, and MongoDB. (Coming Soon)
## Installation
You can install the fastapi-easystart package using either pip or pipenv:
```bash
pip install fastapi-easystart
```
## Quickstart
### 1. Initialize a New FastAPI Project
Begin by creating a new FastAPI project with the default settings and configurations. Run the following command:
```bash
python -m fastapi_easystart.main init
```
This command will generate the basic project structure, including directories and initial files, based on the easy start template.
### 2. Configure the main.py File
After initializing your project, configure the main.py file to set up the FastAPI application. If you want to either override or merge the existing main.py file with a new configuration, use the following command:
```bash
python -m fastapi_easystart.main config-main
```
### 3. Running the Development Server
Once the project is set up, you can start the development server:
```bash
uvicorn main:app --reload
```
Alternatively, you can use the FastAPI CLI command:
```bash
fastapi dev main.py
```
## Documentation
For full documentation, visit the FastAPI EasyStart Documentation (Coming Soon).
[//]: # (## Contributing)
[//]: # ()
[//]: # (Contributions are welcome! Please see the CONTRIBUTING.md file for more information on how to get involved.)
## License
This project is licensed under a modified MIT License - see the [LICENSE](LICENSE) file for details.
---
This version organizes the information clearly, ensures that placeholders for future content are marked, and maintains a professional tone throughout. Adjust the documentation and URLs when they are available.
Raw data
{
"_id": null,
"home_page": null,
"name": "fastapi-easystart",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "fastapi, fastapi easy start, fastapi project setup, fastapi jwt, fastapi custom response, FastAPI projects, CORS setup, fastapi modular components",
"author": null,
"author_email": "Ankaj Gupta <ankajgupta@coderwebsite.com>, Coder Website <contact@coderwebsite.com>",
"download_url": "https://files.pythonhosted.org/packages/dc/aa/83bad0601ace0366cdbe0541f6e7c9575e8e91172de5d5f52c6f27cfd11a/fastapi_easystart-0.0.7.tar.gz",
"platform": null,
"description": "# FastAPI EasyStart\r\n\r\nFastAPI EasyStart is a streamlined library designed to help developers quickly set up and configure a FastAPI project with essential components. It simplifies the process of creating APIs by providing ready-to-use templates and configurations for common tasks such as authentication, database integration, and CORS settings.\r\n\r\n\r\n## Features\r\n\r\n- \ud83d\ude80 Quick Start Templates: Get started with FastAPI in seconds using predefined project structures and configurations.\r\n- \ud83d\udd27 Environment Management: Easily manage environment variables and settings.\r\n- \ud83c\udf0d CORS Configuration: Simplify CORS setup with built-in configurations.\r\n- \ud83d\udce6 Modular Components: Use only what you need with modular and customizable components.\r\n- \ud83d\udca1 Custom Exception Classes: Enhance error handling with predefined, customizable exception classes tailored for FastAPI.\r\n- \ud83d\udd10 Authentication: Easily integrate JWT-based authentication. (Coming Soon)\r\n- \ud83d\udcbe Database Support: Seamless integration with popular databases like SQLite, PostgreSQL, and MongoDB. (Coming Soon)\r\n\r\n## Installation\r\n\r\nYou can install the fastapi-easystart package using either pip or pipenv:\r\n\r\n```bash\r\npip install fastapi-easystart\r\n```\r\n\r\n## Quickstart\r\n\r\n### 1. Initialize a New FastAPI Project\r\nBegin by creating a new FastAPI project with the default settings and configurations. Run the following command:\r\n```bash\r\npython -m fastapi_easystart.main init\r\n```\r\nThis command will generate the basic project structure, including directories and initial files, based on the easy start template.\r\n\r\n### 2. Configure the main.py File\r\nAfter initializing your project, configure the main.py file to set up the FastAPI application. If you want to either override or merge the existing main.py file with a new configuration, use the following command:\r\n```bash\r\npython -m fastapi_easystart.main config-main\r\n```\r\n\r\n### 3. Running the Development Server\r\nOnce the project is set up, you can start the development server:\r\n```bash\r\nuvicorn main:app --reload\r\n```\r\n\r\nAlternatively, you can use the FastAPI CLI command:\r\n\r\n```bash\r\nfastapi dev main.py\r\n```\r\n\r\n## Documentation\r\n\r\nFor full documentation, visit the FastAPI EasyStart Documentation (Coming Soon).\r\n\r\n[//]: # (## Contributing)\r\n\r\n[//]: # ()\r\n[//]: # (Contributions are welcome! Please see the CONTRIBUTING.md file for more information on how to get involved.)\r\n\r\n\r\n## License\r\n\r\nThis project is licensed under a modified MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n---\r\n\r\nThis version organizes the information clearly, ensures that placeholders for future content are marked, and maintains a professional tone throughout. Adjust the documentation and URLs when they are available.\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "FastAPI EasyStart simplifies FastAPI project setup with ready-to-use templates and configurations for environment management, CORS, and authentication. It lets you focus on coding by handling the boilerplate, making it easy to launch projects quickly.",
"version": "0.0.7",
"project_urls": null,
"split_keywords": [
"fastapi",
" fastapi easy start",
" fastapi project setup",
" fastapi jwt",
" fastapi custom response",
" fastapi projects",
" cors setup",
" fastapi modular components"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "673f07db6cd578c3294be1af1e04ff0a3ac2c6b4ce0c1cbca462e2779ffb5a1a",
"md5": "65e4318483453f8d857d9eb8c94b780f",
"sha256": "36887d1787fe38f7671b1053d865beb1c9ff98ff9f223d7ec0bbfe181fd7718e"
},
"downloads": -1,
"filename": "fastapi_easystart-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65e4318483453f8d857d9eb8c94b780f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 56772,
"upload_time": "2024-09-09T11:58:12",
"upload_time_iso_8601": "2024-09-09T11:58:12.287664Z",
"url": "https://files.pythonhosted.org/packages/67/3f/07db6cd578c3294be1af1e04ff0a3ac2c6b4ce0c1cbca462e2779ffb5a1a/fastapi_easystart-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dcaa83bad0601ace0366cdbe0541f6e7c9575e8e91172de5d5f52c6f27cfd11a",
"md5": "e669e5c2b779d7475909474eb817939f",
"sha256": "137d51887944abc1354d8032d83c512499d9d65f44799c1f07e9e2a55095b0de"
},
"downloads": -1,
"filename": "fastapi_easystart-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "e669e5c2b779d7475909474eb817939f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 37266,
"upload_time": "2024-09-09T11:58:13",
"upload_time_iso_8601": "2024-09-09T11:58:13.513384Z",
"url": "https://files.pythonhosted.org/packages/dc/aa/83bad0601ace0366cdbe0541f6e7c9575e8e91172de5d5f52c6f27cfd11a/fastapi_easystart-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-09 11:58:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fastapi-easystart"
}
JSON