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
docknet-0.0.23.tar.gz
(145.2 kB
view details)
Built Distribution
docknet-0.0.23-py3-none-any.whl
(159.9 kB
view details)
File details
Details for the file docknet-0.0.23.tar.gz
.
File metadata
- Download URL: docknet-0.0.23.tar.gz
- Upload date:
- Size: 145.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24853b98822d5d8587e162afeaea0e4d3daabeb22dc3a3abba96038345f413c0 |
|
MD5 | 629a92185b1eb8c8b46afb974ce314f9 |
|
BLAKE2b-256 | 49f6cb6a2c4f5f931d1b37c1f86e355814701e3a83034501d8c3f61e95ff0731 |
File details
Details for the file docknet-0.0.23-py3-none-any.whl
.
File metadata
- Download URL: docknet-0.0.23-py3-none-any.whl
- Upload date:
- Size: 159.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3578e2e9755237e0daf8cadf8444ec70ab7a01c6cf763f90b9bbb16ff1f9ba6b |
|
MD5 | 65bc984dad090470fe7005a95ca45e5b |
|
BLAKE2b-256 | bdf3eea64ad9405fdbea9189786a1946025f671d925d6df0a8ab95e8fb3a6614 |