wymple8 0.4.1
boilerplate you need to create a Python package.
License: MIT
Requires Python: >=3.8
Keywords: utility

# wymple8

> Short blurb about what your product does.

[![PyPI](https://img.shields.io/pypi/v/wymple8.svg)][pypi status]
[![Status](https://img.shields.io/pypi/status/wymple8.svg)][pypi status]
[![Python Version](https://img.shields.io/pypi/pyversions/wymple8)][pypi status]
[![tests](https://github.com/Stephen-RA-King/wymple8/actions/workflows/tests.yml/badge.svg)](https://github.com/Stephen-RA-King/wymple8/actions/workflows/tests.yml)
[![Codecov](https://codecov.io/gh/Stephen-RA-King/wymple8/branch/main/graph/badge.svg)][codecov]
[![readthedocs][readthedocs-image]][readthedocs-url]
[![pre-commit][pre-commit-image]][pre-commit-url]
[![Imports: isort][isort-image]][isort-url]
[![Code style: black][black-image]][black-url]
[![Checked with mypy][mypy-image]][mypy-url]
[![security: bandit][bandit-image]][bandit-url]
[![Commitizen friendly][commitizen-image]][commitizen-url]
[![License](https://img.shields.io/pypi/l/wymple8)][license]

One to two paragraph statement about your product and what it does.

![](assets/header.png)

## Installation

OS X & Linux:

```sh
pip3 install wymple8
```

Windows:

```sh
pip install wymple8
```

## Usage example

A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.

_For more examples and usage, please refer to the [Wiki][wiki]._

## Development setup

Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.

```sh
pip install --editable wymple8
```

## Documentation

[**Read the Docs**](https://wymple8.readthedocs.io/en/latest/)

## Meta

[![](assets/linkedin.png)](https://linkedin.com/in/stephen-k-3a4644210)
[![](assets/github.png)](https://github.com/Stephen-RA-King)
[![](assets/pypi.png)](https://pypi.org/project/wymple8/)
[![](assets/www.png)](https://www.Stephen-RA-King)
[![](assets/email.png)](mailto:stephen.ra.king@gmail.com)

Stephen R A King : stephen.ra.king@gmail.com

Distributed under the MIT License. See `LICENSE` for more information.

[https://github.com/Stephen-RA-King/wymple8](https://github.com/Stephen-RA-King/wymple8)

<!-- Markdown link & img dfn's -->

[pypi status]: https://pypi.org/project/wymple8/
[codecov]: https://app.codecov.io/gh/Stephen-RA-King/wymple8
[license]: https://github.com/Stephen-RA-King/wymple8/blob/main/LICENSE
[commitizen-image]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]: http://commitizen.github.io/cz-cli/
[readthedocs-image]: https://readthedocs.org/projects/wymple8/badge/?version=latest
[readthedocs-url]: https://wymple8.readthedocs.io/en/latest/?badge=latest
[pre-commit-image]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
[pre-commit-url]: https://github.com/pre-commit/pre-commit
[isort-image]: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
[isort-url]: https://pycqa.github.io/isort/
[black-image]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-url]: https://github.com/psf/black
[bandit-image]: https://img.shields.io/badge/security-bandit-yellow.svg
[bandit-url]: https://github.com/PyCQA/bandit
[mypy-image]: http://www.mypy-lang.org/static/mypy_badge.svg
[mypy-url]: http://mypy-lang.org/
[mit-license-image]: https://img.shields.io/badge/license-MIT-blue
[mit-license-url]: https://choosealicense.com/licenses/mit/
[wiki]: https://github.com/Stephen-RA-King/wymple8/wiki