# FastAPI QuickStart
FastAPI QuickStart is a tool to quickly set up a basic structure for a FastAPI application.
## Installation
```
pip install fastapi-quickstart-genesis
```
## Usage
To create a new FastAPI project structure:
```
python -m fastapi_quickstart my_app
```
This will create a new directory `my_app` with a basic FastAPI application structure.
## Project Structure
The generated project will have the following structure:
```
my_app/
├── app/
│ ├── main.py
│ └── models.py
├── tests/
└── requirements.txt
```
## Development
To set up the development environment:
1. Clone the repository
2. Create a virtual environment: `python -m venv venv`
3. Activate the virtual environment `cd venv\Scripts\activate`
4. Install development dependencies: `pip install -r requirements.txt`
5. Install the package in editable mode: `pip install -e .`
## License
This project is licensed under the MIT License.
## Build wheel
1. First, let's install the necessary tools: `pip install setuptools wheel twine`
2. Now, let's try building the distribution files again: `python setup.py sdist bdist_wheel`
3. Before uploading to PyPI, it's a good practice to check your package: `twine check dist/*`
4. If everything looks good, you can upload to PyPI: `twine upload dist/*`
You'll be prompted for your PyPI username and password. If you haven't registered on PyPI yet, you'll need to do that first at https://pypi.org/account/register/
5. After uploading, you can install your package using pip: `pip install fastapi-quickstart-genesis`
Raw data
{
"_id": null,
"home_page": "https://github.com/ackmanb/fastapi-quickstart",
"name": "fastapi-quickstart-genesis",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "JCN",
"author_email": "ackmanb@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/18/aa/cf6a901b0816aec07fd568391ac63519c038c993eae48f2f6f604e02746f/fastapi-quickstart-genesis-0.1.3.tar.gz",
"platform": null,
"description": "# FastAPI QuickStart\r\n\r\nFastAPI QuickStart is a tool to quickly set up a basic structure for a FastAPI application.\r\n\r\n## Installation\r\n\r\n```\r\npip install fastapi-quickstart-genesis\r\n```\r\n\r\n## Usage\r\n\r\nTo create a new FastAPI project structure:\r\n\r\n```\r\npython -m fastapi_quickstart my_app\r\n```\r\n\r\nThis will create a new directory `my_app` with a basic FastAPI application structure.\r\n\r\n## Project Structure\r\n\r\nThe generated project will have the following structure:\r\n\r\n```\r\nmy_app/\r\n\u251c\u2500\u2500 app/\r\n\u2502 \u251c\u2500\u2500 main.py\r\n\u2502 \u2514\u2500\u2500 models.py\r\n\u251c\u2500\u2500 tests/\r\n\u2514\u2500\u2500 requirements.txt\r\n```\r\n\r\n## Development\r\n\r\nTo set up the development environment:\r\n\r\n1. Clone the repository\r\n2. Create a virtual environment: `python -m venv venv`\r\n3. Activate the virtual environment `cd venv\\Scripts\\activate`\r\n4. Install development dependencies: `pip install -r requirements.txt`\r\n5. Install the package in editable mode: `pip install -e .`\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License.\r\n\r\n## Build wheel\r\n\r\n1. First, let's install the necessary tools: `pip install setuptools wheel twine`\r\n2. Now, let's try building the distribution files again: `python setup.py sdist bdist_wheel`\r\n3. Before uploading to PyPI, it's a good practice to check your package: `twine check dist/*`\r\n4. If everything looks good, you can upload to PyPI: `twine upload dist/*`\r\n\r\nYou'll be prompted for your PyPI username and password. If you haven't registered on PyPI yet, you'll need to do that first at https://pypi.org/account/register/\r\n\r\n5. After uploading, you can install your package using pip: `pip install fastapi-quickstart-genesis`\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A quick start tool for FastAPI projects",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/ackmanb/fastapi-quickstart"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93d7593654882070a4e1ad7c83e6af99fd68c81b5c443395d4231e36e58d0823",
"md5": "dba833d2a3833bc2e93b6d86ffad5447",
"sha256": "3bee9f3d0fb70367cab320470c5899b2585f1f738d1c0acdb8894564d351dbfb"
},
"downloads": -1,
"filename": "fastapi_quickstart_genesis-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dba833d2a3833bc2e93b6d86ffad5447",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5226,
"upload_time": "2024-08-24T19:39:45",
"upload_time_iso_8601": "2024-08-24T19:39:45.600913Z",
"url": "https://files.pythonhosted.org/packages/93/d7/593654882070a4e1ad7c83e6af99fd68c81b5c443395d4231e36e58d0823/fastapi_quickstart_genesis-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "18aacf6a901b0816aec07fd568391ac63519c038c993eae48f2f6f604e02746f",
"md5": "fd68fe548206c43d9bdca625631daa81",
"sha256": "646b00ecdcefc6080cb2b96980c00a5774892021aabc22322b2496705925d822"
},
"downloads": -1,
"filename": "fastapi-quickstart-genesis-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "fd68fe548206c43d9bdca625631daa81",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4144,
"upload_time": "2024-08-24T19:39:46",
"upload_time_iso_8601": "2024-08-24T19:39:46.537849Z",
"url": "https://files.pythonhosted.org/packages/18/aa/cf6a901b0816aec07fd568391ac63519c038c993eae48f2f6f604e02746f/fastapi-quickstart-genesis-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-24 19:39:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ackmanb",
"github_project": "fastapi-quickstart",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "fastapi-quickstart-genesis"
}
JSON
