Metadata-Version: 2.1
Name: iccore
Version: 0.0.7
Summary: A collection of common data structures and utilities used in other ICHEC tools
Author-email: "James Grogan, Irish Centre for High End Computing" <james.grogan@ichec.ie>
Project-URL: Repository, https://git.ichec.ie/performance/toolshed/iccore
Project-URL: Homepage, https://git.ichec.ie/performance/toolshed/iccore
Keywords: HPC
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Distributed Computing
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: PyYAML
Requires-Dist: types-PyYAML
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-sugar; extra == "test"
Requires-Dist: black; extra == "test"
Requires-Dist: mypy; extra == "test"

# iccore

This project has a collection of common data structures and utilities used in other ICHEC tools.

# Install  #

It is available on PyPI:

``` sh
pip install iccore
```

# Features #

The idea of this project is to provide some common, tested and 'production focused' utilities for use in other ICHEC projects.

Here 'production focused' means that features like 'dry run', logging and secure defaults are included.

This is done by wrapping basic Python utilities that interact with system resources, for example:

* external processes
* the filesystem
* network 

with stubs that can be mocked for tests or executed in 'dry run' mode.

By using the `filesystem`, `process` and `network` utils provided here instead of the low-level Python libraries directly you get to benefit from these extra features and help to standarize our tooling.

## CLI ##

A basic CLI is included, mostly for testing, but it may be useful for getting ideas on what features the package can be used to support.

### Getting Gitlab Milestones ###

This is an example of using the CLI to get Gitlab Milestones given a project id and access token.

``` shell
iccore gitlab --token $GITLAB_TOKEN milestone $PROJECT_ID
```


# License #

This project is licensed under the GPLv3+. See the incluced `LICENSE.txt` file for details.
