Metadata-Version: 2.4
Name: x4util
Version: 0.2.0
Summary: exfor utility codes
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Requires-Dist: pylatexenc
Requires-Dist: pyspellchecker
Requires-Dist: requests
Description-Content-Type: text/markdown

# x4util

This repository contains a version controlled and updated copy of the NRDC [x4util code](https://nds.iaea.org/nrdc/nrdc_sft/) and supplementary codes.

**Table of Contents**

- [Installation](#installation)
- [License](#license)

## Installation

### ... latest release

```console
pip install x4util
```

### ... development version

this requires python, pip and git to be installed on the system

```console
pip install git+https://git.oecd-nea.org/exfor/tools/x4util.git
```

## Contribute

To contribute to the project, clone the repository, implement changes and propose to include them via a Merge Request.
Test are managed using hatch. To run test locally use `hatch test`.

## License

`x4util` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

## Developer notes

This package is developed and managed using [hatch](https://hatch.pypa.io/latest).

Releases are managed by gitlab pipelines triggered by version tags. To include a commit in the changelog of a release use the `Changelog: <added/changed/removed>` [pattern as commit trailer](https://about.gitlab.com/blog/2023/11/01/tutorial-automated-release-and-release-notes-with-gitlab/).
