cwang / fastapi-poetry-starter Goto Github PK

Template for a well-setup FastAPI project

(back to top)

To run this project locally, you will need to install the prerequisites and follow the installation section.

This Project depends on the following projects.

• Poetry

  pip install --user --upgrade poetry

• Poe the Poet

  pip install --user --upgrade poethepoet

1. Clone the repo

   git clone https://github.com/cwang/fastapi-poetry-starter
   cd fastapi-poetry-starter

2. Install Poe the Poet and Poetry

   pip install --user --upgrade poethepoet poetry

3. Install requirements for development

   poe install-dev

4. Run tests

   poe test

(back to top)

Some useful examples of how this project can be used:

• Install requirements

  poe install-dev

• Run tests

  poe test

• Run the project via the main entrypoint

  poe run

• Generate API documentation

  poe doc

• Build a docker image for tests

  poe docker-build --target test --build-tag 3.10-alpine
  docker run -ti --rm starter:test-3.10-alpine

• Build a docker image to run the root files only without running any test

  poe docker-build --target prod --build-tag 3.10-alpine --no-test
  docker run -ti --rm starter:prod-3.10-alpine

• Lastly, run the project with Uvicorn with reloading enabled

  poe uvicorn

For more examples, please refer to the Documentation

(back to top)

• Add tests
• Add code coverage
• Improve documentation
• Include more tests

See the open issues for a full list of proposed features (and known issues).

(back to top)

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Chen Wang - @cwang - [email protected]

Project Link: https://github.com/cwang/fastapi-poetry-starter/

(back to top)

This project was created using cookiecutter and NullHack's python-project-template:

• NullHack's python-project-template

(back to top)

Distributed under the MIT License. See LICENSE for more information.

(back to top)