diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 12a065a..7facc8d 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -1,7 +1,7 @@ # This workflow will install Python dependencies, run tests and lint with a variety of Python versions # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions -name: Python package +name: tests on: pull_request: diff --git a/README.md b/README.md index 7d5a757..85a2644 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ -# Project description - [![GitHub license](https://img.shields.io/github/license/rafsaf/fastapi-plan)](https://github.com/rafsaf/fastapi-plan/blob/master/LICENSE) ![PyPI](https://img.shields.io/pypi/v/fastapi-plan) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fastapi-plan) -![example workflow](https://github.com/rafsaf/fastapi-plan/actions/workflows/python-package.yml/badge.svg) +![tests](https://github.com/rafsaf/fastapi-plan/actions/workflows/tests.yml/badge.svg) -## about +## About dead simple but powerful template manager for FastAPI applications. -## quickstart +## Quickstart NOTE: you will need [docker](https://www.docker.com/get-started) and optional but recommended [poetry](https://python-poetry.org/docs/) installed! @@ -25,7 +23,7 @@ initialize new FastAPI project: fastapi-plan ``` -enter project name and other information and after noticing SUCCESS your project is ready, enter project with `cd project_name` and continue installing dependencies: +enter project_name and other information and after project is ready, `cd project_name` and continue installing dependencies: ```bash poetry install @@ -53,45 +51,43 @@ finally you can run this command to start uvicorn server uvicorn app.main:app --reload ``` -## short project structure +## Short project structure ``` |── app -| ├── api # endpoints/dependecies +| ├── api # endpoints/dependecies | | -| ├── core # settings and security algorithms +| ├── core # settings and security algorithms | | -| ├── crud # CRUD operations +| ├── crud # CRUD operations | | -| ├── migrations # for aerich migrations +| ├── migrations # for aerich migrations | | -| ├── models # tortoise models +| ├── models # tortoise models | | -| ├── schemas # pandatic schemas +| ├── schemas # pandatic schemas | | -| ├── tests # tests +| ├── tests # tests | | -| ├── initial.sh # initial shell script used by docker -| ├── initial_data.py # init database and add first superuser -| ├── main.py # main fastapi application file +| ├── initial.sh # initial shell script used by docker +| ├── initial_data.py # init database and add first superuser +| ├── main.py # main fastapi application file | -├── config # nginx server config file +├── config # nginx server config file | -├── .env # .env file with settings +├── .env # .env file with settings | -├── Dockerfile # dockerfile for web app +├── Dockerfile # dockerfile for web app | -├── aerich.ini # aerich (migrations) configuration +├── aerich.ini # aerich (migrations) configuration | -├── docker-compose.yml # puts it all together +├── docker-compose.yml # puts it all together | -├── pytest.ini # Pytest configurations +├── pytest.ini # Pytest configurations | -├── pyproject.toml # python dependencies (poetry) +├── pyproject.toml # python dependencies (poetry) | -├── poetry.lock # python dependencies (poetry) +├── poetry.lock # python dependencies (poetry) | -├── (optional) requirements.txt # python dependencies (pip) +├── (optional) requirements.txt # python dependencies (pip) ``` - -## why such a structure of the project diff --git a/pyproject.toml b/pyproject.toml index aea033e..84c68ab 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "fastapi-plan" -version = "0.2.2" +version = "0.2.3" description = "Dead simple template manager for FastAPI applications" license = "MIT" readme = "README.md"