# Democritus Regexes
[](https://pypi.python.org/pypi/d8s-regexes)
[](https://github.com/democritus-project/d8s-regexes/actions)
[](https://github.com/democritus-project/d8s-regexes/actions)
[](https://codecov.io/gh/democritus-project/d8s-regexes)
[](https://semver.org/spec/v2.0.0.html)
[](https://github.com/psf/black)
[](https://choosealicense.com/licenses/lgpl-3.0/)
Democritus functions<sup>[1]</sup> for working with and using regexes.
[1] Democritus functions are <i>simple, effective, modular, well-tested, and well-documented</i> Python functions.
We use `d8s` (pronounced "dee-eights") as an abbreviation for `democritus` (you can read more about this [here](https://github.com/democritus-project/roadmap#what-is-d8s)).
## Installation
```
pip install d8s-regexes
```
## Usage
You import the library like:
```python
from d8s_regexes import *
```
Once imported, you can use any of the functions listed below.
## Functions
- ```python
def is_regex(possible_regex: str) -> bool:
"""Determine whether or not the possible_regex is a valid regex."""
```
- ```python
def regex_closest_match(regex: str, string: str) -> str:
"""Find the longest version of regex that matches something in string."""
```
- ```python
def regex_simplify(regex: str, *, consolidation_threshold: int = 5) -> str:
"""Clean and simplify a regex to a more efficient form."""
```
- ```python
def regex_create(inputs: List[str], *, simplify_regex: bool = True, consolidation_threshold: int = 5) -> str:
"""Create a regex that matches all of the inputs."""
```
## Development
👋 If you want to get involved in this project, we have some short, helpful guides below:
- [contribute to this project 🥇][contributing]
- [test it 🧪][local-dev]
- [lint it 🧹][local-dev]
- [explore it 🔭][local-dev]
If you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.
## Credits
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and Floyd Hightower's [Python project template](https://github.com/fhightower-templates/python-project-template).
[contributing]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#contributing-a-pr-
[local-dev]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#local-development-
