# About
[](https://github.com/pre-commit/pre-commit)
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`
* Ensure git tag and package version are 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.1",
"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/c5/d8/d0f4af88ee91b0163271110aaefcd2a11b6cb226115c1b8cb685240164de/encapsia_cli-0.5.12.tar.gz",
"platform": null,
"description": "# About\n\n\n\n[](https://github.com/pre-commit/pre-commit)\n\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* Ensure git tag and package version are equal.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Client CLI for talking to an Encapsia system.",
"version": "0.5.12",
"project_urls": {
"Homepage": "https://github.com/Encapsia/encapsia-cli"
},
"split_keywords": [
"encapsia",
" esource",
" edc",
" clinical trials"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd18e51ad46c49ddd3769203dd14561451b1b884c6a7afa2ef381245d25f9887",
"md5": "92bb878d27f882c66ed0d5ca03a72577",
"sha256": "95c815fd7432262ffe26dfdf748a26449b036c0b130b198bd18f9ed44befa24e"
},
"downloads": -1,
"filename": "encapsia_cli-0.5.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "92bb878d27f882c66ed0d5ca03a72577",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 30778,
"upload_time": "2024-09-09T11:58:40",
"upload_time_iso_8601": "2024-09-09T11:58:40.413031Z",
"url": "https://files.pythonhosted.org/packages/dd/18/e51ad46c49ddd3769203dd14561451b1b884c6a7afa2ef381245d25f9887/encapsia_cli-0.5.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c5d8d0f4af88ee91b0163271110aaefcd2a11b6cb226115c1b8cb685240164de",
"md5": "07f9ed0108e7029c22956ec344c7a0be",
"sha256": "bdcae603bace38700f9cd97efed16269c6427c525ba83376c4520f02cf48604b"
},
"downloads": -1,
"filename": "encapsia_cli-0.5.12.tar.gz",
"has_sig": false,
"md5_digest": "07f9ed0108e7029c22956ec344c7a0be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 25772,
"upload_time": "2024-09-09T11:58:42",
"upload_time_iso_8601": "2024-09-09T11:58:42.253738Z",
"url": "https://files.pythonhosted.org/packages/c5/d8/d0f4af88ee91b0163271110aaefcd2a11b6cb226115c1b8cb685240164de/encapsia_cli-0.5.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-09 11:58:42",
"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
