Metadata-Version: 2.1
Name: rescalehtc
Version: 1.0.4
Summary:  Rescale Control Helpers Package
Author-email: Christian Grovdal <christian.grovdal@arm.com>, Eivind Holsen <eivind.holsen@arm.com>, Bartosz Dobrzelecki <bdobrzelecki@rescale.com>
Project-URL: Homepage, https://rescale.com/platform/hpc-as-a-service/high-throughput-computing/
Project-URL: Documentation, https://rescale-htc-python.readthedocs.io/
Project-URL: Bug Tracker, https://github.com/rescale-labs/rescale-htc-python/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# rescalehtc: A Python module 

This library contains convenient methods for dealing with Rescale HTC, for batch
container running in the cloud.

## Installation

Installation can be done via PyPi: https://pypi.org/project/rescalehtc

```
> pip3 install rescalehtc
```

## Documentation

Documentation is available at: https://rescale-htc-python.readthedocs.io/en/latest/ 

# Developers

## Building

To build the module execute the following:

```
> pip3 install build
> python3 -m build --wheel
```

The resulting wheel file (saved in the `dist/` directory) and be installed in
the environment of your project with.

```
> pip3 install rescalehtc-%VERSION%-py3-none-any.whl
```

## Documentation rendering

Documentation source is located in the `docs/` folder, and inline in the Python
code. To build the documentation, execute the following (assuming the `make`
tool is available):

```
> pip3 install ".[dev]" 
> cd docs/
> make html
```

Then open `docs\_build\html\index.html` with your web browser.
