Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About the Project

This package contains a few useful functions and classes for building/using regular expressions.

Getting Started

Prerequisites

• Python 3.7+

Installation

Install using pip:

pip install regexify

Usage

See the test files for example usage.

Pattern Trie

Compile multiple terms into a single pattern.

import re
from regexify import PatternTrie

data = ['there', 'hi', 'python', 'pythons', 'hiya']
trie = PatternTrie(*data)
pat = re.compile(trie.pattern)

Versions

Uses SEMVER.

See https://github.com/dcronkite/regexify/releases.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

See LICENSE or https://dcronkite.mit-license.org for more information.

Contact

Please use the issue tracker.

Acknowledgements