Metadata-Version: 2.1
Name: strlib
Version: 0.0.0
Summary: Collection of utility functions for modifying strings
Home-page: https://github.com/GH-Syn/strlib
Author: Joshua Rose and individual contributors
Author-email: joshuarose099@gmail.com
Project-URL: Source, https://github.com/GH-Syn/strlib
Project-URL: Documentation, https://gh-syn.github.io/strlib/
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

<div align="center">
  <h1><code>strlib</code></h1>
  <b>Eliminate boilerplate. Enhance efficiency.</b>
  <br><br>
  <p>
    <a href="https://codecov.io/gh/GH-Syn/strlib"><img src="https://img.shields.io/codecov/c/github/GH-Syn/strlib?color=ee8695&label=coverage&style=for-the-badge"></img></a> 
    <img alt="GitHub contributors" src="https://img.shields.io/github/contributors-anon/GH-Syn/strlib?color=ffa49a&style=for-the-badge">
    <img alt="GitHub issues" src="https://img.shields.io/github/issues-raw/GH-Syn/strlib?color=f35e79&label=issues&style=for-the-badge">
  </p>
</div>



## Description
`strlib` is a Python library that provides mutative functionality for strings. It's purpose is to provide an alternative to existing libaries such as `re` through a comprehensive set of functions.
The documentation for `strlib` is generated using Sphinx.

## Rationale
This inspiration / purpose for creating this library was because in pre-refactor stage of creating `urban`, I found making a plethora of utility functoins quite difficult to navigate and document.
This library hopes to mitigate the utility overhead through modularized formatting utility functions.

## FAQ
 - [**How is this different from `re`?**](https://gh-syn.github.io/strlib/faq.html#how-is-this-library-different-from-re)
 - [**What benefit does this library give?**](https://gh-syn.github.io/strlib/faq.html#what-benefit-does-this-library-give)
 - [**Does this library even work?**](https://gh-syn.github.io/strlib/faq.html#does-this-library-even-work)

## Contributions
Contributions are always welcome.

## Documentation
The documentation for this project is generated with [Sphinx](https://www.sphinx-doc.org/), built with this [workflow](https://github.com/GH-Syn/strlib/blob/master/.github/workflows/sphinx.yml), and deployed with [Github Pages](https://pages.github.com/). 

## License
This library falls under the MIT license.

<h2></h2>
<div align="center">
  <a href="https://gh-syn.github.io/strlib/">Documentation</a>  |  
  <a href="https://stats.uptimerobot.com/jWk6BflM5J">Uptime</a> | 
  <a href="https://github.com/GH-Syn/strlib/releases/latest">Tags</a>
</div>
