Metadata-Version: 2.1
Name: izmiran
Version: 0.1.2
Summary: IZMIRAN module for common tasks
Author-email: Danil Borchevkin <danil.borchevkin@gmail.com>
License: BSD 2-Clause License
        
        Copyright (c) 2024, Danil Borchevkin
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Project Name

## Description

IZMIRAN library for common tasks.

## Documents

No additional documents are provided.

## Software Requirements

* Python 3.7+
* make

## Dependencies

* pytest
* yapf
* bandit

## Usage and installation

```bash
$ pip install izmiran
```

***API is liquid due to development process. Use exact versioning!***

## Developing Process

* Used feature-flow for developing

## Release Process

### Release Process - Step 1 - Verify and validate codebase

Run:

```bash
make all_release
```

### Release Process - Step 2 - Update version

Go to [pyproject.toml](./pyproject.toml) and [setup.py](./setup.py) and update `version`.


### Release Process - Step 3 - Update CHANGELOG.md

Go to [CHANGELOG.md](./CHANGELOG.md) and update it.

### Release Process - Step 4 - Check installation of target

```bash
$ make install
```

### Release Process - Step 5 - Update package on PyPI

```bash
make publish
```
