Metadata-Version: 2.1
Name: simpex
Version: 1.0.2
Summary: `simpex` is a python library that simplifies the process of using regular expressions (regex).
Author: s41r4j
Maintainer: s41r4j
License: MIT License
        
        Copyright (c) 2023 S41R4J
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/s41r4j/simpex
Project-URL: Wiki, https://github.com/s41r4j/simpex/wiki
Project-URL: Bug Tracker, https://github.com/s41r4j/simpex/issues
Keywords: python,python3,regex,simpex,regular-expressions,s41r4j
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

<h1 align=center>simpex</h1>

`simpex` is a python library that simplifies the process of using regular expressions (`regex`). It provides custom, built-in and api-based methods to generate regex patterns, making it easier for developers to match and manipulate text data. Whether you're working with emails, URLs, phone numbers, or other patterns, `simpex` has you covered.

#### _Features_:

- Simplify regex usage in Python.
- Generate regex patterns effortlessly.
- Access external APIs for regex generation.
- Choose from custom or built-in patterns.

<br>

## Installation | [wiki](../../wiki/installation)

To install `simpex`, use the following command:

```bash
pip install simpex
```

<br>

## Usage | [wiki](../../wiki/usage)

There are three steps between you and regex pattern you want! Follow below instatructions as _quick guide_, please chak out _[wiki]()_ for comprehensive usage with examples.

### 1. Importing

- Use the following import statement:

```python
from simpex.simpex import simpex
```

### 2. Creating Object

- `simpex` is a class, so we need to __create an object__ with required parametric data (check [wiki](../../wiki/usage#custom-method), for all available parameters)

```python
# creating an onject named `email`
email = simpex(['test@mail.com', 'admin@email.com', 'example@mail.co'])
```

### 3. Calling Method

- Call your desired method from [`custom*`](../../wiki/usage#custom-method), [`built-in`](../../wiki/usage#built-in-method) or [`api-based`](../../wiki/usage#api-method) to get regex pattern (check [wiki](../../wiki/usage#methods), for all avaliable methods)

```python
# calling custom method
pattern = email.regex()
```

> output: `print(pattern)` -> `^[a-z]+\@[a-z]+\.[a-z]*$`

`<br><br>`

## License & Contributing

- This is an __open source project__, licensed under the [MIT License](LICENSE).
- _All contributions are welcome!_
  - To contribute to `simpex` project, fork the repository, make your changes, and submit a pull request.
  - Be sure to follow our coding style and include tests for any new functionality.
  - When submitting a pull request, please provide a clear description of your changes.
  - Your contributions help improve the project for everyone.
    <h1 align=center>simpex</h1>
