jpcadena / fastapi-poetry-test

FastAPI test project using Poetry as interpreter.

fastapi-poetry-test

Fastapi poetry test

FastAPI Poetry test project.
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About the project

This FastAPI project is testing Poetry as interpreter.

(back to top)

Built with

• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting started

Prerequisites

• Python 3.11.3

Installation

1. Clone the repository

   git clone https://github.com/jpcadena/fastapi-poetry-test.git
   

2. Change the directory to root project

   cd fastapi-poetry-test
   

3. Install Poetry package manager

   pip install poetry
   

4. Install the project's dependencies

   poetry install
   

5. Activate the environment

   poetry shell
   

(back to top)

Usage

1. If found sample.env, copy it and rename it to .env.
2. Replace your credentials into the .env file.
3. Execute with console

   uvicorn main:app --reload
   

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request.

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

Use docstrings with reStructuredText format by adding triple double quotes """ after function definition.
Add a brief function description, also for the parameters including the return value and its corresponding data type.
Please use linting to check your code quality following PEP 8.
Check documentation for Visual Studio Code or Jetbrains Pycharm.
Recommended plugin for autocompletion: Tabnine

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

• 

• 

(back to top)