FastAPIExample 0.0.6

Exploring FastAPI

General
CI
PyPI
Github

This project provides a sandbox to experiment with FastAPI. This idea is to build an example sequentially in steps to give new users the idea on where to start and how to progress.

Along the way some principles will be exhibited. The code should be self-explanatory.

The source code in src by itself does not do much, it basically only defines the tables and some setup code. The “examples” are in the pytest's since we are experimenting to see howe it works and if it was successful.

References:

Installation

1. Since this is intended for experimental purposes, it is recommended to create a virtual environment to experiment for installation.

2. Set the following environment variables in the virtual environment. Set these in your IDE as well.

3. Start Docker. The docker-rebuild.bat script will git docker up and running.

4. The setup and installation is for Windows. Feel free to add contribute to get it running on Linux as well.

python -m venv ./FastAPIexample_venv
pip install FastAPIexample
pre-commit install
SET MYSQL_HOST=localhost
SET MYSQL_ROOT_PWD=N0tS0S3curePassw0rd
SET MYSQL_TCP_PORT_EXAMPLES=50002
SET SQLALCHEMY_SILENCE_UBER_WARNING=1
docker-rebuild.bat

Tests

1. This project uses pytest to run tests.

2. There are various settings combinations in the [tool.pytest.ini_options] section of the pyproject.toml file that can used by commenting it out.

3. This project uses black to format code and flake8 for linting. We also support pre-commit to ensure these have been run. To configure your local environment please install these development dependencies and set up the commit hooks.

pytest

Contributing

Naming Conventions

1. File names

   1. Not knowing what’s to come and what will be added, it is difficult to determine a naming convention for source, test and other file names. The owner will therefore be a “benevolent dictator” to rename and change names.

   2. Link the file name of the source code and the test so that it is easily linked.

2. Branch names

   “enhancement” | “bug” | “hotfix”/< ticket_nr>_<description>

   where

   enhancement - Planned improvement or addition to functionality; non-urgent.

   bug - An error or defect causing incorrect or unexpected behavior; typically fixed in regular development cycles.

   hotfix - An urgent, critical fix applied directly to the live environment, often bypassing regular development cycles.

   ticket_nr: Ticket number assigned to the issue in GitHub. Once an issue is registered, the owner will assign a ticket.

   description: GitHub issue title or combination of titles is more than one issue is addressed.

Releasing

For the purpose of push and release of code two script files are included. Use there two files to files to make life a bit easier. The scripts make use of the gitit module to simplify tasks.

1. push.bat - Use this script to push branches to GitHub repository. In principle it does the following:

   usage: push message

   e.g. push “Changed the Infinite Improbability Drive”

   1. .rst syntax check

   2. git add -A

   3. git commit -m message (with pre-commit including black and flake8)

   4. git push –all

2. release.bat - Use this script to push a new tag and release to the GitHub repository. Remember to change the version number in the setup.cfg else the workflow will fail.

   usage: release version The version will match the release and the tag. Only issue a release once a push.bat was successful. In principle it does the following:

   e.g. release 1.2.3

   1. Commit the changes

   2. Create and push the release tag with the correct naming conventions.

   3. Checkout master since it assumes that the branch is now merged with master and will be deleted.

   4. display a list of all the current branches as a reminder to delete the branch on completion.