# About
[](https://snyk.io/test/github/encapsia/encapsia-cli?targetFile=requirements.txt)
This package provides command line access to Encapsia over the REST API.
All of these are designed to work with server 1.5 and beyond.
## Autocomplete
Setup autocomplete using the instructions found on <https://github.com/click-contrib/click-completion>
## Tests
### Unit tests
Run:
poetry run pytest
### Walkthrough Tests
Prerequisite: an instance of ice must be running on your localhost, and valid token for
it must be present in your key store.
See the `walkthrough_tests` directory for bash scripts which exercise the CLI.
Run them e.g. with:
poetry run bash walkthrough_tests/all.sh
or test specific subcommands with:
poetry run bash walkthrough_tests/token.sh
Note that these tests are *not* self-verifying; they just provide helpful coverage,
assurance, and working documentation.
## Release checklist
* Run: `poetry run black .`
* Run: `poetry run isort .`
* Run: `poetry run flake8 .`
* Run: `poetry run mypy .`
* Ensure "tests" run ok (see above).
* Capture test output and commit with: `poetry run bash walkthrough_tests/all.sh 2>&1 | poetry run ansi2html -f 80% >WALKTHROUGH.html`
* Create `requirements.txt` for Snyk scanning with: `poetry export -f requirements.txt >requirements.txt`
* Ensure git tag, package version, and `encapsia_cli.__version__` are all equal.
Raw data
{
"_id": null,
"home_page": "https://github.com/Encapsia/encapsia-cli",
"name": "encapsia-cli",
"maintainer": "Petre Mierlu\u021biu",
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": "pmierlutiu@cmedtechnology.com",
"keywords": "encapsia, eSource, EDC, Clinical Trials",
"author": "Timothy Corbett-Clark",
"author_email": "timothy.corbettclark@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6a/74/ab1a3d8604d4c7db255e01a55ec5bca3809cbc71798a54880af24dcbf79b/encapsia_cli-0.5.9.tar.gz",
"platform": null,
"description": "# About\n\n[](https://snyk.io/test/github/encapsia/encapsia-cli?targetFile=requirements.txt)\n\nThis package provides command line access to Encapsia over the REST API.\n\nAll of these are designed to work with server 1.5 and beyond.\n\n## Autocomplete\n\nSetup autocomplete using the instructions found on <https://github.com/click-contrib/click-completion>\n\n## Tests\n\n### Unit tests\n\nRun:\n\n poetry run pytest\n\n### Walkthrough Tests\n\nPrerequisite: an instance of ice must be running on your localhost, and valid token for\nit must be present in your key store.\n\nSee the `walkthrough_tests` directory for bash scripts which exercise the CLI.\n\nRun them e.g. with:\n\n poetry run bash walkthrough_tests/all.sh\n\nor test specific subcommands with:\n\n poetry run bash walkthrough_tests/token.sh\n\nNote that these tests are *not* self-verifying; they just provide helpful coverage,\nassurance, and working documentation.\n\n## Release checklist\n\n* Run: `poetry run black .`\n* Run: `poetry run isort .`\n* Run: `poetry run flake8 .`\n* Run: `poetry run mypy .`\n* Ensure \"tests\" run ok (see above).\n* Capture test output and commit with: `poetry run bash walkthrough_tests/all.sh 2>&1 | poetry run ansi2html -f 80% >WALKTHROUGH.html`\n* Create `requirements.txt` for Snyk scanning with: `poetry export -f requirements.txt >requirements.txt`\n* Ensure git tag, package version, and `encapsia_cli.__version__` are all equal.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Client CLI for talking to an Encapsia system.",
"version": "0.5.9",
"project_urls": {
"Homepage": "https://github.com/Encapsia/encapsia-cli"
},
"split_keywords": [
"encapsia",
" esource",
" edc",
" clinical trials"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cc9cc898dd156bb6d8e525b14773a665eddca829a06c50b7638dc9ba61b51b50",
"md5": "3c1e160f238bde71930fa10232eaa83f",
"sha256": "815a5e0861316de711ccaf6092ab381640ae880f95697c3054724f3dc4c585c3"
},
"downloads": -1,
"filename": "encapsia_cli-0.5.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c1e160f238bde71930fa10232eaa83f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 30679,
"upload_time": "2024-04-01T10:05:34",
"upload_time_iso_8601": "2024-04-01T10:05:34.782059Z",
"url": "https://files.pythonhosted.org/packages/cc/9c/c898dd156bb6d8e525b14773a665eddca829a06c50b7638dc9ba61b51b50/encapsia_cli-0.5.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6a74ab1a3d8604d4c7db255e01a55ec5bca3809cbc71798a54880af24dcbf79b",
"md5": "a41946a4c4fcf7ecf4d92dfc001139f4",
"sha256": "21b73cd341ce2a91b139b7c10f1e36b28491700f7d9abceb6604e710220e19fb"
},
"downloads": -1,
"filename": "encapsia_cli-0.5.9.tar.gz",
"has_sig": false,
"md5_digest": "a41946a4c4fcf7ecf4d92dfc001139f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 25612,
"upload_time": "2024-04-01T10:05:36",
"upload_time_iso_8601": "2024-04-01T10:05:36.723567Z",
"url": "https://files.pythonhosted.org/packages/6a/74/ab1a3d8604d4c7db255e01a55ec5bca3809cbc71798a54880af24dcbf79b/encapsia_cli-0.5.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 10:05:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Encapsia",
"github_project": "encapsia-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "encapsia-cli"
}
JSON
