Metadata-Version: 2.1
Name: py-models-by-sporniket
Version: 1.0.0
Summary: A collection of basic data models in python
Keywords: python,data models,interval,rooted tree
Author-Email: Sporniket <sporniket.studio@gmail.com>
License: GPL-3.0-or-later
Project-URL: homepage, https://github.com/sporniket/py-models
Project-URL: repository, https://github.com/sporniket/py-models
Project-URL: bug-tracker, https://github.com/sporniket/py-models/issues
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# py-models-by-sporniket -- A collection of basic data models in python

![PyPI - Version](https://img.shields.io/pypi/v/py-models-by-sporniket)
![PyPI - License](https://img.shields.io/pypi/l/py-models-by-sporniket)


> [WARNING] Please read carefully this note before using this project. It contains important facts.

Content

1. What is **py-models-by-sporniket -- A collection of basic data models in python**, and when to use it ?
2. What should you know before using **py-models-by-sporniket -- A collection of basic data models in python** ?
3. How to use **py-models-by-sporniket -- A collection of basic data models in python** ?
4. Known issues
5. Miscellanous

## 1. What is **py-models-by-sporniket -- A collection of basic data models in python**, and when to use it ?

**py-models-by-sporniket -- A collection of basic data models in python** includes the following data models :

* Interval
* Rooted tree

### What's new in v1.0.0

Initial release.

### Licence

 **py-models-by-sporniket -- A collection of basic data models in python** is free software: you can redistribute it and/or modify it under the terms of the
 GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your
 option) any later version.

 **py-models-by-sporniket -- A collection of basic data models in python** is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 more details.

 You should have received a copy of the GNU General Public License along with **py-models-by-sporniket -- A collection of basic data models in python**.
 If not, see http://www.gnu.org/licenses/ .


## 2. What should you know before using **py-models-by-sporniket -- A collection of basic data models in python** ?

**py-models-by-sporniket -- A collection of basic data models in python** is written in [Python](http://python.org) language

> Do not use **py-models-by-sporniket -- A collection of basic data models in python** if this project is not suitable for your project

## 3. How to use **py-models-by-sporniket -- A collection of basic data models in python** ?

### Requirements

* Python 3.9 or later versions.
* Required command : `pipx`, see [pipx homepage](https://pipx.pypa.io/stable/).
* Required python dependency manager `pdm` : `pipx install pdm`.

### From source

To get the latest available code, one must clone the git repository, build and install to the maven local repository.

	git clone https://github.com/sporniket/py-models.git
	cd py-models
	pdm build
  pipx install dist/py-models_by_sporniket-<version>-py3-none-any.whl

### From Pypi
Add any of the following dependencies that are appropriate to your project.

```
pipx install py-models_by_sporniket
```


## 4. Known issues
See the [project issues](https://github.com/sporniket/py-models/issues) page.

## 5. Miscellanous

### Report issues
Use the [project issues](https://github.com/sporniket/py-models/issues) page.
