markitecture 0.1.15__py3-none-any.whl

markitecture-0.1.15.dist-info/METADATA

@@ -0,0 +1,271 @@
+Metadata-Version: 2.4
+Name: markitecture
+Version: 0.1.15
+Summary: ❂ Markdown tools for modular and flexible docs: link validation, reference link conversion, text splitting, & more.
+Project-URL: documentation, https://github.com/eli64s/markitecture/blob/main/README.md
+Project-URL: homepage, https://github.com/eli64s/markitecture
+Project-URL: repository, https://github.com/eli64s/markitecture
+Author-email: Eli Salamie <egsalamie@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: automated-markdown,content-management,documentation-tools,intelligent-documentation,markdown-ai,markdown-link-checker,markdown-parser,markdown-splitter,markdown-tools,mkdocs,modular-docs,readme-generator,reference-links,smart-markdown
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Pydantic
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: <=3.14,>=3.10
+Requires-Dist: httpx
+Requires-Dist: pydantic
+Requires-Dist: pydantic-settings
+Requires-Dist: pyyaml
+Requires-Dist: rich
+Requires-Dist: toml; python_full_version < '3.11'
+Description-Content-Type: text/markdown
+
+<div id="top" align="center">
+
+<!-- HEADER -->
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/eli64s/markitecture/13c4b28213fb8e8c75299ef5c905ce1d195a6988/docs/assets/logos/circle-dark.svg">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/eli64s/markitecture/13c4b28213fb8e8c75299ef5c905ce1d195a6988/docs/assets/logos/circle-light.svg">
+  <img alt="markitecture Logo" src="https://raw.githubusercontent.com/eli64s/markitecture/13c4b28213fb8e8c75299ef5c905ce1d195a6988/docs/assets/logos/circle-light.svg" width="900" style="max-width: 100%;">
+</picture>
+
+<h3 align="center">
+   Building Blocks for Brilliant Documentation.
+</h3>
+<p align="center">
+  <em>Markitecture: The Python toolkit that empowers modular Markdown workflows.</em>
+</p>
+
+<!-- BADGES -->
+<div align="center">
+  <p align="center" style="margin-bottom: 20px;">
+    <a href="https://github.com/eli64s/markitecture/actions">
+      <img src="https://img.shields.io/github/actions/workflow/status/eli64s/markitecture/ci.yml?label=CI&style=flat&logo=githubactions&logoColor=white&labelColor=2A2A2A&color=FFD700" alt="GitHub Actions" />
+    </a>
+    <a href="https://app.codecov.io/gh/eli64s/markitecture">
+      <img src="https://img.shields.io/codecov/c/github/eli64s/markitecture?label=Coverage&style=flat&logo=codecov&logoColor=white&labelColor=2A2A2A&color=3fe1c0" alt="Coverage" />
+    </a>
+    <a href="https://pypi.org/project/markitecture/">
+      <img src="https://img.shields.io/pypi/v/markitecture?label=PyPI&style=flat&logo=pypi&logoColor=white&labelColor=2A2A2A&color=00E5FF" alt="PyPI Version" />
+    </a>
+    <a href="https://github.com/eli64s/markitecture">
+      <img src="https://img.shields.io/pypi/pyversions/markitecture?label=Python&style=flat&logo=python&logoColor=white&labelColor=2A2A2A&color=7934C5" alt="Python Version" />
+    </a>
+    <a href="https://opensource.org/license/mit/">
+      <img src="https://img.shields.io/github/license/eli64s/markitecture?label=License&style=flat&logo=opensourceinitiative&logoColor=white&labelColor=2A2A2A&color=FF00FF" alt="MIT License">
+    </a>
+  </p>
+</div>
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/eli64s/markitecture/216a92894e6f30c707a214fad5a5fba417e3bc39/docs/assets/line.svg" alt="separator" width="100%" height="2px" style="margin: 20px 0;">
+</div>
+
+</div>
+<!-- HEADER END -->
+
+## What is Markitecture?
+
+**Markitecture** is a comprehensive Python toolkit designed to streamline your Markdown workflow. Whether you're managing documentation, writing technical content, or maintaining a knowledge base, Markitecture provides essential utilities to make working with Markdown files easier and more efficient.
+
+### Key Features
+
+- **Text Splitting:** Break down large Markdown files into manageable sections based on headings or custom rules.
+- **Link Management:** Convert between inline and reference-style links, validate URLs, and identify broken links.
+- **Content Analysis:** Analyze document structure, extract metadata, and ensure consistent formatting.
+- **Documentation Tools:** Generate configurations for static site generators like [MkDocs][mkdocs].
+
+---
+
+## Quick Start
+
+### Installation
+
+Install from [PyPI][pypi] using your preferred package manager.
+
+#### <img width="2%" src="https://simpleicons.org/icons/python.svg">&emsp13;pip
+
+Use [pip][pip] (recommended for most users):
+
+```sh
+pip install -U markitecture
+```
+
+#### <img width="2%" src="https://simpleicons.org/icons/pipx.svg">&emsp13;pipx
+
+Install in an isolated environment with [pipx][pipx]:
+
+```sh
+❯ pipx install markitecture
+```
+
+#### <img width="2%" src="https://simpleicons.org/icons/uv.svg">&emsp13;uv
+
+For the fastest installation use [uv][uv]:
+
+```sh
+❯ uv tool install markitecture
+```
+
+### Using the CLI
+
+#### Text Splitting
+
+Split large Markdown files into smaller, organized sections:
+
+```sh
+markitect \
+    --split.i tests/data/readme-ai.md \
+    --split.o examples/split-sections-h2
+```
+
+#### Link Validation
+
+Check for broken links in your documentation:
+
+```sh
+markitect --check-links.input tests/data/pydantic.md
+```
+
+In your terminal, you'll see a summary of the results:
+
+```console
+
+Markdown Link Check Results
+
+┏━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓
+┃ Status ┃ Line ┃ Link                                                                              ┃ Error    ┃
+┡━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩
+│ ✓      │ 2    │ https://img.shields.io/github/actions/workflow/status/pydantic/pydantic/ci.yml?b… │          │
+│ ✓      │ 3    │ https://coverage-badge.samuelcolvin.workers.dev/pydantic/pydantic.svg             │          │
+│ ✓      │ 4    │ https://img.shields.io/pypi/v/pydantic.svg                                        │          │
+│ ✓      │ 5    │ https://img.shields.io/conda/v/conda-forge/pydantic.svg                           │          │
+│ ✓      │ 6    │ https://static.pepy.tech/badge/pydantic/month                                     │          │
+│ ✓      │ 7    │ https://img.shields.io/pypi/pyversions/pydantic.svg                               │          │
+│ ✓      │ 8    │ https://img.shields.io/github/license/pydantic/pydantic.svg                       │          │
+│ ✓      │ 9    │ https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/p… │          │
+│ ✓      │ 18   │ https://pydantic.dev/articles/logfire-announcement                                │          │
+│ ✓      │ 24   │ https://docs.pydantic.dev/                                                        │          │
+│ ✓      │ 24   │ https://github.com/pydantic/pydantic/tree/1.10.X-fixes                            │          │
+│ ✓      │ 28   │ https://docs.pydantic.dev/                                                        │          │
+│ 𝗫      │ 34   │ https://docs.pydantic.dev/install/invalid-link                                    │ HTTP 404 │
+└────────┴──────┴───────────────────────────────────────────────────────────────────────────────────┴──────────┘
+
+Summary: 1 broken links out of 13 total links.
+```
+
+#### Reference Link Conversion
+
+In Markdown, [reference-style links][reflinks] let you write cleaner text by keeping URLs in a reference section - think footnotes for the web.
+
+To convert inline links to reference-style links:
+
+```sh
+markitect \
+    --reflinks.input tests/data/pydantic.md \
+    --reflinks.output with_refs.md
+```
+
+#### Static Site Configuration Generation
+
+Generate a MkDocs configuration [(mkdocs.yml)][mkdocs.yml] from a given Markdown file.
+
+1. Split the Markdown file into sections:
+
+    ```sh
+    markitect \
+        --split.i tests/data/readme-ai.md \
+        --split.o examples/split-sections-h2
+    ```
+
+2. Generate the MkDocs configuration:
+
+    ```sh
+    markitect \
+        --mkdocs.dir examples/split-sections-h2 \
+        --mkdocs.site-name "MyDocsSite"
+    ```
+
+<sub>
+
+See additional example and usage details in the [here][examples].
+
+</sub>
+
+<!--
+>[!NOTE]
+> Explore the [Official Documentation][docs] for more detailed guides and examples.
+-->
+
+---
+
+## Roadmap
+
+- [ ] Support for additional documentation formats (e.g., reStructuredText, HTML)
+- [ ] Enhanced link management utilities
+- [ ] Improved content analysis features
+- [ ] Integration with more static site generators
+- [ ] Plugin system for custom utilities
+- [ ] More intuitive CLI commands and options
+
+---
+
+## Contributing
+
+Contributions are welcome! Whether it's bug reports, feature requests, or code contributions, please feel free to:
+
+- Open an [issue][github-issues]
+- Submit a [pull request][github-pulls]
+- Improve documentation, write tutorials, etc.
+- Share your feedback and suggestions
+
+---
+
+## License
+
+Copyright © 2024-2025 [Markitecture][markitecture]. <br />
+Released under the [MIT][mit-license] license.
+
+<div align="left">
+  <a href="#top">
+    <img src="https://raw.githubusercontent.com/eli64s/markitecture/77bec69129dd3a075d7d0816c7bd826da131ccc7/docs/assets/buttons/rectangle.svg" width="100px" height="100px" alt="Return to Top">
+  </a>
+</div>
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/eli64s/markitecture/216a92894e6f30c707a214fad5a5fba417e3bc39/docs/assets/line.svg" alt="separator" width="100%" height="2px" style="margin: 20px 0;">
+</div>
+
+
+<!-- REFERENCE LINKS -->
+
+<!-- PROJECT RESOURCES -->
+[pypi]: https://pypi.org/project/markitecture/
+[markitecture]: https://github.com/eli64s/markitecture
+[github-issues]: https://github.com/eli64s/markitecture/issues
+[github-pulls]: https://github.com/eli64s/markitecture/pulls
+[mit-license]: https://github.com/eli64s/markitecture/blob/main/LICENSE
+[examples]: https://github.com/eli64s/markitecture/tree/main/examples
+
+<!-- DEVELOPER TOOLS -->
+[python]: https://www.python.org/
+[pip]: https://pip.pypa.io/en/stable/
+[pipx]: https://pipx.pypa.io/stable/
+[uv]: https://docs.astral.sh/uv/
+[mkdocs]: https://www.mkdocs.org/
+[mkdocs.yml]: https://www.mkdocs.org/user-guide/configuration/
+
+<!-- RESOURCES -->
+[reflinks]: https://www.markdownguide.org/basic-syntax/#reference-style-links

