Metadata-Version: 2.3
Name: zeropython
Version: 0.1.0
Summary: Zero Python, a Python library for educational purpose.
Project-URL: Bug Tracker, https://lab.frogg.it/dorianturba/zero-python/-/issues
Project-URL: Homepage, https://lab.frogg.it/dorianturba/zero-python
Author-email: Dorian Turba <zeropython.pip.w1nid@8shield.net>
License: MIT License
        
        Copyright (c) 2023 Dorian Turba
        
        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.
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Requires-Python: >=3.8
Requires-Dist: typer[all]
Provides-Extra: dev
Requires-Dist: bump-my-version; extra == 'dev'
Requires-Dist: pip-tools; extra == 'dev'
Provides-Extra: quality
Requires-Dist: toml-sort; extra == 'quality'
Description-Content-Type: text/markdown

# ZeroPython

## Setup

### Install

```bash
pip install zeropython
```

## Dev

This configuration include everything needed to develop and test and check quality of the project.

### Setup

```bash
pip install -e .[ALL]
pre-commit install
pre-commit autoupdate
```

### Run quality checks manually

If you want to run pre-commit checks manually, you can run:

```bash
pre-commit run --all-files
```

## Tests

### Setup

> ⚠️ You can pass this step if you have installed the dev environment `[DEV]`.

Setup your environment for tests:

```bash
pip install -e .[TEST]
```

### Run tests

```bash
pytest -v --strict-markers
```

## Share package

### Setup

Make sure you have installed build requirements:

```bash
python -m pip install --upgrade pip
pip install -r build_requirements.txt
```

### Build package

To release a new version of the package, you can run:

```bash
python -m build
```

Find package in `dist/` folder.
