Python package template.
Project description
Python Library Template
WIP: Document python library.
Requirements
- Python 3.6+
Installation
Install via pip:
pip install --upgrade -e path/to/lib
Usage
After installation, the package can be imported:
import template_package
Development
This library uses black for auto-formatting, isort for import sorting, flake8 for linting, mypy for type checking, and pydocstyle for docstring style checks. All code is written compatible with Python 3.6+, with type hints wherever possible.
Testing
- DeploymentManager:
- By default, just the DockerDeploymentManager is executed. To execute also the Kubernetes-related tests, a Kubernetes cluster has to be available from where the code is executed. On your local Mac, you can simply start one by executing
kind create cluster
. Then execute the tests by setting the environment variableKUBE_AVAILABLE=true
(in VS Code, you can for example set the env variable in thelaunch.json
or append it in front of the pytest command, e.g.KUBE_AVAILABLE=true pytest...
)
- By default, just the DockerDeploymentManager is executed. To execute also the Kubernetes-related tests, a Kubernetes cluster has to be available from where the code is executed. On your local Mac, you can simply start one by executing
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
contaxy-0.0.20.tar.gz
(122.7 kB
view hashes)
Built Distribution
contaxy-0.0.20-py3-none-any.whl
(158.9 kB
view hashes)