| Name | iccore JSON |
| Version |
0.1.8
JSON |
| download |
| home_page | None |
| Summary | A collection of common data structures and utilities used in other ICHEC tools |
| upload_time | 2024-12-06 14:03:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
hpc
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# iccore
This package is part of the [Common Tooling Project](https://ichec-handbook.readthedocs.io/en/latest/src/common_tools.html) at the [Irish Centre for High End Computing](https://www.ichec.ie).
It is a collection of common data structures, data types and low-level utilities used in other ICHEC 'common tools'.
# Features #
The package consists of:
* `data structures` (list, strings, dicts etc.) and utilities for working with them
* tooling for interacting with `system resources`, such as external processes, the filesystem and network.
* basic `data types` for describing people, organizations, projects and code repositories - to support `process automation` and Open Science and FAIR activites.
# Usage #
## System Resources ##
### Filesystem ###
You can replace all occurences of a string with another recursively in files with:
``` shell
iccore filesystem replace_in_files --target $REPLACE_DIR --search $FILE_WITH_SEARCH_TERM --replace $FILE_WITH_REPLACE_TERM
```
The `search` and `replace` terms are read from files. This can be handy to avoid shell escape sequences - as might be needed in `sed`.
### Networking ###
You can download a file with:
``` shell
iccore network download --url $RESOURCE_URL --download_dir $WHERE_TO_PUT_DOWNLOAD
```
## Process Automation ##
### Project Management ###
You can get Gitlab Milestones given a project id and access token with:
``` shell
iccore gitlab --token $GITLAB_TOKEN milestone $PROJECT_ID
```
You can get the version number of the most recent project release with:
``` shell
iccore gitlab --token $GITLAB_TOKEN latest_release $PROJECT_ID
```
You can get info about a git repo with:
``` shell
iccore git info
```
run in the repo.
# Install #
It is available on PyPI:
``` sh
pip install iccore
```
# License #
This project is licensed under the GPLv3+. See the incluced `LICENSE.txt` file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "iccore",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "HPC",
"author": null,
"author_email": "\"James Grogan, Irish Centre for High End Computing\" <james.grogan@ichec.ie>",
"download_url": "https://files.pythonhosted.org/packages/36/d7/ca691f509e92ea4bae726c3896474868c7bba1f8d3b6fd2212343a2a2b49/iccore-0.1.8.tar.gz",
"platform": null,
"description": "# iccore\n\nThis package is part of the [Common Tooling Project](https://ichec-handbook.readthedocs.io/en/latest/src/common_tools.html) at the [Irish Centre for High End Computing](https://www.ichec.ie).\n\nIt is a collection of common data structures, data types and low-level utilities used in other ICHEC 'common tools'.\n\n# Features #\n\nThe package consists of:\n\n* `data structures` (list, strings, dicts etc.) and utilities for working with them\n* tooling for interacting with `system resources`, such as external processes, the filesystem and network.\n* basic `data types` for describing people, organizations, projects and code repositories - to support `process automation` and Open Science and FAIR activites. \n\n# Usage #\n\n## System Resources ##\n\n### Filesystem ###\n\nYou can replace all occurences of a string with another recursively in files with:\n\n``` shell\niccore filesystem replace_in_files --target $REPLACE_DIR --search $FILE_WITH_SEARCH_TERM --replace $FILE_WITH_REPLACE_TERM \n```\n\nThe `search` and `replace` terms are read from files. This can be handy to avoid shell escape sequences - as might be needed in `sed`.\n\n### Networking ###\n\nYou can download a file with:\n\n``` shell\niccore network download --url $RESOURCE_URL --download_dir $WHERE_TO_PUT_DOWNLOAD\n```\n\n## Process Automation ##\n\n### Project Management ###\n\nYou can get Gitlab Milestones given a project id and access token with:\n\n``` shell\niccore gitlab --token $GITLAB_TOKEN milestone $PROJECT_ID\n```\n\nYou can get the version number of the most recent project release with:\n\n``` shell\niccore gitlab --token $GITLAB_TOKEN latest_release $PROJECT_ID\n```\n\nYou can get info about a git repo with:\n\n``` shell\niccore git info \n```\n\nrun in the repo.\n\n# Install #\n\nIt is available on PyPI:\n\n``` sh\npip install iccore\n```\n\n# License #\n\nThis project is licensed under the GPLv3+. See the incluced `LICENSE.txt` file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A collection of common data structures and utilities used in other ICHEC tools",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://git.ichec.ie/performance/toolshed/iccore",
"Repository": "https://git.ichec.ie/performance/toolshed/iccore"
},
"split_keywords": [
"hpc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3f6f16235d9b888caac37a7ec29951c81a9646ee9afc974e445a5a80d9c53734",
"md5": "93a2317fc0f5e6f5ebb1446bac4399f6",
"sha256": "ce90139837d2404940016e5170b99e77aff5309d321ea7260d48490b90c6ae2d"
},
"downloads": -1,
"filename": "iccore-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93a2317fc0f5e6f5ebb1446bac4399f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 36312,
"upload_time": "2024-12-06T14:03:07",
"upload_time_iso_8601": "2024-12-06T14:03:07.719773Z",
"url": "https://files.pythonhosted.org/packages/3f/6f/16235d9b888caac37a7ec29951c81a9646ee9afc974e445a5a80d9c53734/iccore-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "36d7ca691f509e92ea4bae726c3896474868c7bba1f8d3b6fd2212343a2a2b49",
"md5": "408807a911ee721a6c3314e291914d08",
"sha256": "4991f9229c757a2cf88deb22723d0f0e73b818822816d70518d3048f946d9341"
},
"downloads": -1,
"filename": "iccore-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "408807a911ee721a6c3314e291914d08",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 33178,
"upload_time": "2024-12-06T14:03:08",
"upload_time_iso_8601": "2024-12-06T14:03:08.839837Z",
"url": "https://files.pythonhosted.org/packages/36/d7/ca691f509e92ea4bae726c3896474868c7bba1f8d3b6fd2212343a2a2b49/iccore-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 14:03:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "iccore"
}
