markitecture 0.2.1__tar.gz → 0.2.3__tar.gz
Sign up to get free protection for your applications and to get access to all the features.
- {markitecture-0.2.1 → markitecture-0.2.3}/.gitignore +1 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/Makefile +3 -2
- {markitecture-0.2.1 → markitecture-0.2.3}/PKG-INFO +13 -4
- {markitecture-0.2.1 → markitecture-0.2.3}/README.md +12 -3
- {markitecture-0.2.1 → markitecture-0.2.3}/pyproject.toml +1 -1
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/errors.py +9 -3
- {markitecture-0.2.1 → markitecture-0.2.3}/uv.lock +572 -863
- {markitecture-0.2.1 → markitecture-0.2.3}/.ruff.toml +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/CONTRIBUTING.md +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/LICENSE +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/badges/compact.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/badges/detailed.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/badges/minimal.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/badges/modern.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/badges/retro.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/badges/shields.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/buttons/rectangle.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/buttons/vesica-piscis.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/callouts/designs.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/callouts/info.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/cookbooks/examples.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/favicon.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/line.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/logos/circle-dark.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/logos/circle-light.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/logos/logo-box.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/logos/logo-rectangle.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/logos/logo.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/assets/shield.svg +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/community.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/features/content-analysis.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/features/health-score.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/features/link-management.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/features/static-site-generation.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/features/text-splitting.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/guides/api-reference.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/guides/cli-reference.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/guides/configuration.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/guides/installation.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/guides/quickstart.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/index.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/mint.json +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/docs/philosophy.mdx +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/__main__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/cli/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/cli/app.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/cli/commands/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/cli/commands/config.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/cli/commands/links.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/cli/commands/metrics.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/cli/commands/mkdocs.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/cli/commands/split.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/generators/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/generators/configs/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/generators/configs/mintlify_json.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/generators/configs/mkdocs_yaml.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/metrics/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/metrics/analyzer.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/metrics/badges/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/metrics/badges/base.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/metrics/badges/compact.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/metrics/badges/detailed.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/metrics/badges/minimal.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/metrics/badges/modern.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/metrics/badges/retro.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/metrics/badges/shields.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/metrics/svg_generator.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/processing/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/processing/link_validator.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/processing/reflink_converter.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/processing/reflink_extractor.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/processing/text_splitter.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/settings/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/settings/config.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/settings/validators.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/utils/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/utils/file_handler.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/utils/printer.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/src/markitecture/utils/sanitizer.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/cli/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/cli/commands/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/cli/test_app.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/conftest.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/data/mistletoe.md +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/data/pydantic.md +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/data/readme-ai.html +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/data/readme-ai.md +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/generators/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/metrics/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/metrics/test_analyzer.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/metrics/test_svg_generator.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/processing/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/processing/test_link_validator.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/processing/test_reflink_converter.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/settings/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/settings/test_validators.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/test_validators.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/utils/__init__.py +0 -0
- {markitecture-0.2.1 → markitecture-0.2.3}/tests/utils/test_sanitizer.py +0 -0
@@ -7,7 +7,7 @@ MAKEFLAGS += --no-builtin-rules
|
|
7
7
|
|
8
8
|
DOCS_DIR := docs
|
9
9
|
PYPROJECT_TOML := pyproject.toml
|
10
|
-
PYPI_VERSION := 0.2.
|
10
|
+
PYPI_VERSION := 0.2.3
|
11
11
|
PYTHON_VERSION := 3.11
|
12
12
|
TARGET := src/markitecture
|
13
13
|
TARGET_TEST := tests
|
@@ -131,10 +131,11 @@ run-pypi: ## Run examples for documentation
|
|
131
131
|
uvx --from markitecture markitect --split.i $(TEST_DATA) --split.o examples/text-splitter/pypi/header-3/ --split.level "###"
|
132
132
|
uvx --from markitecture markitect --split.i $(TEST_DATA) --split.o examples/text-splitter/pypi/header-4/ --split.level "####"
|
133
133
|
uvx --from markitecture markitect --reflinks.i tests/data/pydantic.md --reflinks.o examples/reference-links/reflinks_conversion.md
|
134
|
+
uvx --from markitecture --isolated markitect --metrics.input $HOME/Projects/GitHub/readme-ai/README.md --metrics.style all --metrics.output-dir markitet_badges
|
134
135
|
|
135
136
|
|
136
137
|
# -------------------------------------------------------------------
|
137
|
-
# Utils:
|
138
|
+
# Utils: Commands for cleaning up and managing the project
|
138
139
|
# -------------------------------------------------------------------
|
139
140
|
|
140
141
|
|
@@ -1,6 +1,6 @@
|
|
1
1
|
Metadata-Version: 2.4
|
2
2
|
Name: markitecture
|
3
|
-
Version: 0.2.
|
3
|
+
Version: 0.2.3
|
4
4
|
Summary: ❂ Markdown tools for modular and flexible docs: link validation, reference link conversion, text splitting, & more.
|
5
5
|
Project-URL: documentation, https://github.com/eli64s/markitecture/blob/main/README.md
|
6
6
|
Project-URL: homepage, https://github.com/eli64s/markitecture
|
@@ -43,7 +43,7 @@ Description-Content-Type: text/markdown
|
|
43
43
|
</picture>
|
44
44
|
|
45
45
|
<h3 align="center">
|
46
|
-
|
46
|
+
The Architecture of Better Documentation.
|
47
47
|
</h3>
|
48
48
|
<p align="center">
|
49
49
|
<em>Markitecture: The Python toolkit that empowers modular Markdown workflows.</em>
|
@@ -239,11 +239,17 @@ Contributions are welcome! Whether it's bug reports, feature requests, or code c
|
|
239
239
|
Copyright © 2024-2025 [Markitecture][markitecture]. <br />
|
240
240
|
Released under the [MIT][mit-license] license.
|
241
241
|
|
242
|
-
<div align="
|
242
|
+
<div align="right">
|
243
|
+
|
244
|
+
[![][back-to-top]](https://github.com/eli64s/markitecture/tree/main/#top)
|
245
|
+
|
246
|
+
</div>
|
247
|
+
|
248
|
+
<!-- <div align="left">
|
243
249
|
<a href="#top">
|
244
250
|
<img src="https://raw.githubusercontent.com/eli64s/markitecture/77bec69129dd3a075d7d0816c7bd826da131ccc7/docs/assets/buttons/rectangle.svg" width="100px" height="100px" alt="Return to Top">
|
245
251
|
</a>
|
246
|
-
</div>
|
252
|
+
</div> -->
|
247
253
|
|
248
254
|
<div align="center">
|
249
255
|
<img src="https://raw.githubusercontent.com/eli64s/markitecture/216a92894e6f30c707a214fad5a5fba417e3bc39/docs/assets/line.svg" alt="separator" width="100%" height="2px" style="margin: 20px 0;">
|
@@ -252,6 +258,9 @@ Released under the [MIT][mit-license] license.
|
|
252
258
|
|
253
259
|
<!-- REFERENCE LINKS -->
|
254
260
|
|
261
|
+
<!-- BADGES -->
|
262
|
+
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-7934C5?style=flat-square
|
263
|
+
|
255
264
|
<!-- PROJECT RESOURCES -->
|
256
265
|
[pypi]: https://pypi.org/project/markitecture/
|
257
266
|
[markitecture]: https://github.com/eli64s/markitecture
|
@@ -8,7 +8,7 @@
|
|
8
8
|
</picture>
|
9
9
|
|
10
10
|
<h3 align="center">
|
11
|
-
|
11
|
+
The Architecture of Better Documentation.
|
12
12
|
</h3>
|
13
13
|
<p align="center">
|
14
14
|
<em>Markitecture: The Python toolkit that empowers modular Markdown workflows.</em>
|
@@ -204,11 +204,17 @@ Contributions are welcome! Whether it's bug reports, feature requests, or code c
|
|
204
204
|
Copyright © 2024-2025 [Markitecture][markitecture]. <br />
|
205
205
|
Released under the [MIT][mit-license] license.
|
206
206
|
|
207
|
-
<div align="
|
207
|
+
<div align="right">
|
208
|
+
|
209
|
+
[![][back-to-top]](#top)
|
210
|
+
|
211
|
+
</div>
|
212
|
+
|
213
|
+
<!-- <div align="left">
|
208
214
|
<a href="#top">
|
209
215
|
<img src="https://raw.githubusercontent.com/eli64s/markitecture/77bec69129dd3a075d7d0816c7bd826da131ccc7/docs/assets/buttons/rectangle.svg" width="100px" height="100px" alt="Return to Top">
|
210
216
|
</a>
|
211
|
-
</div>
|
217
|
+
</div> -->
|
212
218
|
|
213
219
|
<div align="center">
|
214
220
|
<img src="https://raw.githubusercontent.com/eli64s/markitecture/216a92894e6f30c707a214fad5a5fba417e3bc39/docs/assets/line.svg" alt="separator" width="100%" height="2px" style="margin: 20px 0;">
|
@@ -217,6 +223,9 @@ Released under the [MIT][mit-license] license.
|
|
217
223
|
|
218
224
|
<!-- REFERENCE LINKS -->
|
219
225
|
|
226
|
+
<!-- BADGES -->
|
227
|
+
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-7934C5?style=flat-square
|
228
|
+
|
220
229
|
<!-- PROJECT RESOURCES -->
|
221
230
|
[pypi]: https://pypi.org/project/markitecture/
|
222
231
|
[markitecture]: https://github.com/eli64s/markitecture
|
@@ -4,7 +4,7 @@ requires = [ "hatch-fancy-pypi-readme", "hatchling" ]
|
|
4
4
|
|
5
5
|
[project]
|
6
6
|
name = "markitecture"
|
7
|
-
version = "0.2.
|
7
|
+
version = "0.2.3"
|
8
8
|
description = "❂ Markdown tools for modular and flexible docs: link validation, reference link conversion, text splitting, & more."
|
9
9
|
dynamic = ["readme"]
|
10
10
|
keywords = [
|
@@ -4,7 +4,9 @@ from __future__ import annotations
|
|
4
4
|
|
5
5
|
from typing import Any
|
6
6
|
|
7
|
-
#
|
7
|
+
# -------------------------------------------------------------------
|
8
|
+
# Base Exceptions
|
9
|
+
# -------------------------------------------------------------------
|
8
10
|
|
9
11
|
|
10
12
|
class MarkitectureBaseError(Exception):
|
@@ -25,7 +27,9 @@ class FileOperationError(MarkitectureBaseError):
|
|
25
27
|
...
|
26
28
|
|
27
29
|
|
28
|
-
#
|
30
|
+
# -------------------------------------------------------------------
|
31
|
+
# Command-Line Interface (CLI) Exceptions
|
32
|
+
# -------------------------------------------------------------------
|
29
33
|
|
30
34
|
|
31
35
|
class CLIError(MarkitectureBaseError):
|
@@ -35,7 +39,9 @@ class CLIError(MarkitectureBaseError):
|
|
35
39
|
super().__init__(f"Invalid option provided to CLI: {message}", *args)
|
36
40
|
|
37
41
|
|
38
|
-
#
|
42
|
+
# -------------------------------------------------------------------
|
43
|
+
# File System Exceptions
|
44
|
+
# -------------------------------------------------------------------
|
39
45
|
|
40
46
|
|
41
47
|
class FileSystemError(MarkitectureBaseError):
|