# make-fastapi-app
```bash
pip install make-fastapi-app
```
Running
```bash
make-fastapi-app
```
FastAPI app creation template
[](../../actions/workflows/lint.yml)
[](../../actions/workflows/push_macos.yml)
[](../../actions/workflows/push_ubuntu.yml)
[](../../actions/workflows/push_win.yml)
# Instructions
First off, make sure you have python installed and this package `pip install make-fastapi-app`, this will create a new global command `make-fastapi-app` that you will use in the steps below.
* Create a new python github repo, let's call it "myapp"
* Clone that "myapp" repo to your local computer
* `cd` into "myapp`
* Run `make-fastapi-app` at the project root.
* Follow the instructions
* Now `git commit` the files into the repo.
Now you should have a fully formed app that is ready to be used at Render.com or DigitalOcean, which will use the Dockerfile install. Everything should be automatic with this option.
## Running locally
You can either run the app locally. See the run scripts at the project root. You'll need to install the project globally with `pip install -e .` or else use a virtual environment with `python make_venv.py` and then using `. ./activate.sh` and then `pip install -e .` and then running the `run_dev.py` which should launch everything. Also there is a VSCode build tool that will do this automatically. It will be something like `Terminal` -> `Run Build Tools` -> `Run Local`
# Windows
This environment requires you to use `git-bash`.
# Linting
Run `./lint.sh` to find linting errors using `pylint`, `flake8` and `mypy`.
# Versions
* 1.0.7: Upgrade setup.py -> pyproject.toml
* 1.0.6: Command broke due to new python. I fixed it.
* 1.0.5: Fixes adding +x to sh files
* 1.0.4: Allows empty github url
* 1.0.3: Adds post install instructions to the command line.
* 1.0.2: Remove trailing `.git` and `/` for githurl repo input
* 1.0.1: Adds +x to all shell scripts
* 1.0.0: Initial commit
Raw data
{
"_id": null,
"home_page": "https://github.com/zackees/createfastapiapp",
"name": "make-fastapi-app",
"maintainer": "Zachary Vorhies",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "template-python-cmd",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/79/b2/0b07eaa918122dc368c62966e76a95450d50d78b7574c4c92e0cd4eeddc3/make_fastapi_app-1.0.7.tar.gz",
"platform": null,
"description": "# make-fastapi-app\r\n\r\n```bash\r\npip install make-fastapi-app\r\n```\r\n\r\nRunning\r\n```bash\r\nmake-fastapi-app\r\n```\r\n\r\n\r\nFastAPI app creation template\r\n\r\n[](../../actions/workflows/lint.yml)\r\n\r\n[](../../actions/workflows/push_macos.yml)\r\n[](../../actions/workflows/push_ubuntu.yml)\r\n[](../../actions/workflows/push_win.yml)\r\n\r\n\r\n# Instructions\r\n\r\nFirst off, make sure you have python installed and this package `pip install make-fastapi-app`, this will create a new global command `make-fastapi-app` that you will use in the steps below.\r\n\r\n * Create a new python github repo, let's call it \"myapp\"\r\n * Clone that \"myapp\" repo to your local computer\r\n * `cd` into \"myapp`\r\n * Run `make-fastapi-app` at the project root.\r\n * Follow the instructions\r\n * Now `git commit` the files into the repo.\r\n \r\nNow you should have a fully formed app that is ready to be used at Render.com or DigitalOcean, which will use the Dockerfile install. Everything should be automatic with this option.\r\n\r\n## Running locally\r\n\r\nYou can either run the app locally. See the run scripts at the project root. You'll need to install the project globally with `pip install -e .` or else use a virtual environment with `python make_venv.py` and then using `. ./activate.sh` and then `pip install -e .` and then running the `run_dev.py` which should launch everything. Also there is a VSCode build tool that will do this automatically. It will be something like `Terminal` -> `Run Build Tools` -> `Run Local`\r\n\r\n# Windows\r\n\r\nThis environment requires you to use `git-bash`.\r\n\r\n# Linting\r\n\r\nRun `./lint.sh` to find linting errors using `pylint`, `flake8` and `mypy`.\r\n\r\n# Versions\r\n \r\n * 1.0.7: Upgrade setup.py -> pyproject.toml\r\n * 1.0.6: Command broke due to new python. I fixed it.\r\n * 1.0.5: Fixes adding +x to sh files\r\n * 1.0.4: Allows empty github url\r\n * 1.0.3: Adds post install instructions to the command line.\r\n * 1.0.2: Remove trailing `.git` and `/` for githurl repo input\r\n * 1.0.1: Adds +x to all shell scripts\r\n * 1.0.0: Initial commit\r\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Creates a FastAPI app that is ready to be deployed on Docker hosts like DigitalOcean / Render.com",
"version": "1.0.7",
"project_urls": {
"Homepage": "https://github.com/zackees/createfastapiapp"
},
"split_keywords": [
"template-python-cmd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a49f3b21e94791fc87c9ddedf2dd9008168173bce7da4c979141e8af2e755190",
"md5": "3d2cf8d0d5fdc4e40cdee37baa1d6795",
"sha256": "70a0be2e2f6733bfbd182424fecf96d54b4e0d633724c9a8115554680cb10f97"
},
"downloads": -1,
"filename": "make_fastapi_app-1.0.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d2cf8d0d5fdc4e40cdee37baa1d6795",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 6839,
"upload_time": "2024-11-26T08:04:40",
"upload_time_iso_8601": "2024-11-26T08:04:40.880661Z",
"url": "https://files.pythonhosted.org/packages/a4/9f/3b21e94791fc87c9ddedf2dd9008168173bce7da4c979141e8af2e755190/make_fastapi_app-1.0.7-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "79b20b07eaa918122dc368c62966e76a95450d50d78b7574c4c92e0cd4eeddc3",
"md5": "f3f579a41464df76b0cbb8d5e752226a",
"sha256": "f85ae37b61b1a25451c5fb951badeab29b5765a4ee48ff32521b764840f8869b"
},
"downloads": -1,
"filename": "make_fastapi_app-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "f3f579a41464df76b0cbb8d5e752226a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14062,
"upload_time": "2024-11-26T08:04:41",
"upload_time_iso_8601": "2024-11-26T08:04:41.824640Z",
"url": "https://files.pythonhosted.org/packages/79/b2/0b07eaa918122dc368c62966e76a95450d50d78b7574c4c92e0cd4eeddc3/make_fastapi_app-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 08:04:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zackees",
"github_project": "createfastapiapp",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "make-fastapi-app"
}
JSON
