Metadata-Version: 2.1
Name: rejex
Version: 0.0.1
Summary: Tool used to build regex expressions for python
Home-page: https://github.com/skandabhairava/Rejex
Author: Terroid
Author-email: skandabhairava@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/skandabhairava/Rejex/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Rejex

## Rejex is a tool used to build regex expressions for python.

A library which can help in building regex expressions which can be used with regex libraries(such as "re") to parse strings.
<hr>
<br>

## Changelogs

[Changelogs](https://github.com/skandabhairava/Rejex/blob/main/CHANGELOG.md)

<hr>
<br>

## Usage

```py
import rejex
from rejex import Rejex, Static

rejex_test = (
        Rejex()
            .zero_or_one(
                Rejex()
                    .literal("+")
                    .one_or_more(
                        Static.any_number()
                    )
                    .compile()
            )
            .zero_or_one(Static.literal(" "))
            .zero_or_one(Static.literal("("))
            .n_number_times(3, Static.any_number())
            .zero_or_one(Static.literal(")"))
            .zero_or_one(Static.literal(" "))
            .n_number_times(3, Static.any_number())
            .zero_or_one(Static.alternative(Static.literal("-"), Static.literal(" ")))
            .n_number_times(4, Static.any_number())
        .compile()
    )

rejex.test_regex(rejex_test, "+1 (123) 123 4567") #True
"""
-------------------------------
regex_pattern='(\+(\d)+)? ?(\()?(\d){3}(\))? ?(\d){3}((-| ))?(\d){4}'
string='+1 (123) 123 4567'
match=True
-------------------------------
"""
```
[Uses](https://github.com/skandabhairava/Rejex/blob/main/src/test.py)

<hr>
<br>

