regecks 0.1.0__tar.gz

regecks-0.1.0/.github/workflows/pylint.yml

@@ -0,0 +1,27 @@
+name: Pylint
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')

regecks-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

regecks-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kashyap Sukshavasi
+
+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.

regecks-0.1.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: regecks
+Version: 0.1.0
+Summary: A from-scratch regular expression engine with TUI
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: textual>=0.80
+Description-Content-Type: text/markdown
+
+# Regecks
+ A regex engine built from scratch using python, and a TUI using Textual!
+
+ Ever part of this including stuff like the lexer, parser, the ast, and the backtracking were written by hand :)
+
+ ## Installation
+
+ Requires [uv](https://docs.astral.sh/uv/)
+
+ ```bash
+git clone https://github.com/kashsuks/regecks
+cd regecks
+uv sync
+ ```
+## Running
+
+```bash
+uv run regecks
+```
+
+## Keybindings
+
+| **Key** | **Action**                                  |
+|---------|---------------------------------------------|
+| Tab     | Move between pattern and test string fields |
+| Ctrl+R  | Run match manually                          |
+| Ctrl+C  | Quit                                        |
+
+Matches get updated live
+
+## Supported Syntax
+
+### Literals
+
+| Pattern | Match                  |
+|---------|------------------------|
+| a       | The character a        |
+| abc     | The string abc exactly |
+
+### Wildcard
+
+| Pattern | Match                               |
+|---------|-------------------------------------|
+| .       | Any single character except newline |
+
+### Quantifiers
+
+All quantifiers are greedy and therefore consume as much as possible.
+
+| Pattern | Match                         |
+|---------|-------------------------------|
+| a*      | Zero or more a                |
+| a+      | One or more a                 |
+| a?      | Zero or one a                 |
+| a{3}    | Exactly 3 a                   |
+| a{2,}   | 2 or more a                   |
+| a{2,4}  | Between 2 and 4 a (inclusive) |
+
+### Anchors
+
+| Pattern | Match                               |
+|---------|-------------------------------------|
+| ^abc    | abc only at the start of the string |
+| abc$    | abc only at the end of the string   |
+| \b      | Word boundary (between \w and \W)   |
+| \B      | Non-word boundary                   |
+
+### Character classes
+
+| Pattern  | Match                         |
+|----------|-------------------------------|
+| [abc]    | Any one of a, b, or c         |
+| [a-z]    | Any lowercase letter          |
+| [A-Z0-9] | Any uppercase letter or digit |
+| [^abc]   | Any character except a, b, c  |
+| [^0-9]   | Any non-digit                 |
+
+### Escape sequences
+
+| Pattern | Match                                     |
+|---------|-------------------------------------------|
+| \d      | Any digit [0-9]                           |
+| \D      | Any non-digit                             |
+| \w      | Any word character [a-zA-Z0-9_]           |
+| \W      | Any non-word character                    |
+| \s      | Any whitespace (space, tab, newline, etc) |
+| \S      | Any non-whitespace                        |
+| \n      | Newline                                   |
+| \t      | Tab                                       |
+| \n      | Literal dot (escaping special chars)      |
+
+### Alternation
+
+| Pattern       | Match             |
+|---------------|-------------------|
+| cat\|dog      | Either cat or dog |
+| foo\|bar\|baz | Any of the three  |
+
+### Groups
+
+| Pattern       | Match                                  |
+|---------------|----------------------------------------|
+| (abc)         | abc, captured as group 1               |
+| (a)(b)        | ab, with a as group 1 and b as group 2 |
+| (?:abc)       | abc, not captured                      |
+| (?P<name>abc) | abc, captured as named group name      |
+
+### Flags
+
+| Pattern | Match                                                   |
+|---------|---------------------------------------------------------|
+| (?iabc) | Match abc case-insensitively and matches ABC, abc, etc. |
+
+The flags wrap everything that follows it in a pattern
+
+### Lookahead and lookbehind
+
+These are zero-width assertions meaning they check for a condition without consuming characters.

regecks-0.1.0/README.md

@@ -0,0 +1,118 @@
+# Regecks
+ A regex engine built from scratch using python, and a TUI using Textual!
+
+ Ever part of this including stuff like the lexer, parser, the ast, and the backtracking were written by hand :)
+
+ ## Installation
+
+ Requires [uv](https://docs.astral.sh/uv/)
+
+ ```bash
+git clone https://github.com/kashsuks/regecks
+cd regecks
+uv sync
+ ```
+## Running
+
+```bash
+uv run regecks
+```
+
+## Keybindings
+
+| **Key** | **Action**                                  |
+|---------|---------------------------------------------|
+| Tab     | Move between pattern and test string fields |
+| Ctrl+R  | Run match manually                          |
+| Ctrl+C  | Quit                                        |
+
+Matches get updated live
+
+## Supported Syntax
+
+### Literals
+
+| Pattern | Match                  |
+|---------|------------------------|
+| a       | The character a        |
+| abc     | The string abc exactly |
+
+### Wildcard
+
+| Pattern | Match                               |
+|---------|-------------------------------------|
+| .       | Any single character except newline |
+
+### Quantifiers
+
+All quantifiers are greedy and therefore consume as much as possible.
+
+| Pattern | Match                         |
+|---------|-------------------------------|
+| a*      | Zero or more a                |
+| a+      | One or more a                 |
+| a?      | Zero or one a                 |
+| a{3}    | Exactly 3 a                   |
+| a{2,}   | 2 or more a                   |
+| a{2,4}  | Between 2 and 4 a (inclusive) |
+
+### Anchors
+
+| Pattern | Match                               |
+|---------|-------------------------------------|
+| ^abc    | abc only at the start of the string |
+| abc$    | abc only at the end of the string   |
+| \b      | Word boundary (between \w and \W)   |
+| \B      | Non-word boundary                   |
+
+### Character classes
+
+| Pattern  | Match                         |
+|----------|-------------------------------|
+| [abc]    | Any one of a, b, or c         |
+| [a-z]    | Any lowercase letter          |
+| [A-Z0-9] | Any uppercase letter or digit |
+| [^abc]   | Any character except a, b, c  |
+| [^0-9]   | Any non-digit                 |
+
+### Escape sequences
+
+| Pattern | Match                                     |
+|---------|-------------------------------------------|
+| \d      | Any digit [0-9]                           |
+| \D      | Any non-digit                             |
+| \w      | Any word character [a-zA-Z0-9_]           |
+| \W      | Any non-word character                    |
+| \s      | Any whitespace (space, tab, newline, etc) |
+| \S      | Any non-whitespace                        |
+| \n      | Newline                                   |
+| \t      | Tab                                       |
+| \n      | Literal dot (escaping special chars)      |
+
+### Alternation
+
+| Pattern       | Match             |
+|---------------|-------------------|
+| cat\|dog      | Either cat or dog |
+| foo\|bar\|baz | Any of the three  |
+
+### Groups
+
+| Pattern       | Match                                  |
+|---------------|----------------------------------------|
+| (abc)         | abc, captured as group 1               |
+| (a)(b)        | ab, with a as group 1 and b as group 2 |
+| (?:abc)       | abc, not captured                      |
+| (?P<name>abc) | abc, captured as named group name      |
+
+### Flags
+
+| Pattern | Match                                                   |
+|---------|---------------------------------------------------------|
+| (?iabc) | Match abc case-insensitively and matches ABC, abc, etc. |
+
+The flags wrap everything that follows it in a pattern
+
+### Lookahead and lookbehind
+
+These are zero-width assertions meaning they check for a condition without consuming characters.

regecks-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "regecks"
+version = "0.1.0"
+description = "A from-scratch regular expression engine with TUI"
+readme = "README.md"
+requires-python=">=3.11"
+dependencies = [
+    "textual>=0.80",
+]
+
+[project.scripts]
+regecks = "regecks.__main__:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/regecks"]
+
+[tool.uv]
+python-preference = "only-managed"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.23",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

regecks-0.1.0/src/regecks/__init__.py

@@ -0,0 +1,3 @@
+"""regecks - a from scratch regular expression engine"""
+
+__version__ = "0.1.0"

regecks-0.1.0/src/regecks/__main__.py

@@ -0,0 +1,9 @@
+"""
+Main entry point for the tui app
+"""
+
+
+def main() -> None:
+    from regecks.tui.app import RegexApp
+
+    RegexApp().run()

regecks-0.1.0/src/regecks/engine/__init__.py

@@ -0,0 +1,4 @@
+from .lexer import Lexer
+from .matcher import Matcher
+from .models import MatchResult
+from .parser import Parser