Client API for talking to an Encapsia system.
Project description
Encapsia API Library
REST API for working with Encapsia.
Installation
pip install encapsia-api
Contributing
encapsia-api is a python package managed with poetry.
You will need python 3.8 or newer. To get started, after checking out this repository,
run:
poetry install
Code Style
Code in this project should be auto-formatted using black and adhere to isort-like
imports, and should pass linting and checks. You can run the following commands
manually, or integrate the tooling in your dev environment, but see also the next
section.
poetry run black .
poetry run ruff check .
poetry run mypy .
Ruff can fix some of the issues it finds. For example, it can fix the style of importing modules, but it can do much more. This can be done with running:
poetry run ruff check --fix .
However, please make sure you check the fixes it performs!
Revision Control
The release branch for this project is master and feature branches should be merged
into it via pull requests.
This repository uses pre-commit to run various checks with
git pre-commit hooks. To get started, run:
pre-commit install
After this, configured checks are run before you commit changes. You can also run them explicitly for all files:
pre-commit run -a
Versioning
encapsia-api adheres to Semantic Versioning.
To change the version, run:
poetry version <specifier> # e.g. patch
or edit the version string in pyproject.toml. In any case, update the following file
to match the new version: encapsia_api/__init__.py.
Note that we are yet in <1.0.0 land and thus version changes are not too strict and
backward-incompatible changes may still occur before 1.0.0.
Building
Manually build by running:
poetry build
Updating Dependencies
This is achieved with:
poetry update
poetry lock
poetry export -f requirements.txt > requirements.txt
How to Run Tests
Run:
poetry run pytest
Continuous Integration
This project uses Github Actions to for linting, checking, and running the tests on commit to or pull requests targeting the main branch.
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
Built Distribution
File details
Details for the file encapsia_api-0.4.5.tar.gz.
File metadata
- Download URL: encapsia_api-0.4.5.tar.gz
- Upload date:
- Size: 24.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.11.7 Linux/6.5.0-14-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 06f438ed00c4fd8a5b2b39a95491a31319c92a0f9a4e8cdb484dff50ff0813fc |
|
| MD5 | 9f4fbf4dfdb40f0be8d2bdd8485c6323 |
|
| BLAKE2b-256 | 2dc6fa320dc3aabe125f10868b7655edace672dc7a28ae6d8ce3981ce6978c01 |
File details
Details for the file encapsia_api-0.4.5-py3-none-any.whl.
File metadata
- Download URL: encapsia_api-0.4.5-py3-none-any.whl
- Upload date:
- Size: 26.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.11.7 Linux/6.5.0-14-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 36f7f2888725ff566e22d7879c1f13a09514bbbd134fa8c38760417468cf9997 |
|
| MD5 | bcb94d26b9cd839e7678afcf23577090 |
|
| BLAKE2b-256 | 55ce3380114f74ccb3efa7967e8511a10f2fb2edb8fe2fa4cbbf35de951f9b97 |
