Metadata-Version: 2.1
Name: katalytic-images
Version: 0.4.1
Summary: This plugin adds utilities for working with images and videos to the katalytic namespace
Author-email: Valentin Neagu <vali19th@protonmail.com>
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Image Processing
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Dist: katalytic-data>=0.8.0
Requires-Dist: katalytic-files>=0.3.0
Requires-Dist: katalytic-pkg>=0.2.0
Requires-Dist: numpy>=1.14
Requires-Dist: opencv-python>=4.0.0
Requires-Dist: pillow>=8.4.0
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: pytest-cov ; extra == "dev"
Requires-Dist: pytest-clarity ; extra == "dev"
Requires-Dist: pytest-randomly ; extra == "dev"
Project-URL: homepage, https://gitlab.com/katalytic/katalytic-images.git
Project-URL: repository, https://gitlab.com/katalytic/katalytic-images.git
Provides-Extra: dev

# Not fit for public use yet
- I will probably introduce backwards incompatible changes

## Description
TODO: Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

[![version](https://img.shields.io/pypi/v/katalytic-images)](https://pypi.org/project/katalytic-images/)
[![tests](https://gitlab.com/katalytic/katalytic-images/badges/main/pipeline.svg?key_text=tests&key_width=38)](https://gitlab.com/katalytic/katalytic-images/-/commits/main)
[![coverage](https://gitlab.com/katalytic/katalytic-images/badges/main/coverage.svg)](https://gitlab.com/katalytic/katalytic-images/-/commits/main)
[![docs](https://img.shields.io/readthedocs/katalytic-images.svg)](https://katalytic-images.readthedocs.io/en/latest/)
[![license: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Installation
By itself
```bash
pip install katalytic-images
```

As part of the [katalytic](https://gitlab.com/katalytic/katalytic) collection
```bash
pip install katalytic
```

## Usage
TODO: Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

## Roadmap
- make pillow an optional dependency.
	- setup_load_image() should pick opencv if pillow is not available
- drawing on images with a declarative interface
- image thresholding and masking operations
- interactive data exploration widgets (maybe as part of another package)
- higher level API on top of opencv

## Contributing
Contributions can be made in a number of ways:
- Propose architectural or API improvements
- Propose new features
- Propose packaging, building, or deployment improvements
- Report and fix bugs
	- you can also submit an xfail test
- Submit code and tests
- Tell me what I'm doing wrong or when I'm not following best practices
- Update the documentation

