bewaarbot 0.1.3
Awesome `bewaarbot` is a Python cli/package created with https://github.com/TezRomacH/python-package-template
License: MIT
Requires Python: >=3.8,<4.0

# bewaarbot

<div align="center">

[![Build status](https://github.com/theanarchox/bewaarbot/workflows/build/badge.svg?branch=master&event=push)](https://github.com/theanarchox/bewaarbot/actions?query=workflow%3Abuild)
[![Python Version](https://img.shields.io/pypi/pyversions/bewaarbot.svg)](https://pypi.org/project/bewaarbot/)
[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/theanarchox/bewaarbot/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)
[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/theanarchox/bewaarbot/blob/master/.pre-commit-config.yaml)
[![Semantic Versions](https://img.shields.io/badge/%F0%9F%9A%80-semantic%20versions-informational.svg)](https://github.com/theanarchox/bewaarbot/releases)
[![License](https://img.shields.io/github/license/theanarchox/bewaarbot)](https://github.com/theanarchox/bewaarbot/blob/master/LICENSE)

Awesome `bewaarbot` is a Python cli/package created with https://github.com/TezRomacH/python-package-template

</div>

## Installation

```bash
pip install -U bewaarbot
```

or install with `Poetry`

```bash
poetry add bewaarbot
```

Then you can run

```bash
bewaarbot --help
```


or if installed with `Poetry`:

```bash
poetry run bewaarbot --help
```

## 📈 Releases

You can see the list of available releases on the [GitHub Releases](https://github.com/theanarchox/bewaarbot/releases) page.

We follow [Semantic Versions](https://semver.org/) specification.

We use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.

For Pull Request this labels are configured, by default:

|               **Label**               |  **Title in Releases**  |
| :-----------------------------------: | :---------------------: |
|       `enhancement`, `feature`        |       🚀 Features       |
| `bug`, `refactoring`, `bugfix`, `fix` | 🔧 Fixes & Refactoring  |
|       `build`, `ci`, `testing`        | 📦 Build System & CI/CD |
|              `breaking`               |   💥 Breaking Changes   |
|            `documentation`            |    📝 Documentation     |
|            `dependencies`             | ⬆️ Dependencies updates |

You can update it in [`release-drafter.yml`](https://github.com/theanarchox/bewaarbot/blob/master/.github/release-drafter.yml).

GitHub creates the `bug`, `enhancement`, and `documentation` labels for you. Dependabot creates the `dependencies` label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.

## 🛡 License

[![License](https://img.shields.io/github/license/theanarchox/bewaarbot)](https://github.com/theanarchox/bewaarbot/blob/master/LICENSE)

This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/theanarchox/bewaarbot/blob/master/LICENSE) for more details.

## 📃 Citation

```
@misc{bewaarbot,
  author = {TheAnarchoX},
  title = {Awesome `bewaarbot` is a Python cli/package created with https://github.com/TezRomacH/python-package-template},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/theanarchox/bewaarbot}}
}
```

## Credits

This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template).