# 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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ImprolabFIT/improutils_package",
"name": "improutils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "ImproLab",
"author_email": "improlab@fit.cvut.cz",
"download_url": "https://files.pythonhosted.org/packages/83/0c/20b305648e8ef3326fc24a58186230c770e568b6b78b9bba06285e6780ec/improutils-1.2.0.tar.gz",
"platform": null,
"description": "# Improutils\nThis 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).\n\n## Deploy a new version\nThis repository uses GitLab CI/CD Pipelines to deploy improutils package either to production or test PyPI.\n\n### Deploy to production PyPI\n - Update version.py file with a new version number with respect to [semantic versioning rules](https://semver.org/)\n - Commit your local changes\n\t - ```git commit -m \"Add awesome AI feature\" ```\n - Create a tagged version based on version.py\n\t - ```git tag -a $(python3 setup.py --version)```\n - Push tag to origin\n\t - ```git push --tags```\n - Wait for the package to be deployed and then check new version at [PyPI](https://pypi.org/project/improutils/)\n\n### Deploy to test PyPI\nAlmost same as above, but the **push tag step** must be skipped. Testing version is available at [test PyPI](https://test.pypi.org/project/improutils/).\n\n## Tests\nYou must run the tests from the `improutils_package` directory.\nAn example command for running the test may be as follows:\n```\npython tests\\test_preprocessing.py\n```\n\n> Note: running the test from the `tests` directory itself will result in errors\n\n## Documentation\nThis project uses Sphinx for documentation. The documentation is available on [Read the Docs](https://improutils.readthedocs.io/en/master/).\n\nBuilding documentation locally\n```bash\npip install sphinx sphinx_rtd_theme\ncd docs\nmake html\n```\n\nBrowsing the documentation locally:\n```bash\npython3 -m http.server -d docs/html\n```\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Package with useful functions for BI-SVZ coursework",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/ImprolabFIT/improutils_package"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "830c20b305648e8ef3326fc24a58186230c770e568b6b78b9bba06285e6780ec",
"md5": "dddd68ee898d37af9678617f2a80dd0d",
"sha256": "21c137a0387cf8bad22e51e1a67f187615b0893fdb776c4f145283ef02e096f3"
},
"downloads": -1,
"filename": "improutils-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "dddd68ee898d37af9678617f2a80dd0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21698,
"upload_time": "2024-08-31T21:02:47",
"upload_time_iso_8601": "2024-08-31T21:02:47.022610Z",
"url": "https://files.pythonhosted.org/packages/83/0c/20b305648e8ef3326fc24a58186230c770e568b6b78b9bba06285e6780ec/improutils-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-31 21:02:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ImprolabFIT",
"github_project": "improutils_package",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "improutils"
}
JSON
