strutils 0.1.1
Python Compound String Utilities
License: MIT
Requires Python: >=3.8,<4.0
Keywords: python-3,compound-strings,library,tools

strutils
========

|PyPI| |Python Version| |License| |Status|

|Stable Release| |Develop Release|

|Read the Docs| |Tests| |Safety| |Pylinting| |Flake8 Linting| |Pre-Commit|

|Codecov| |Codacy| |Codeclimate| |Scrutinizer|

|pre-commit| |Black| |Pylint| |Flake8|

.. |PyPI| image:: https://img.shields.io/pypi/v/strutils.svg
   :target: https://pypi.org/project/strutils/
   :alt: PyPI

.. |Python Version| image:: https://img.shields.io/pypi/pyversions/strutils
   :target: https://pypi.org/project/strutils
   :alt: Python Version

.. |License| image:: https://img.shields.io/pypi/l/strutils
   :target: https://opensource.org/licenses/MIT
   :alt: License

.. |Status| image:: https://badgen.net/badge/status/alpha/d8624d
   :target: https://pypi.org/project/strutils/
   :alt: Status

.. |Stable Release| image:: https://github.com/tZ3ma/strutils/workflows/Stable-PyPI-Release/badge.svg
   :target: https://github.com/tZ3ma/strutils/actions?workflow=Stable-PyPI-Release
   :alt: Stable PyPI Release Workflow Status

.. |Develop Release| image:: https://github.com/tZ3ma/strutils/workflows/Develop-TestPyPI-Release/badge.svg
   :target: https://github.com/tZ3ma/strutils/actions?workflow=Develop-TestPyPI-Release
   :alt: Develop TestPyPI Release Workflow Status

.. |Read the Docs| image:: https://img.shields.io/readthedocs/strutils/latest.svg?label=Read%20the%20Docs
   :target: https://strutils.readthedocs.io/
   :alt: Read the documentation at https://strutils.readthedocs.io/

.. |Tests| image:: https://github.com/tZ3ma/strutils/workflows/Tests-and-Coverage/badge.svg
   :target: https://github.com/tZ3ma/strutils/actions?workflow=Tests-and-Coverage
   :alt: Tests Workflow Status

.. |Safety| image:: https://github.com/tZ3ma/strutils/workflows/Safety/badge.svg
   :target: https://github.com/tZ3ma/strutils/actions?workflow=Safety
   :alt: Safety Workflow Status

.. |Pylinting| image:: https://github.com/tZ3ma/strutils/workflows/Pylinting/badge.svg
   :target: https://github.com/tZ3ma/strutils/actions?workflow=Pylinting
   :alt: Pylint Workflow Status

.. |Flake8 Linting| image:: https://github.com/tZ3ma/strutils/workflows/Flake8-Linting/badge.svg
   :target: https://github.com/tZ3ma/strutils/actions?workflow=Flake8-Linting
   :alt: Flake8-Linting Workflow Status

.. |Pre-Commit| image:: https://github.com/tZ3ma/strutils/workflows/Pre-Commit/badge.svg
   :target: https://github.com/tZ3ma/strutils/actions?workflow=Pre-Commit
   :alt: Pre-Commit Workflow Status

.. |Codecov| image:: https://codecov.io/gh/tZ3ma/strutils/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/tZ3ma/strutils
   :alt: Codecov

.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/b278433bb9224147a2e6231d783b62e4
   :target: https://app.codacy.com/gh/tZ3ma/strutils/dashboard
   :alt: Codacy Code Quality Status

.. |Codeclimate| image:: https://api.codeclimate.com/v1/badges/ff119252f0bb7f40aecb/maintainability
   :target: https://codeclimate.com/github/tZ3ma/strutils/maintainability
   :alt: Maintainability

.. |Scrutinizer| image:: https://scrutinizer-ci.com/g/tZ3ma/strutils/badges/quality-score.png?b=main
   :target: https://scrutinizer-ci.com/g/tZ3ma/strutils/
   :alt: Scrutinizer Code Quality

.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit

.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Black

.. |Pylint| image:: https://img.shields.io/badge/linting-pylint-yellowgreen
   :target: https://github.com/PyCQA/pylint
   :alt: Package uses pylint

.. |Flake8| image:: https://img.shields.io/badge/linting-flake8-yellogreen
   :target: https://github.com/pycqa/flake8
   :alt: Package uses flake8


(compound) **STR**\ ing **UTIL**\ itie\ **S**\ . Rudimentary, outdated, everywhere
else found.

Installation
------------

Please see the `Installation Guide`_ (`Github Repo Link`_) for details.


Usage
-----

Please read the `API Documentation <API-Documentation_>`_ for usage and the
`Worklow Reference <Workflow-Guide_>`_ (`Github Repo Link`_) for taking full
advantage of this project foundation (Nox_ and Poetry_ usage in particular).


Contributing
------------

Contributions are very welcome.
To learn more, see the `Contributor Guide`_ (`Github Repo Link`_).


License
-------

Distributed under the terms of the `MIT license`_ (`Github Repo Link`_),
*strutils* is free and open source software.


Issues
------

If you encounter any problems,
please `file an issue`_ along with a detailed description.

Credits
-------

This project was created using the `Mathias Ammon <tZ3ma>`_ tweaked version of the
Hypermodern-Python_ project foundation proposed by `Claudio Jolowicz <cj>`_.

.. _Hypermodern-Python: https://cjolowicz.github.io/posts/hypermodern-python-01-setup/
.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _cj: https://github.com/cjolowicz

.. _MIT license: https://opensource.org/licenses/MIT
.. _PyPI: https://pypi.org/

.. _file an issue: https://github.com/tZ3ma/strutils/issues
.. _pip: https://pip.pypa.io/

.. _tZ3ma: https://github.com/tZ3ma
.. working on github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Installation Guide: docs/source/getting_started/installation.rst
.. _Workflow-Guide: docs/source/developer_guide/workflows.rst

.. _Github Repo Link: https://github.com/tZ3ma/strutils

.. _API-Documentation: https://strutils.readthedocs.io/en/latest/source/api/core.html
.. _Poetry: https://python-poetry.org/
.. _Nox: https://nox.thea.codes/