pydatasets 0.1.1
Dataset classes for use on Image-based Machine Learning
License: MIT
Keywords: machine learning,dataset

# pydatasets

Dataset classes for use on Image-based Machine Learning.

[![Build Tests](https://img.shields.io/github/workflow/status/rlaPHOENiX/pydatasets/Version%20test?label=Python%203.5%2B%20builds)](https://github.com/rlaPHOENiX/pydatasets/actions?query=workflow%3A%22Version+test%22)
[![License](https://img.shields.io/github/license/rlaPHOENiX/pydatasets?style=flat)](https://github.com/rlaPHOENiX/pydatasets/blob/master/LICENSE)
[![DeepSource](https://deepsource.io/gh/rlaPHOENiX/pydatasets.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/rlaPHOENiX/pydatasets/?ref=repository-badge)
[![Issues](https://img.shields.io/github/issues/rlaPHOENiX/pydatasets?style=flat)](https://github.com/rlaPHOENiX/pydatasets/issues)
[![PR's Accepted](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://makeapullrequest.com)

* * *

## Not yet ready for prime time use

This project is still under very early stages, and I don't recommend using it for now.

* * *

## Quick Installation

    pip install pydatasets

* * *

## Building

This project is firmly requiring the use of Python PIP with [PEP 517][pep517] support. This means you need `pip >= 19`
[(ref)][pip19].

Considering version `19.0` released on the 22nd of January 2019, it isn't much of an ask in my opinion, when you end up
with an overall much smoother build experience.

Once you have pip with PEP 517 support, it's as simple as 3 calls:

    pip install build
    git clone https://github.com/rlaPHOENiX/pydatasets && cd pydatasets
    python -m build

To install the built project, install the .whl file available in /dist, e.g. `pip install dist/*.whl`

If you want to simply install from the source, instead of `python -m build` run `pip install .`

[pep517]: https://www.python.org/dev/peps/pep-0517

[pip19]: https://pip.pypa.io/en/stable/news/#id415

* * *

## License

This project is released under the MIT license.
Please read and agree to the license before use, it can be found in the [LICENSE](LICENSE) file.

MIT License

Copyright (c) 2021 PHOENiX

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.