simplibs-extractor-python 0.1.0__py3-none-any.whl

simplibs_extractor_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,457 @@
+Metadata-Version: 2.4
+Name: simplibs-extractor-python
+Version: 0.1.0
+Summary: The Python add-on of simplibs-extractor: file rules for Python projects, steps that remove comments, docstrings, imports and decorators (found with ast and tokenize, never with a regex), an outline step and five ready profiles.
+Author-email: "Dalibor Sova (Sudip2708)" <daliborsova@seznam.cz>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/simplibs/simplibs-extractor-python
+Project-URL: Repository, https://github.com/simplibs/simplibs-extractor-python
+Project-URL: Issues, https://github.com/simplibs/simplibs-extractor-python/issues
+Project-URL: Changelog, https://github.com/simplibs/simplibs-extractor-python/blob/main/CHANGELOG.md
+Keywords: extractor,python,code-extractor,project-to-text,ast,tokenize,comments,docstrings,outline,markdown,llm,context,plugin,simplibs,simplibs-extractor,developer-tools
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: simplibs-extractor>=0.2.0
+Requires-Dist: simplibs-text>=0.2.0
+Requires-Dist: simplibs-actions>=0.2.2
+Requires-Dist: simplibs-path>=0.2.0
+Requires-Dist: simplibs-rules>=0.4.0
+Requires-Dist: simplibs-validate>=0.3.2
+Requires-Dist: simplibs-exception>=1.1.4
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Dynamic: license-file
+
+# 🐍 `simplibs-extractor-python`
+
+[![PyPI](https://img.shields.io/pypi/v/simplibs-extractor-python)](https://pypi.org/project/simplibs-extractor-python/)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
+[![Licence](https://img.shields.io/badge/licence-MIT-green)](https://github.com/simplibs/simplibs-extractor-python/blob/main/LICENSE)
+[![tests](https://github.com/simplibs/simplibs-extractor-python/actions/workflows/tests.yml/badge.svg)](https://github.com/simplibs/simplibs-extractor-python/actions)
+
+**A Python project in one document — the code, with or without its paperwork.**
+
+The Python add-on of [`simplibs-extractor`](https://pypi.org/project/simplibs-extractor/). The extractor gathers the
+text files of a folder into one document and knows **no language**; this library teaches it Python: which files are
+worth reading, how to take **comments, docstrings, imports and decorators** out of a source, how to write an
+**outline** of its classes and functions, and five ready **profiles** that put it together. Python is read with `ast`
+and `tokenize`, never with a regex — so a `#` inside a string is left alone.
+
+```bash
+pip install simplibs-extractor-python
+simplibs-extractor python src-clean my_project
+```
+
+```python
+from simplibs.extractor_python import remove_python_comments, python_outline
+
+remove_python_comments("x = 1  # note\ny = '# not a comment'\n")   # -> "x = 1\ny = '# not a comment'\n"
+python_outline("class A:\n    def m(self, n: int = 1) -> str:\n        return ''\n")
+# -> 'class A:\n    def m(self, n: int=1) -> str: ...\n'
+```
+
+> `pip install` is the whole installation: the library announces itself to the extractor through an entry point, so the
+> profiles show up in `simplibs-extractor --list-systems` with nothing to import. The same steps are plain functions
+> (`str -> str`) you can use without the extractor at all.
+
+---
+
+## 🧭 The Core Philosophy
+
+Cleaning source code with a few regular expressions works until the first file where it does not: a `#` in a URL inside a
+string, an `import` in a docstring, a docstring that was the only statement of a function, `import a; x = 1` on one line.
+`simplibs-extractor-python` is built around those traps:
+
+* **Python is read by Python.** The comments are found by `tokenize`, the docstrings, imports and decorators by `ast`.
+  A `#` inside `"http://x/#anchor"` is not a comment, and `from` inside a string is not an import.
+* **Cut by position, change nothing else.** A removal cuts exactly the characters of what it found; the rest of the file
+  stays as it was written — quotes, spacing, line breaks. The step does not re-format, so the output can be compared with
+  the original.
+* **The tree stays.** For a source that parses, the syntax tree of the result equals the tree of the original **minus**
+  what the step removes. A block that would be left empty gets a `pass`, a `;` that joined two statements goes with the
+  one that was removed — the result is still Python.
+* **One bad file never stops a run.** A file that cannot be read (an old Python 2 file, a half-written module) raises one
+  card, the extractor marks **that file** `error` with the reason and goes on. For a profile where "not cleaned" is better
+  than "not there", `on_error="keep"` gives the text back unchanged.
+* **A name is a whole name.** A test is `test_a.py`, `a_test.py`, `tests.py`, `conftest.py` or anything in a folder called
+  `tests` — not `latest_data.py`, `contest.py` or `attest.py`. A folder is `tests` or it is not.
+* **A package is source.** `__init__.py` holds the public names of a package and `__main__.py` its entry point; both are
+  taken by default. What the interpreter made (`__pycache__`) is not.
+* **Rules judge the path inside the source.** A project that lies in a folder called `tests` is not dropped as "a test";
+  the rules see only what is *inside* the source folder.
+* **For reading, not for running.** A removal of decorators can change what a function *is*, a removal of imports leaves
+  names without their origin. The profiles say so, and the output is built for a reader — a person or a model.
+* **Functions first, actions on top.** Every step is a plain function; the action is a thin wrapper over the function of
+  the same name, and the presets and profiles are built from the actions. The logic lives once.
+* **Every error is a card.** An unreadable source is one structured card from
+  [`simplibs-exception`](https://pypi.org/project/simplibs-exception/): what, why, how to fix.
+* **Layers that only look left.** `annotations` ← `constants` ← `file_rules` ← `logic` ← `actions` ← `presets` ←
+  `profiles` ← `plugin` — every layer imports only from those before it.
+
+```python
+remove_python_imports("print 'hello'\n")                 # -> raises: CODE_EXTRACTOR_PYTHON_SOURCE_INVALID — Python 2, the file cannot be read
+remove_python_imports("print 'hello'\n", on_error="keep")   # -> "print 'hello'\n"   the text back, unchanged
+```
+
+---
+
+## 📦 Installation
+
+```bash
+pip install simplibs-extractor-python
+```
+
+Requires Python 3.11+. The package brings [`simplibs-extractor`](https://pypi.org/project/simplibs-extractor/) with it,
+and the command `simplibs-extractor` is available at once. Runtime dependencies, all from the same family:
+[`simplibs-extractor`](https://pypi.org/project/simplibs-extractor/) (the profile, the registry),
+[`simplibs-text`](https://pypi.org/project/simplibs-text/) (cutting the found ranges, the whitespace presets),
+[`simplibs-actions`](https://pypi.org/project/simplibs-actions/) (the steps as actions),
+[`simplibs-path`](https://pypi.org/project/simplibs-path/) and [`simplibs-rules`](https://pypi.org/project/simplibs-rules/)
+(the file rules), [`simplibs-validate`](https://pypi.org/project/simplibs-validate/) and
+[`simplibs-exception`](https://pypi.org/project/simplibs-exception/) (the checks and the error card).
+
+> **The running Python decides what is valid.** A source is read by the interpreter that runs the step: a file with syntax
+> newer than that interpreter (`def f[T](x: T)` is Python 3.12+) is a file it cannot read — an `error` line in the
+> report, or an unchanged file with `on_error="keep"`.
+
+---
+
+## 🚀 Quick Start in 60 Seconds
+
+### Level 1: The command line
+
+```bash
+simplibs-extractor python src-clean my_project                     # the project's own logic, cleaned -> my_project/python_src_clean.md
+simplibs-extractor python code-no-imports my_project               # the logic only
+simplibs-extractor python outline my_project                       # signatures without bodies — the smallest overview
+simplibs-extractor python code-clean,data-all my_project           # two profiles -> two files, one run
+simplibs-extractor python data-all my_project --dry-run            # plan and report, write nothing
+simplibs-extractor --list-profiles python                          # the five profiles
+```
+
+Which one? `data-all` gives the files as they are, `code-clean` takes the prose away (comments, docstrings), `src-clean`
+does the same and leaves out tests, configuration, environments and build folders, `code-no-imports` takes also the
+imports and decorators away, `outline` keeps only what a project offers.
+
+### Level 2: The steps as functions
+
+```python
+from simplibs.extractor_python import (
+    remove_python_comments, remove_python_docstrings, remove_python_imports, remove_python_decorators, python_outline,
+)
+
+remove_python_comments("x = 1  # note\n# alone\ny = '# not a comment'\n")      # -> "x = 1\ny = '# not a comment'\n"
+remove_python_docstrings('class A:\n    """doc"""\n\ndef f():\n    """doc"""\n')
+# -> 'class A:\n    pass\n\ndef f():\n    pass\n'                              a body needs a statement
+remove_python_imports("import a; x = 1\ny = 2; import b\n")                    # -> 'x = 1\ny = 2\n'
+remove_python_decorators("@app.route('/')\n@cache(60)\ndef index():\n    pass\n")   # -> 'def index():\n    pass\n'
+python_outline("@dec\nclass A(B):\n    def m(self, a: int = 1) -> str:\n        return ''\n")
+# -> '@dec\nclass A(B):\n    def m(self, a: int=1) -> str: ...\n'
+```
+
+### Level 3: Actions and ready-made chains
+
+```python
+from simplibs.extractor_python.actions import PythonOutline, RemovePythonComments, RemovePythonImports
+from simplibs.extractor_python.presets import PYTHON_CLEAN, PYTHON_NO_IMPORTS
+
+steps = RemovePythonComments() >> RemovePythonImports()
+steps("import os\n\n# c\nx = 1  # n\n")                  # -> '\nx = 1\n'
+
+PYTHON_CLEAN("import os\n# c\nx = 1  # n\n")             # -> 'import os\nx = 1\n'
+PYTHON_NO_IMPORTS('import os\n\n@cache(60)\ndef f():\n    """Doc."""\n    return 1  # one\n')
+# -> 'def f():\n    return 1\n'
+
+PythonOutline(docstrings=False)("def f(): '''d'''\n")    # -> 'def f(): ...\n'
+```
+
+### Level 4: Your own profile from the parts
+
+File rules combine with `&`, `|` and `~`; the steps chain with `>>`; a registered profile is a name for both.
+
+```python
+from simplibs.extractor import Profile, by_suffix, extract, register_profile
+from simplibs.extractor_python.constants import PYTHON_SUFFIXES
+from simplibs.extractor_python.file_rules import PYTHON_BASE, PYTHON_TESTS
+from simplibs.extractor_python.presets import PYTHON_CLEAN
+
+register_profile(Profile(
+    system="python", name="tests-clean",
+    description="The tests, without comments and docstrings",
+    include=PYTHON_BASE & PYTHON_TESTS,                  # Python files that are tests
+    steps=by_suffix(PYTHON_CLEAN, PYTHON_SUFFIXES),
+    output_name="python_tests_clean.md",
+))
+
+extract(source="my_project", profile="python/tests-clean")
+```
+
+A changed copy of a profile of this library is one `dataclasses.replace` away:
+
+```python
+from dataclasses import replace
+from simplibs.extractor_python.profiles import PYTHON_SRC_CLEAN
+
+mine = replace(PYTHON_SRC_CLEAN, name="mine", output_name="mine.md")
+```
+
+---
+
+## 🛠️ Architecture & Package Structure
+
+```
+src/simplibs/extractor_python/
+├── annotations/          ◄── OnError
+├── constants/            ◄── PYTHON_SUFFIXES, PYTHON_CONFIG_NAMES, PYTHON_TEST_DIR_NAMES, PYTHON_VENV_DIR_NAMES, PYTHON_OUTPUT_DIR_NAMES
+├── file_rules/           ◄── Rules on the path inside the source (domain folder)
+│   ├── atomic/           ◄── DOT_NAME, INIT_NAME, MAIN_NAME, IN_DUNDER_DIR, VCS_DIRS, VENV_DIRS, OUTPUT_DIRS
+│   └── python/           ◄── PYTHON_BASE, build_python_base, PYTHON_TESTS, PYTHON_CONFIG, PYTHON_STRICT_EXCLUDE
+├── logic/                ◄── The steps: plain functions that read Python with ast and tokenize
+│   ├── python_comment_spans.py  remove_python_comments.py  remove_python_docstrings.py  ...
+│   └── _helpers/  _validations/                          ◄── Private: offsets, the parser guard, statement cutting, the card
+├── actions/              ◄── The steps as Action classes (domain folder)
+├── presets/              ◄── Ready-made chains: PYTHON_CLEAN, PYTHON_NO_IMPORTS (domain folder)
+├── profiles/             ◄── The five Profile objects and PYTHON_PROFILES (domain folder)
+├── plugin/               ◄── register_all: the target of the entry point
+└── py.typed
+```
+
+Folders named `_helpers/` and `_validations/` are private: they hold the small tools of the steps and the function that
+raises the library's one error card.
+
+The package root exports **the steps**, `register_all` and `OnError`. The four domain folders have their own `__all__` and
+are imported through their domain — a function and an action are different kinds of thing and should stay visibly
+different at the import line:
+
+```python
+from simplibs.extractor_python import remove_python_comments, python_outline, OnError          # the steps and the type
+from simplibs.extractor_python.actions import RemovePythonComments                              # the steps as actions
+from simplibs.extractor_python.file_rules import PYTHON_BASE, build_python_base                 # the rules
+from simplibs.extractor_python.presets import PYTHON_CLEAN                                      # ready-made chains
+from simplibs.extractor_python.profiles import PYTHON_SRC_CLEAN                                 # the profiles as objects
+```
+
+The ranges the steps find are `simplibs.text.Span`; the type is taken from `simplibs-text`, not defined here.
+
+---
+
+## 🔧 `logic/` — The steps that read Python
+
+Plain functions: a Python source as a text in, a text out (one of them gives the positions of the comments). All take the
+option `on_error`.
+
+| Function                   | Description / Parameters                                                                                              |
+|----------------------------|-----------------------------------------------------------------------------------------------------------------------|
+| `python_comment_spans`     | Finds the comments with the tokenizer; returns a `Span` for each, from the blanks in front to the end (`text`, keyword-only: `on_error="raise"`). |
+| `remove_python_comments`   | Removes every comment; a line that held only a comment disappears (`text`, keyword-only: `on_error="raise"`).          |
+| `remove_python_docstrings` | Removes the docstrings of the module, classes and functions; an emptied body gets `pass` (`text`, keyword-only: `on_error="raise"`). |
+| `remove_python_imports`    | Removes the imports at any depth; an emptied body gets `pass`, `import a; x = 1` keeps `x = 1` (`text`, keyword-only: `on_error="raise"`). |
+| `remove_python_decorators` | Removes the decorators of every class and function, from the `@` (`text`, keyword-only: `on_error="raise"`).           |
+| `python_outline`           | Writes classes and functions as signatures without bodies — valid Python again (`text`, keyword-only: `docstrings=True`, `on_error="raise"`). |
+
+➡️ [README_EXTRACTOR_PYTHON_LOGIC](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/logic/README_EXTRACTOR_PYTHON_LOGIC.md)
+
+---
+
+## 🔗 `actions/` — The steps as pipeline actions
+
+Every step except `python_comment_spans` is also an `Action` of
+[`simplibs-actions`](https://pypi.org/project/simplibs-actions/): configured once, called with the **text** as its main
+input, chainable with `>>`. The options of the function are the options of the action:
+`RemovePythonImports(on_error="keep")`.
+
+| Action                   | Over                       | Description                                                  |
+|--------------------------|----------------------------|--------------------------------------------------------------|
+| `RemovePythonComments`   | `remove_python_comments`   | Takes the comments out of the text flowing in.               |
+| `RemovePythonDocstrings` | `remove_python_docstrings` | Takes the docstrings out.                                    |
+| `RemovePythonImports`    | `remove_python_imports`    | Takes the import statements out.                             |
+| `RemovePythonDecorators` | `remove_python_decorators` | Takes the decorators out.                                    |
+| `PythonOutline`          | `python_outline`           | Turns the text into signatures without bodies.               |
+
+➡️ [README_EXTRACTOR_PYTHON_ACTIONS](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_ACTIONS.md)
+
+---
+
+## 🧩 `presets/` — Ready-made chains
+
+Chains of actions, built once, that the profiles use.
+
+| Preset              | Chain                                                                                                  |
+|---------------------|--------------------------------------------------------------------------------------------------------|
+| `PYTHON_CLEAN`      | `RemovePythonComments() >> RemovePythonDocstrings() >> CLEANUP_WHITESPACE` — the imports stay.        |
+| `PYTHON_NO_IMPORTS` | `RemovePythonComments() >> RemovePythonDocstrings() >> RemovePythonImports() >> RemovePythonDecorators() >> COMPACT` — the logic only. |
+
+`CLEANUP_WHITESPACE` squeezes blank runs to one line, `COMPACT` removes every blank line (also inside a multi-line string).
+
+➡️ [README_EXTRACTOR_PYTHON_PRESETS](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_PRESETS.md)
+
+---
+
+## 📋 `profiles/` — The five profiles
+
+Registered in the system `python`; also importable as `Profile` objects.
+
+| Profile                  | Output                      | Description                                                                                 |
+|--------------------------|-----------------------------|---------------------------------------------------------------------------------------------|
+| `python/code-clean`      | `python_code_clean.md`      | Python without comments, docstrings and extra blank lines (imports stay).                   |
+| `python/code-no-imports` | `python_code_no_imports.md` | Pure logic: no imports, decorators, comments, docstrings or blank lines.                    |
+| `python/data-all`        | `python_data_all.md`        | Every relevant `.py` file, as it is.                                                        |
+| `python/outline`         | `python_outline.md`         | Overview of classes and functions: signatures without bodies.                               |
+| `python/src-clean`       | `python_src_clean.md`       | Like `code-clean`, without tests, configuration, environments and build folders.            |
+
+`PYTHON_PROFILES` is the tuple of all five, in the order the listings show them.
+
+➡️ [README_EXTRACTOR_PYTHON_PROFILES](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_PROFILES.md)
+
+---
+
+## 📐 `file_rules/` — Which files are worth reading
+
+Rules on the path **inside** the source folder: `Rule` objects of
+[`simplibs-rules`](https://pypi.org/project/simplibs-rules/), composable with `&`, `|` and `~`.
+
+| Rule / function         | Description / Parameters                                                                                       |
+|-------------------------|----------------------------------------------------------------------------------------------------------------|
+| `PYTHON_BASE`           | The default choice: Python files, with `__init__.py` and `__main__.py`, without dot files and `__pycache__`.    |
+| `build_python_base`     | Builds that rule with switches (keyword-only: `include_init=True`, `include_main=True`).                         |
+| `PYTHON_TESTS`          | A test by its whole name (`test_a.py`, `a_test.py`, `tests.py`, `conftest.py`) or by its folder (`tests/`).     |
+| `PYTHON_CONFIG`         | Project configuration: `setup.py`, `pyproject.toml`, `tox.ini`, `requirements.txt`, ...                         |
+| `PYTHON_STRICT_EXCLUDE` | Tests, configuration, environments, build output and version control together.                                  |
+
+The atomic pieces they are made of: `DOT_NAME`, `INIT_NAME`, `MAIN_NAME`, `IN_DUNDER_DIR`, `VCS_DIRS`, `VENV_DIRS`,
+`OUTPUT_DIRS`.
+
+➡️ [README_EXTRACTOR_PYTHON_FILE_RULES](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_FILE_RULES.md)
+
+---
+
+## 🔖 `annotations/` and `constants/`
+
+| Name                      | Kind     | Description                                                                         |
+|---------------------------|----------|-------------------------------------------------------------------------------------|
+| `OnError`                 | Literal  | `"raise"` or `"keep"`: what a step does with a source it cannot read. Exported from the package root. |
+| `PYTHON_SUFFIXES`         | Constant | `(".py",)` — the suffixes of Python source.                                         |
+| `PYTHON_CONFIG_NAMES`     | Constant | File names of project configuration.                                                |
+| `PYTHON_TEST_DIR_NAMES`   | Constant | `("tests", "test")`.                                                                |
+| `PYTHON_VENV_DIR_NAMES`   | Constant | `("venv", ".venv", "env", "virtualenv")`.                                           |
+| `PYTHON_OUTPUT_DIR_NAMES` | Constant | `("build", "dist", "out")`.                                                         |
+
+➡️ [README_EXTRACTOR_PYTHON_ANNOTATIONS](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_ANNOTATIONS.md) · [README_EXTRACTOR_PYTHON_CONSTANTS](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_CONSTANTS.md)
+
+---
+
+## 🔌 `plugin/` — The meeting point with the extractor
+
+| Function       | Description / Parameters                                                                                                  |
+|----------------|---------------------------------------------------------------------------------------------------------------------------|
+| `register_all` | Registers the five profiles in the extractor's registry and returns their keys; the target of the entry point `simplibs.extractor.plugins` (keyword-only: `replace_existing=True`). |
+
+The entry point lives in this library's `pyproject.toml`; the extractor's `load_plugins()` finds it, so nothing is
+imported by name. From Python, call `load_plugins()` of the extractor once before a profile is looked up.
+
+➡️ [README_EXTRACTOR_PYTHON_PLUGIN](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_PLUGIN.md)
+
+---
+
+## ⚠️ Exceptions
+
+The library defines no exceptions of its own. A source that cannot be read is one structured
+[`simplibs.exception`](https://pypi.org/project/simplibs-exception/) card; a caller that wants "any error of the family"
+catches `SimpleError`.
+
+| Error name                             | Class        | Wraps        | Raised when                                                                                      |
+|----------------------------------------|--------------|--------------|--------------------------------------------------------------------------------------------------|
+| `CODE_EXTRACTOR_PYTHON_SOURCE_INVALID` | `ParamError` | `ValueError` | A step gets a text that cannot be read as Python — a syntax error, a bad indentation, an unterminated string, a null character, line endings other than `\n` — and `on_error` is `"raise"`. |
+
+What is an exception and what is not:
+
+| Situation                                                                   | How it is reported                                                       |
+|-----------------------------------------------------------------------------|--------------------------------------------------------------------------|
+| A step called directly on **an unreadable source**                          | the card above, **raised** (or the text back with `on_error="keep"`)     |
+| The same inside an **extraction**                                           | **not raised**: that file is `error` in the result, the run continues    |
+| A wrong **type** of an argument (`text=5`, `on_error="ignore"`)             | a `ValidationError` from `simplibs-validate`                             |
+| A profile key that is taken, with `register_all(replace_existing=False)`    | the card of the extractor's registry (`EXTRACTOR_PROFILE_EXISTS`)        |
+
+---
+
+## 📚 Documentation
+
+The detailed references — every function, rule and profile with its parameters, return value, raised errors, an example
+and a look under the hood:
+
+| Reference | What it describes |
+|-----------|-------------------|
+| [LOGIC](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/logic/README_EXTRACTOR_PYTHON_LOGIC.md) | the six steps: comments, docstrings, imports, decorators, the outline |
+| [ACTIONS](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_ACTIONS.md) | the steps as pipeline actions |
+| [PRESETS](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_PRESETS.md) | `PYTHON_CLEAN`, `PYTHON_NO_IMPORTS` |
+| [PROFILES](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_PROFILES.md) | the five profiles, one file through each, a profile of your own |
+| [FILE_RULES](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_FILE_RULES.md) | which files are worth reading: the atomic pieces and the rules of a Python project |
+| [ANNOTATIONS](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_ANNOTATIONS.md) | `OnError` |
+| [CONSTANTS](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_CONSTANTS.md) | the fixed values: suffixes and folder names |
+| [PLUGIN](https://github.com/simplibs/simplibs-extractor-python/blob/main/docs/README_EXTRACTOR_PYTHON_PLUGIN.md) | `register_all` and how the extractor finds this add-on |
+
+---
+
+## 🔗 Related libraries
+
+* **[`simplibs-extractor`](https://pypi.org/project/simplibs-extractor/)** — the extractor this library is an add-on of: the six phases, the profiles and the command.
+* **[`simplibs-text`](https://pypi.org/project/simplibs-text/)** — `remove_spans` cuts the ranges the steps find; `CLEANUP_WHITESPACE` and `COMPACT` close the presets.
+* **[`simplibs-actions`](https://pypi.org/project/simplibs-actions/)** — the `Action` the steps are wrapped in.
+* **[`simplibs-path`](https://pypi.org/project/simplibs-path/)** — the path rules (`HasSuffix`, `NameIs`, `AnyParentNameIs`) and `IGNORE_VCS`.
+* **[`simplibs-rules`](https://pypi.org/project/simplibs-rules/)** — the `Rule` object and its building blocks (`IsIn`, `Equals`, `StartsWith`, `Regex`).
+* **[`simplibs-validate`](https://pypi.org/project/simplibs-validate/)** and **[`simplibs-exception`](https://pypi.org/project/simplibs-exception/)** — the checks of every signature and the error card.
+
+---
+
+## ☯️ About simplibs
+
+All libraries in the **simplibs** (Simple Libraries) ecosystem share a common
+engineering philosophy:
+
+* **Dyslexia-friendly:**
+We actively minimize cognitive load. Code is atomized into small, self-contained units,
+files are named directly after the logical task they perform, and explanations describe
+*why* something is designed, not just *what* it is.
+* **Programmer's Zen:**
+Nothing should be missing, and nothing should be superfluous. We value clean execution
+paths and robust, understandable code architectures over rushed, messy feature sets.
+* **Defensive Style:**
+We actively anticipate edge cases and failure modes so that only safe operational paths
+remain. Our code is built to degrade gracefully rather than crash unexpectedly.
+* **Minimalism:**
+Find the most direct path to the goal in as few operational steps as possible without
+taking shortcuts on safety, readability, or completeness.
+* **Code as Craft:**
+Code should be pleasant to look at, readable at a glance, and evoke structural harmony.
+We treat software engineering as a precision trade.
+
+---
+
+### 🤝 Contributing & Community
+
+This is an **open-source project** built with love and care. We strongly believe in
+community collaboration and welcome any feedback, bug reports, or feature ideas!
+
+* **Want to contribute?** Feel free to open an Issue or submit a Pull Request.
+* **Want to get in touch?** If you'd like to discuss the project further, collaborate,
+  or just say hello, feel free to open a GitHub Issue or start a Discussion.
+
+---
+
+### 📝 License
+
+This library is released under the **MIT License**. Build great things!
+
+---

simplibs_extractor_python-0.1.0.dist-info/RECORD

@@ -0,0 +1,71 @@
+simplibs/extractor_python/__init__.py,sha256=qhhxkcDgPPQmeWraOUxVJpYyII0hgWmkHHkrWSX4jg4,2200
+simplibs/extractor_python/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+simplibs/extractor_python/actions/PythonOutline.py,sha256=_mIBdJuaGN2CgPi625wB9i3LhXhbcwFfcVh2oilPI60,630
+simplibs/extractor_python/actions/RemovePythonComments.py,sha256=2V5k1TCwwLGWC2J3fE6MvyYm-c5vMdBMaQUSU_mYnoU,653
+simplibs/extractor_python/actions/RemovePythonDecorators.py,sha256=7ARRzBJ26vEVqThS3QBu8xTMISvAyr4wUibPKYNcYl8,589
+simplibs/extractor_python/actions/RemovePythonDocstrings.py,sha256=XbA3RDqkTmdmq_Csksd9BvLP6juuW3yzPCFtgihOCgU,594
+simplibs/extractor_python/actions/RemovePythonImports.py,sha256=admJqxuKcVWI5MTk_JPRLSInLZOzX4oRrrUFWPxIEo8,546
+simplibs/extractor_python/actions/__init__.py,sha256=ga3WHndsB6WhSRqicReyDrxJM9qL0MY7veOxCKGjUs8,1867
+simplibs/extractor_python/annotations/OnError.py,sha256=_xhZTCF3dmQu8-HHAJ0-0a1kKlPMajw_3NMq012SKJw,898
+simplibs/extractor_python/annotations/__init__.py,sha256=AVLM7o0gisxJoU41biafVAijNZ6End3rj4dMvtNINuo,631
+simplibs/extractor_python/constants/PYTHON_CONFIG_NAMES.py,sha256=cPqAW72Z2AyHJjLSIMSxjann0ems8MBgNVq6qREBRKs,575
+simplibs/extractor_python/constants/PYTHON_OUTPUT_DIR_NAMES.py,sha256=_ji2UgeFUqovnrh--xAN_HGJRUkO4pUDqpiqrEVUIb0,570
+simplibs/extractor_python/constants/PYTHON_SUFFIXES.py,sha256=noUH06oul0VrnH__eZxyaDCfL2ozBShY2czrTa0QhOA,442
+simplibs/extractor_python/constants/PYTHON_TEST_DIR_NAMES.py,sha256=iY6gTpZ6TGdzHbv2jiMYEzI5oeGy0KB60abIMJ7KVMI,472
+simplibs/extractor_python/constants/PYTHON_VENV_DIR_NAMES.py,sha256=uNA-EDGpZ3HkGZRcwE3iF64i6OJsHUrtg9FYbqi5SIk,544
+simplibs/extractor_python/constants/__init__.py,sha256=I-Is7SiamEIJCQ7ZRofaMAoTYkIvnH-D3g-PZq8cbTE,1320
+simplibs/extractor_python/file_rules/__init__.py,sha256=LutlcH_9PJ6P_zrSDZs59dEHMq9r7UHtin0DiXtDBuc,1691
+simplibs/extractor_python/file_rules/atomic/DOT_NAME.py,sha256=cJsd-hkI0dzooSwL7BGzndGwCV_ONaFKdBjyW_iQZ8I,529
+simplibs/extractor_python/file_rules/atomic/INIT_NAME.py,sha256=Xc4uHsXbdtffcTvIYLYYUdUrg_Pr506C-OCv82o_RU4,463
+simplibs/extractor_python/file_rules/atomic/IN_DUNDER_DIR.py,sha256=gX-_rJZ3AMjKYI8flOAKocaOTgOVKQ_oQ6435qeqVgo,481
+simplibs/extractor_python/file_rules/atomic/MAIN_NAME.py,sha256=4wJlFqFaLVFiSRxhI3gW3AjmpvLfmziEJSgiAv86LGM,372
+simplibs/extractor_python/file_rules/atomic/OUTPUT_DIRS.py,sha256=ZoOjbRwhsmSUf4B7swPAq4XquNckL0LsodLjeB_-VBk,435
+simplibs/extractor_python/file_rules/atomic/VCS_DIRS.py,sha256=jZjyNQB12Gd_FS1rOPXUZgXfIPM7ZFanXJcjSMQuM2Y,856
+simplibs/extractor_python/file_rules/atomic/VENV_DIRS.py,sha256=cENocM8qW711tzMa4Id10wGVKHDGAjtTdJhxZaH6-qY,488
+simplibs/extractor_python/file_rules/atomic/__init__.py,sha256=R0HRSSd0YamI8gda08urDwosPuajF1NYdgk7pD8R8Ik,1430
+simplibs/extractor_python/file_rules/python/PYTHON_BASE.py,sha256=8xNu01mFNCWf3ZLERamgU0Ih9GT9l1VzT7MFMWH8ypc,464
+simplibs/extractor_python/file_rules/python/PYTHON_CONFIG.py,sha256=U_W1TBWU4_WO8t-2G_7cnsQ9XqYei6S3F13DQSGzsM0,541
+simplibs/extractor_python/file_rules/python/PYTHON_STRICT_EXCLUDE.py,sha256=pRZgOJD2misgcnY8nFIgFYTNIQocrXTg3HuFYgJMvBY,778
+simplibs/extractor_python/file_rules/python/PYTHON_TESTS.py,sha256=6DzD3E3F7AAY8yZnDB0z-HE_Vn39x0hRD7w-41WAgvc,1038
+simplibs/extractor_python/file_rules/python/__init__.py,sha256=pooFV8qjrPZpMrXbFrDXjr_aRbM4ayYM8qL9yQXhsNc,1169
+simplibs/extractor_python/file_rules/python/build_python_base.py,sha256=P7boM2hYOdYv7Lp8CKj81rr0_jb9Ai0G8SK5pH2NWr8,2115
+simplibs/extractor_python/logic/__init__.py,sha256=zNrXWedm5WvvDTH89CQwaDmer6dVBB9KHKLmz4MeMak,1975
+simplibs/extractor_python/logic/python_comment_spans.py,sha256=IRvpBcubw1gxsBJnsSVFabnjcWdfl_pfw5syzoHVvBM,2364
+simplibs/extractor_python/logic/python_outline.py,sha256=uuR4JExu9pqcRQsupkAKw6LjGsIUmpED4FoRXOSIsbE,2317
+simplibs/extractor_python/logic/remove_python_comments.py,sha256=Umas-0zethFzChjl1b4wtc92DUVv_qFkzmuwM2bCUoI,1307
+simplibs/extractor_python/logic/remove_python_decorators.py,sha256=f2KyJkj4cGG0JbFSUUHFJYHcE1atERbp6iXXDs69BM4,1552
+simplibs/extractor_python/logic/remove_python_docstrings.py,sha256=WyYAYM0QkkKNG9-PsRsCs63avsVyGqpN6AhPjmdSORk,1604
+simplibs/extractor_python/logic/remove_python_imports.py,sha256=frO62OCsfyEyYRNbeHP7lscEcNSx_tN6329ehbGfkjc,1550
+simplibs/extractor_python/logic/_helpers/SourceOffsets.py,sha256=C8mrQspA5Rb92aDpDH5pofwkkXNtvXOd_4N5v2nW3-Q,2694
+simplibs/extractor_python/logic/_helpers/__init__.py,sha256=znE_FIRcbYQs9PupGFK1iEASrViXhaAsqCqJNr1R1xs,2264
+simplibs/extractor_python/logic/_helpers/collect_definitions.py,sha256=HemGsaiBHFWP73v4eNq4u-mWA04sxgTb6QPqcfx9V_Y,2247
+simplibs/extractor_python/logic/_helpers/cut_statements.py,sha256=7uorZmJc_0Kz1vqcUSbz7Sfwd7N450SGzoP6e9K1R2k,4738
+simplibs/extractor_python/logic/_helpers/describe_source_failure.py,sha256=oyGV79aKYLICWpMs8AigxC_vGVoS-WF--jimk5dYys8,1091
+simplibs/extractor_python/logic/_helpers/find_decorator_spans.py,sha256=h4ideS4BsA764zurqsanGoRKYsbJ1HdgqnLhD206MTw,4250
+simplibs/extractor_python/logic/_helpers/find_docstrings.py,sha256=uRpLTa9vlqHyOi-PONLIQ21u9mgE3rHRSy0J95TG06M,1363
+simplibs/extractor_python/logic/_helpers/find_imports.py,sha256=2ic-4z6xMUxs-5Lt1rU1AbGl_O7eXfM4ezUYKMiiEWI,964
+simplibs/extractor_python/logic/_helpers/first_doc_line.py,sha256=u7eWP-zDOxQdfbF3LF7t5dTcVtYGnJ8QazIPhS03nU4,1098
+simplibs/extractor_python/logic/_helpers/format_type_params.py,sha256=epjG54vbgbrsC-2EN-t9tkGBHwuFf0vX4cU_Jyj7FxA,864
+simplibs/extractor_python/logic/_helpers/guarded_parse.py,sha256=12aPHBAx9nS-gPmVGP-aKtYtFPU9nzn3DCRFTZjn_As,2131
+simplibs/extractor_python/logic/_helpers/outline_node.py,sha256=FpaIeRtEqfAU7RTI-_qs_6wgvJyOW1d_a72jWSuI_Fc,2605
+simplibs/extractor_python/logic/_helpers/parse_python.py,sha256=upxHTYCsoHr0PIfZnGxHqbvCVSSUXwRuNYo3krmBG94,828
+simplibs/extractor_python/logic/_validations/__init__.py,sha256=UzgZVSbnmGfoJ3eTrIccAd7rvrukC5tkivqQUF2-Js4,479
+simplibs/extractor_python/logic/_validations/raise_python_source_error.py,sha256=Z0PadMy1UGX2H7SH9ddMepp4-J0IonPZoch_0sTaM50,2038
+simplibs/extractor_python/plugin/__init__.py,sha256=0GaexU-zzsefGjqkoyvlKSyrAIvc7abPiYKDFFGFvHk,438
+simplibs/extractor_python/plugin/register_all.py,sha256=_jvHztkxEI2EsM-xwnE-US1YYnyTvmwooR9j8KMRBj8,1517
+simplibs/extractor_python/presets/PYTHON_CLEAN.py,sha256=Kct4MI43HkwsZETJtFQ1AXDhoj4YjGq6MCu-NF11iP8,857
+simplibs/extractor_python/presets/PYTHON_NO_IMPORTS.py,sha256=Wh290eGqG_FRm2mjcF-5lj2VaVs8hWVSpihhCrPkfu4,803
+simplibs/extractor_python/presets/__init__.py,sha256=kl3Cz7Ra6jQBwnB2QowD0lsKFRCCQh8SNwd_u_faNw4,984
+simplibs/extractor_python/profiles/PYTHON_CODE_CLEAN.py,sha256=Am_vOABW4nAUADUutqfHxfYjD2gkVT7-W6To3lwFzdI,822
+simplibs/extractor_python/profiles/PYTHON_CODE_NO_IMPORTS.py,sha256=sjlITwDHslYVnqlsyM_U6rHDJPf-AlikYwUm7u3PmJY,783
+simplibs/extractor_python/profiles/PYTHON_DATA_ALL.py,sha256=dvHyfIgo5vwoECBKSaiuVm9IvwbvfGsVgICCioV9gwg,599
+simplibs/extractor_python/profiles/PYTHON_OUTLINE.py,sha256=lB8II9N3P2clSCsQ-RsTF1ZjTkGJBdT4aKhfKUz63Is,839
+simplibs/extractor_python/profiles/PYTHON_PROFILES.py,sha256=Fu-72uFobbUd7Ra1dmmW4_VNTVCOLbDRQhNvED0tPC8,677
+simplibs/extractor_python/profiles/PYTHON_SRC_CLEAN.py,sha256=6vI7zLba9hqh9xsiwiJBaljDAC74pUWNZqT65TYBX14,832
+simplibs/extractor_python/profiles/__init__.py,sha256=sLrXap2lVbXwo_7Z6H_XVVpjE39FqeRhYIRn0G6VNJc,1947
+simplibs_extractor_python-0.1.0.dist-info/licenses/LICENSE,sha256=iMJUFcbjkLu6dZpunWGLySIYPdMK_vu8PcVbmAKkph4,1100
+simplibs_extractor_python-0.1.0.dist-info/METADATA,sha256=26NAuHoVTWSW40ss5Rv2hN_3ibMY_58df0-MvvX1TIc,30019
+simplibs_extractor_python-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+simplibs_extractor_python-0.1.0.dist-info/entry_points.txt,sha256=KxEqzHINukoS-tWHNcADRUbanA9FM9btvpI4hL3me5M,77
+simplibs_extractor_python-0.1.0.dist-info/top_level.txt,sha256=xaQIA-7fMYUXhc2gGL2-moaltZWXucNiTVXBx-lNB3I,9
+simplibs_extractor_python-0.1.0.dist-info/RECORD,,

simplibs_extractor_python-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

simplibs_extractor_python-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[simplibs.extractor.plugins]
+python = simplibs.extractor_python:register_all

simplibs_extractor_python-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dalibor Sova (Sudip2708)
+
+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.

simplibs_extractor_python-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+simplibs