semvec/pypi-packages huggingface dataset:
improutils 1.2.1
Package with useful functions for BI-SVZ coursework
Requires Python: >=3.10

# Improutils
This repository contains Python library with useful helper functions for Machine vision and Image processing (BI-SVZ) coursework taught at [FIT CTU](https://fit.cvut.cz/en). For more details, see [main course page](https://github.com/ImprolabFIT/BI-SVZ-coursework).

## Deploy a new version
This repository uses GitLab CI/CD Pipelines to deploy improutils package either to production or test PyPI.

### Deploy to production PyPI
 - Update version.py file with a new version number with respect to [semantic versioning rules](https://semver.org/)
 - Commit your local changes
	 - ```git commit -m "Add awesome AI feature" ```
 - Create a tagged version based on version.py
	 - ```git tag -a $(python3 setup.py --version)```
 - Push tag to origin
	 - ```git push --tags```
 - Wait for the package to be deployed and then check new version at [PyPI](https://pypi.org/project/improutils/)

### Deploy to test PyPI
Almost same as above, but the **push tag step** must be skipped. Testing version is available at [test PyPI](https://test.pypi.org/project/improutils/).

## Tests
You must run the tests from the `improutils_package` directory.
An example command for running the test may be as follows:
```
python tests\test_preprocessing.py
```

> Note: running the test from the `tests` directory itself will result in errors

## Documentation
This project uses Sphinx for documentation. The documentation is available on [Read the Docs](https://improutils.readthedocs.io/en/master/).

Building documentation locally
```bash
pip install sphinx sphinx_rtd_theme
cd docs
make html
```

Browsing the documentation locally:
```bash
python3 -m http.server -d docs/html
```