https://github.com/jpcadena/fastapi-poetry-test
FastAPI test project using Poetry as interpreter.
https://github.com/jpcadena/fastapi-poetry-test
api api-rest api-restful backend fastapi markdown openapi poetry poetry-python pycharm pydantic python rest rest-api restapi restful-api restfulapi starlette swagger-ui uvicorn
Last synced: 4 months ago
JSON representation
FastAPI test project using Poetry as interpreter.
- Host: GitHub
- URL: https://github.com/jpcadena/fastapi-poetry-test
- Owner: jpcadena
- License: mit
- Created: 2023-04-08T02:07:16.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-08T02:21:41.000Z (almost 3 years ago)
- Last Synced: 2025-01-15T18:47:04.795Z (about 1 year ago)
- Topics: api, api-rest, api-restful, backend, fastapi, markdown, openapi, poetry, poetry-python, pycharm, pydantic, python, rest, rest-api, restapi, restful-api, restfulapi, starlette, swagger-ui, uvicorn
- Language: Python
- Homepage: https://github.com/jpcadena/fastapi-poetry-test
- Size: 164 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# fastapi-poetry-test
Table of Contents
## About the project
![Project][project-screenshot]
This FastAPI project is testing Poetry as interpreter.
### Built with
* [![Python][Python]][python-url]
* [![FastAPI][FastAPI]][fastapi-url]
* [![Pydantic][Pydantic]][pydantic-url]
* [![Starlette][starlette]][starlette-url]
* [![Uvicorn][uvicorn]][uvicorn-url]
* [![Pylint][pylint]][pylint-url]
* [![Pycharm][Pycharm]][Pycharm-url]
* [![Markdown][Markdown]][Markdown-url]
* [![Swagger][Swagger]][Swagger-url]
## Getting started
### Prerequisites
* [Python 3.11.3][Python-docs]
### 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
```
### 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
```
## Contributing
[![GitHub][GitHub]][github-url]
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](https://peps.python.org/pep-0008/).\
Check documentation
for [Visual Studio Code](https://code.visualstudio.com/docs/python/linting#_run-linting)
or [Jetbrains Pycharm](https://github.com/leinardi/pylint-pycharm/blob/master/README.md).\
Recommended plugin for
autocompletion: [Tabnine](https://www.tabnine.com/install)
## License
Distributed under the MIT License.
## Contact
- [![LinkedIn][LinkedIn]][linkedin-url]
- [![Outlook][Outlook]](mailto:jpcadena@espol.edu.ec?subject=[GitHub]fastapi-poetry-test)
[LinkedIn]: https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white
[linkedin-url]: https://linkedin.com/in/juanpablocadenaaguilar
[Outlook]: https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=for-the-badge&logo=microsoft-outlook&logoColor=white
[project-screenshot]: app/assets/static/images/project.png
[Python-docs]: https://docs.python.org/3.11/
[Python]: https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54
[FastAPI]: https://img.shields.io/badge/FastAPI-FFFFFF?style=for-the-badge&logo=fastapi
[Pydantic]: https://img.shields.io/badge/Pydantic-FF43A1?style=for-the-badge&logo=pydantic&logoColor=white
[Starlette]: https://img.shields.io/badge/Starlette-392939?style=for-the-badge&logo=starlette&logoColor=white
[Uvicorn]: https://img.shields.io/badge/Uvicorn-2A308B?style=for-the-badge&logo=uvicorn&logoColor=white
[Pylint]: https://img.shields.io/badge/linting-pylint-yellowgreen
[PyCharm]: https://img.shields.io/badge/PyCharm-21D789?style=for-the-badge&logo=pycharm&logoColor=white
[Markdown]: https://img.shields.io/badge/Markdown-000000?style=for-the-badge&logo=markdown&logoColor=white
[Swagger]: https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white
[python-url]: https://www.python.org/
[fastapi-url]: https://fastapi.tiangolo.com
[pydantic-url]: https://docs.pydantic.dev
[starlette-url]: https://www.starlette.io/
[uvicorn-url]: https://www.uvicorn.org/
[pylint-url]: https://www.pylint.org/
[Pycharm-url]: https://www.jetbrains.com/pycharm/
[Markdown-url]: https://daringfireball.net/projects/markdown/
[Swagger-url]: https://swagger.io/
[GitHub]: https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white
[GitHub-url]: https://github.com/jpcadena/fastapi-poetry-test
