regexable 0.1.1

A more readable alternative to regular expressions.

Regexable

Regexable is a Python package that simplifies the creation and management of regular expressions through an intuitive, chainable interface. This package makes it easier for both beginners and experienced developers to construct complex regex patterns in a more readable and maintainable way.

Documentation

The official documentation is available at Regexable Documentation.

Features

• Chainable Methods: Build regex patterns step by step using a clean, chainable syntax.
• Anchors and Boundaries: Easily add start-of-line, end-of-line, word boundary, and other anchors to your patterns.
• Text Matching: Add specific text or optional text segments, and define characters to match or exclude.
• Quantifiers: Specify how many times a character or group should be matched (e.g., zero or more, one or more, exactly n times).
• Modifiers: Apply flags for case-insensitive or multiline matching.
• Grouping and Alternation: Group patterns together or create alternatives using the group and or_ methods.
• Utilities: Match, search, and compile patterns into regex objects.

Installation

Install Regexable via pip:

pip install regexable

Quick Start

Here's a quick example of how to use Regexable:

from regexable import Regexable

# Construct a regex pattern
pattern = Regexable()\
    .start_of_line()\
    .then("Hello")\
    .whitespace()\
    .one_or_more()\
    .then("World")\
    .end_of_line()\
    .build()

# Match a string
match = pattern.match("Hello World")
print(match)  # Output: <re.Match object; span=(0, 11), match='Hello World'>

# Check if a string matches the pattern
if pattern.match("Hello World"):
    print("Match found!")

# Use additional features
regex = Regexable()\
    .start_of_line()\
    .then("abc")\
    .maybe("def")\
    .anything_but("g")\
    .end_of_line()\
    .build()

print(regex.pattern)  # Output: ^abc(def)?[^g]+$

Contributing

We welcome contributions! If you find a bug or have a feature request, please create an issue on our GitHub repository.