Cyto lets you:
- Create a click CLI from a pydantic model
- Load pydantic settings from TOML files [WIP]
- Daemonize your application [WIP]
Cyto is the bridge between an oppinionated selection of Python tech. Cyto is everything you need to create a modern Python app. Cyto is the glue and boilerplate code that you no longer have to write yourself.
So you only want the click–pydantic integration but not the TOML loader? Don't worry, Cyto is split into so-called extras so you can select just the extras that you want. In turn, Cyto only pulls in the dependencies for the selected extras. This is the "only pay for what you use" principle. In fact, Cyto has zero dependencies per default.
Here is the list of extras:
settings-sources-cli
: Create a click CLI from a pydantic modelsettings-sources-toml
: Load pydantic settings from TOML files [WIP]app
: [WIP]
Install Cyto along with all extras:
pip install cyto[all]
Similar for poetry:
poetry add cyto[all]
If you only want a specific extra, choose that when you install Cyto. E.g.:
pip install cyto[settings-sources-cli]
Similar for poetry:
poetry add cyto[settings-sources-cli]
Development requires Python 3.8 or later. Test your python version with:
python3 --version
If you have multiple python installations, you can replace python3
with a specific version (e.g., python3.8
) in the steps below.
Do the following:
- Clone this repository
git clone [email protected]:sbtinstruments/cyto.git
- Install poetry (for dependency management)
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3
- Optional: Use a local poetry virtual environment
This integrates better with editors such as Visual Studio Code.
poetry config --local virtualenvs.in-project true
- Create poetry's virtual environment and get all dependencies
and all extra features.
poetry install --extras all
- Optional: Run the QA basic tools (e.g., isort, black, pylint, mypy) automatically before each commit
poetry run pre-commit install
All QA basic tools automatically run in Jenkins for each commit pushed
to the remote repository. If you installed the pre-commit
hooks,
all QA basic tools automatically run before each commit too.
The QA basic tools are:
isort
(for import ordering)black
(for formatting)pylint
(for linting)mypy
(for type checking)
You can run the QA basic tools manually. This is useful if you
don't want to install the pre-commit
hooks.
Run the QA basic tools manually with:
poetry run task isort
poetry run task black
poetry run task pylint
poetry run task mypy
Run all the basic QA tools manually with a single command:
poetry run task pre-commit
Note that this doesn't require you to install the pre-commit
hooks.
All of the tools below automatically run in Jenkins for each commit pushed to the remote repository.
The QA test tools are:
tox
(for automation across Python versions)pytest
(the test framework itself)pytest-cov
(for test coverage percentage)
Run the tests manually:
- Install
tox
python3 -m pip install tox
- Start a tox run:
tox
Note that tox
invokes pytest
in a set of virtual environments. Said
virtual environments have nothing to do with poetry's virtual environment. Poetry and tox runs in isolation of each other.
We have a default settings file that you can use via the following command:
cp .vscode/settings.json.default .vscode/settings.json
This is optional.
Hopefully, you used the local poetry virtual environment during
installation (the poetry config --local virtualenvs.in-project true
part). This way, Visual Studio Code automatically finds the
Python interpreter within poetry's virtual environment.
Alternatively, you can point Visual Studio Code to poetry's
global virtual environments folder. Add the following entry
to your ./vscode/settings.json
file:
{ "python.venvPath": "~/.cache/pypoetry/virtualenvs" }
Then, you look for the poetry's currently active virtual environment:
poetry env list
Lastly, you use the Visual Studio Code command
Python: Select Interpreter
and choose the interpreter inside
poetry's currently active virtual environment.