markitecture-0.1.15.dist-info/RECORD

@@ -0,0 +1,43 @@
+markitecture/__init__.py,sha256=gE8YEGeliYuntbLAMEAm3Q6d9M9p2CNlkuX7Soolb90,986
+markitecture/__main__.py,sha256=dpolm4cutAQQMX5n20Lx0MXxMZokzaI0W3ieXKhwRno,83
+markitecture/errors.py,sha256=QhainV4ofuezJuhXLt2AVKPyUPYIyUnNNWS78YfuQ1c,1219
+markitecture/cli/__init__.py,sha256=dsYvYkXGLj2RV64cwxk4K0HNsR8AJAFh0QwIxMw5MOc,64
+markitecture/cli/app.py,sha256=Jk8tisqVe6zNzdSrJ3JFuQKPMGD61hBoiwGkkmAOfkE,1113
+markitecture/cli/commands/__init__.py,sha256=9Ww1F_DKzNnfEmdLyh3Lox7l9STuUtq_b4hF6NSDiUM,568
+markitecture/cli/commands/config.py,sha256=8YA20XSBRx5_lJWsoYyFZhjq2-qlkQ3SbGGUltIr1RQ,2695
+markitecture/cli/commands/links.py,sha256=joxc4CJWODs3lwquQ2qbe-rXwAgHWQzQxWk_NQtswYk,4821
+markitecture/cli/commands/metrics.py,sha256=h0_aDL1NBSNQuHiT4rJ8RrLXU8klK8l1zDWYirehym0,6715
+markitecture/cli/commands/mkdocs.py,sha256=Fb0uzpiZLZdNZxbDRRDr0ur1PtM4IXk5MlHdM3SmPDQ,1270
+markitecture/cli/commands/split.py,sha256=tdTxclPrt-Zo8bxOQ3gxocNPAa_7yXomMELZFfs7AWc,1715
+markitecture/generators/__init__.py,sha256=naQqfmmntGvGDdIgJhpIPZRVjYLeS0Ab-88dOZAsQQg,108
+markitecture/generators/configs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+markitecture/generators/configs/mintlify_json.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+markitecture/generators/configs/mkdocs_yaml.py,sha256=ABe2XWxrf17vPA8w4YhpqMgR972i_CLHldDYMgkE8Ts,10895
+markitecture/metrics/__init__.py,sha256=XmutCXu8czKLuXdqSp7ynN9xWMAdVlnm4mlZG_Dl3UA,274
+markitecture/metrics/analyzer.py,sha256=_gxET8of9ye2k1UF_4ar1QkdP25zIKJ9qBymFxiMZhA,4304
+markitecture/metrics/svg_generator.py,sha256=UEK_Mh6TYV5rgPcowGK1ivn5OVHYO3FK9tjTf_A5378,2760
+markitecture/metrics/badges/__init__.py,sha256=ojF3_MEFqC7OSyjXByRcQAob6i36bxV89qGVu1piu38,817
+markitecture/metrics/badges/base.py,sha256=Id5xHmPwkSp2yubbwx351aoNfjPRDx3CIT9crS0iT30,288
+markitecture/metrics/badges/compact.py,sha256=xXCb-3Yu61Je9K7JwmJiDJEdqhVf4Oc8NQBdLPc9N8I,1446
+markitecture/metrics/badges/detailed.py,sha256=YO_AUOK8SxXA0to7mOFHsMjNSFPPzOGCtWdXPRNkb80,3299
+markitecture/metrics/badges/minimal.py,sha256=nzMWeSm__ZnCBKuCiDobX1cmHuL9A04VOCosVywp2-E,915
+markitecture/metrics/badges/modern.py,sha256=gtkWnr3ohcNeH9LAdhoYpXOhiHCx4-s8yx35P-ugOtI,2210
+markitecture/metrics/badges/retro.py,sha256=8-2hqFZOQTp7cxXgiu-KF0Q3nkAfXPBLFihAXpIpYcQ,1588
+markitecture/metrics/badges/shields.py,sha256=rCM8R2k0IBK4qHdtarYdpXR_w6fkvOQyLBZXz8o_sDQ,5810
+markitecture/processing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+markitecture/processing/link_validator.py,sha256=UwTBl_YloqR0gUZNbIh48eU18e9I1bEqM3GAM0-X10c,4188
+markitecture/processing/reflink_converter.py,sha256=1U9X0GzqmsLhFioD4xzp4Y2mkTolvzCNBheBn-0OTdE,6958
+markitecture/processing/reflink_extractor.py,sha256=yGAeDt9mw3ItiTcQheP9V5LNLV8I9OvvOxV5Qs0K7Og,2855
+markitecture/processing/text_splitter.py,sha256=1s-wI_GnDF0xK3yIR8Fi9MLjvgh1OleNyvNvskVjOHA,11042
+markitecture/settings/__init__.py,sha256=0-5lcEiin8-WlNAhiSm32rMZ-hzyT0KDbwg19OXhQ8o,215
+markitecture/settings/config.py,sha256=RbOdDon3xzfrkGP8SIkLsp80-F2Zvu8TZP3rJ7L9xAE,2127
+markitecture/settings/validators.py,sha256=dJRmIO5RBawn2jmtOCmYrDrorSytr2btfhURq9Rg0jc,672
+markitecture/utils/__init__.py,sha256=y6ur3d-KUAE7WRMTmBV41QqwcoVHoMxZB8Ba2JoD1SU,175
+markitecture/utils/file_handler.py,sha256=ixFzMGgLh5DMwK7zUwyn_Fjk7z3OOvNbKn4uxpzIIPU,863
+markitecture/utils/printer.py,sha256=dPywBAS6qh3sKFhwB8D2Pe9TqsoeDH600Wt4RMMjGos,6948
+markitecture/utils/sanitizer.py,sha256=MjfVMSkXFP3X9_A8czqzGkE5u9RAM8TosuhfWsEbUJg,2227
+markitecture-0.1.15.dist-info/METADATA,sha256=1w6o9qSoVPMMudopLdHsMHePXCNQDufmJX_F6q3wnaQ,11704
+markitecture-0.1.15.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+markitecture-0.1.15.dist-info/entry_points.txt,sha256=neXBHoMEodLhdSjfqVoz9fnKODF_tdolI40Xm06F2pk,60
+markitecture-0.1.15.dist-info/licenses/LICENSE,sha256=_lS8UU-SncVp61_NHQp9PHIAiDZtNuKYeaqyFDiF6Bk,1109
+markitecture-0.1.15.dist-info/RECORD,,

markitecture-0.1.15.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

markitecture-0.1.15.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+markitect = markitecture.__main__:run_cli

markitecture-0.1.15.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 to present Markitecture and individual contributors.
+
+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.