# Encapsia API Library
[](https://github.com/pre-commit/pre-commit)
[](https://snyk.io/test/github/encapsia/encapsia-api?targetFile=requirements.txt)
REST API for working with [Encapsia](https://www.encapsia.com).
## Installation
pip install encapsia-api
## Contributing
`encapsia-api` is a python package managed with [`poetry`](https://python-poetry.org/).
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`](https://pre-commit.com/) 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](https://semver.org/spec/v2.0.0.html).
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/Encapsia/encapsia-api",
"name": "encapsia-api",
"maintainer": "Petre Mierlu\u021biu",
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": "petre.mierlutiu@aixial.com",
"keywords": "encapsia, eSource, EDC, Clinical Trials",
"author": "Timothy Corbett-Clark",
"author_email": "timothy.corbettclark@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c3/ec/036a83dcfbf3cac9736e757e6816cb3bd44cf8e6a7666d7d96c2c6c816ec/encapsia_api-0.4.6.tar.gz",
"platform": null,
"description": "# Encapsia API Library\n\n\n\n[](https://github.com/pre-commit/pre-commit)\n\n\n[](https://snyk.io/test/github/encapsia/encapsia-api?targetFile=requirements.txt)\n\n\nREST API for working with [Encapsia](https://www.encapsia.com).\n\n## Installation\n\n pip install encapsia-api\n \n\n## Contributing\n\n`encapsia-api` is a python package managed with [`poetry`](https://python-poetry.org/).\nYou will need python 3.8 or newer. To get started, after checking out this repository,\nrun:\n\n poetry install\n \n\n### Code Style\n\nCode in this project should be auto-formatted using `black` and adhere to isort-like\nimports, and should pass linting and checks. You can run the following commands\nmanually, or integrate the tooling in your dev environment, but see also the next\nsection.\n\n poetry run black .\n poetry run ruff check .\n poetry run mypy .\n\nRuff can fix some of the issues it finds. For example, it can fix the style of importing\nmodules, but it can do much more. This can be done with running:\n\n poetry run ruff check --fix .\n \nHowever, please make sure you check the fixes it performs!\n\n\n### Revision Control\n\nThe release branch for this project is `master` and feature branches should be merged\ninto it via pull requests.\n\nThis repository uses [`pre-commit`](https://pre-commit.com/) to run various checks with\ngit pre-commit hooks. To get started, run:\n\n pre-commit install\n \nAfter this, configured checks are run before you commit changes. You can also run them\nexplicitly for all files:\n\n pre-commit run -a\n\n\n### Versioning\n\n`encapsia-api` adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\nTo change the version, run:\n\n poetry version <specifier> # e.g. patch\n\nor edit the version string in `pyproject.toml`. In any case, update the following file\nto match the new version: `encapsia_api/__init__.py`.\n\nNote that we are yet in `<1.0.0` land and thus version changes are not too strict and\nbackward-incompatible changes may still occur before 1.0.0.\n\n\n### Building\n\nManually build by running:\n\n poetry build\n \n \n### Updating Dependencies\n\nThis is achieved with:\n\n poetry update\n poetry lock\n poetry export -f requirements.txt > requirements.txt\n\n### How to Run Tests\n\nRun:\n\n poetry run pytest\n\n\n### Continuous Integration\n\nThis project uses Github Actions to for linting, checking, and running the tests on\ncommit to or pull requests targeting the main branch.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Client API for talking to an Encapsia system.",
"version": "0.4.6",
"project_urls": {
"Homepage": "https://github.com/Encapsia/encapsia-api"
},
"split_keywords": [
"encapsia",
" esource",
" edc",
" clinical trials"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e6424e082a2188290de493273b23b4c2267a5460d3bad42b6600d1069b6f443",
"md5": "d2fbac8ec5268a115762e1a5a1d67967",
"sha256": "d395cc57ea53ba447b6337203cd124e827fcebfa4ed3ef690981e2fc1acf71f4"
},
"downloads": -1,
"filename": "encapsia_api-0.4.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2fbac8ec5268a115762e1a5a1d67967",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 26735,
"upload_time": "2024-04-01T09:40:51",
"upload_time_iso_8601": "2024-04-01T09:40:51.297975Z",
"url": "https://files.pythonhosted.org/packages/4e/64/24e082a2188290de493273b23b4c2267a5460d3bad42b6600d1069b6f443/encapsia_api-0.4.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c3ec036a83dcfbf3cac9736e757e6816cb3bd44cf8e6a7666d7d96c2c6c816ec",
"md5": "a5da295b2ec03d128c3d504859f345be",
"sha256": "42590d50a35e06c0ec2071f67895e7ebcdfb8d6cc704f6502a11c20e8f9d7cf8"
},
"downloads": -1,
"filename": "encapsia_api-0.4.6.tar.gz",
"has_sig": false,
"md5_digest": "a5da295b2ec03d128c3d504859f345be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 24388,
"upload_time": "2024-04-01T09:40:53",
"upload_time_iso_8601": "2024-04-01T09:40:53.522719Z",
"url": "https://files.pythonhosted.org/packages/c3/ec/036a83dcfbf3cac9736e757e6816cb3bd44cf8e6a7666d7d96c2c6c816ec/encapsia_api-0.4.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 09:40:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Encapsia",
"github_project": "encapsia-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "encapsia-api"
}
JSON
