markitecture 0.2.2__tar.gz → 0.2.31__tar.gz

{markitecture-0.2.2 → markitecture-0.2.31}/Makefile

@@ -7,17 +7,40 @@ MAKEFLAGS += --no-builtin-rules
 
 DOCS_DIR := docs
 PYPROJECT_TOML := pyproject.toml
-PYPI_VERSION := 0.2.2
+PYPI_VERSION := 0.2.31
 PYTHON_VERSION := 3.11
 TARGET := src/markitecture
 TARGET_TEST := tests
-TEST_DATA := tests/data/readme-ai.md
 
+# -------------------------
+# Repository Cleanup
+# -------------------------
+
+clean: clean-build clean-pyc clean-test ## Remove all build, test, coverage, and Python artifacts
+
+clean-build: ## Remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## Remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## Remove test and coverage artifacts
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+	rm -fr .pytest_cache
 
-# -------------------------------------------------------------------
-# Build: Build the distribution package using uv
-# -------------------------------------------------------------------
 
+# -------------------------
+# Development Environment
+# -------------------------
 
 .PHONY: build
 build: ## Build the distribution package using uv
@@ -50,18 +73,18 @@ venv: ## Create a virtual environment
 	uv venv --python $(PYTHON_VERSION)
 
 
-# -------------------------------------------------------------------
-# Documenation: Build and serve static site using MkDocs
-# -------------------------------------------------------------------
+# -------------------------
+# Documentation
+# -------------------------
 
 .PHONY: docs
 docs: ## Serve mintlify documentation locally
 	cd $(DOCS_DIR) && npx mintlify dev --verbose
 
 
-# -------------------------------------------------------------------
-# Format & Lint: Format and lint Python files using Ruff and MyPy
-# -------------------------------------------------------------------
+# -------------------------
+# Format & Lint
+# -------------------------
 
 
 .PHONY: format-toml
@@ -90,20 +113,20 @@ typecheck-pyright: ## Type-check Python files using Pyright
 	uv run pyright $(TARGET)
 
 
-# -------------------------------------------------------------------
-# Tests: Run test suite using Pytest
-# -------------------------------------------------------------------
-
+# -------------------------
+# Tests
+# -------------------------
 
 .PHONY: test
 test: ## Run test suite using Pytest
 	uv run pytest $(TARGET_TEST) --config-file $(PYPROJECT_TOML)
 
 
-# -------------------------------------------------------------------
-# Examples: Batch run CLI examples for documentation and testing
-# -------------------------------------------------------------------
+# -------------------------
+# CLI Batch Testing
+# -------------------------
 
+TEST_DATA := tests/data/readme-ai.md
 
 .PHONY: run-examples
 run-examples: ## Run examples for documentation and testing
@@ -131,34 +154,16 @@ run-pypi: ## Run examples for documentation
 	uvx --from markitecture markitect --split.i $(TEST_DATA) --split.o examples/text-splitter/pypi/header-3/ --split.level "###"
 	uvx --from markitecture markitect --split.i $(TEST_DATA) --split.o examples/text-splitter/pypi/header-4/ --split.level "####"
 	uvx --from markitecture markitect --reflinks.i tests/data/pydantic.md --reflinks.o examples/reference-links/reflinks_conversion.md
+	uvx --from markitecture --isolated markitect --metrics.input $HOME/Projects/GitHub/readme-ai/README.md --metrics.style all --metrics.output-dir markitet_badges
 
 
-# -------------------------------------------------------------------
-# Utils: Utility commands for managing the project
-# -------------------------------------------------------------------
-
-
-clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
-
-clean-build: ## remove build artifacts
-	rm -fr build/
-	rm -fr dist/
-	rm -fr .eggs/
-	rm -fr .venv/
-	find . -name '*.egg-info' -exec rm -fr {} +
-	find . -name '*.egg' -exec rm -f {} +
+# -------------------------
+# Utils
+# -------------------------
 
-clean-pyc: ## remove Python file artifacts
-	find . -name '*.pyc' -exec rm -f {} +
-	find . -name '*.pyo' -exec rm -f {} +
-	find . -name '*~' -exec rm -f {} +
-	find . -name '__pycache__' -exec rm -fr {} +
+bump-version:
+	python scripts/bump_version.py src/markitecture/version.py patch
 
-clean-test: ## remove test and coverage artifacts
-	rm -fr .tox/
-	rm -f .coverage
-	rm -fr htmlcov/
-	rm -fr .pytest_cache
 
 .PHONY: help
 help: ## Display this help

{markitecture-0.2.2 → markitecture-0.2.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: markitecture
-Version: 0.2.2
+Version: 0.2.31
 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
@@ -43,7 +43,7 @@ Description-Content-Type: text/markdown
 </picture>
 
 <h3 align="center">
-   Building Blocks for Brilliant Documentation.
+   The Architecture of Better Documentation.
 </h3>
 <p align="center">
   <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
 Copyright © 2024-2025 [Markitecture][markitecture]. <br />
 Released under the [MIT][mit-license] license.
 
-<div align="left">
+<div align="right">
+
+[![][back-to-top]](https://github.com/eli64s/markitecture/tree/main/#top)
+
+</div>
+
+<!-- <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> -->
 
 <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;">
@@ -252,6 +258,9 @@ Released under the [MIT][mit-license] license.
 
 <!-- REFERENCE LINKS -->
 
+<!-- BADGES -->
+[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-7934C5?style=flat-square
+
 <!-- PROJECT RESOURCES -->
 [pypi]: https://pypi.org/project/markitecture/
 [markitecture]: https://github.com/eli64s/markitecture

{markitecture-0.2.2 → markitecture-0.2.31}/README.md

@@ -8,7 +8,7 @@
 </picture>
 
 <h3 align="center">
-   Building Blocks for Brilliant Documentation.
+   The Architecture of Better Documentation.
 </h3>
 <p align="center">
   <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
 Copyright © 2024-2025 [Markitecture][markitecture]. <br />
 Released under the [MIT][mit-license] license.
 
-<div align="left">
+<div align="right">
+
+[![][back-to-top]](#top)
+
+</div>
+
+<!-- <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> -->
 
 <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;">
@@ -217,6 +223,9 @@ Released under the [MIT][mit-license] license.
 
 <!-- REFERENCE LINKS -->
 
+<!-- BADGES -->
+[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-7934C5?style=flat-square
+
 <!-- PROJECT RESOURCES -->
 [pypi]: https://pypi.org/project/markitecture/
 [markitecture]: https://github.com/eli64s/markitecture

{markitecture-0.2.2 → markitecture-0.2.31}/pyproject.toml

@@ -4,9 +4,8 @@ requires = [ "hatch-fancy-pypi-readme", "hatchling" ]
 
 [project]
 name = "markitecture"
-version = "0.2.2"
 description = "❂ Markdown tools for modular and flexible docs: link validation, reference link conversion, text splitting, & more."
-dynamic = ["readme"]
+dynamic = ["readme", "version"]
 keywords = [
     "automated-markdown",
     "content-management",
@@ -107,7 +106,7 @@ include = [
 ]
 
 [tool.hatch.version]
-path = 'src/markitecture/__init__.py'
+path = 'src/markitecture/version.py'
 
 [tool.hatch.metadata]
 allow-direct-references = true
@@ -127,16 +126,13 @@ path = "README.md"
 [tool.pytest.ini_options]
 addopts = [
     "-vv",
-    "-rfEsxX",
-    "--tb=short",
+    "-n=auto",
     "--durations=5",
     "--cov=src/",
     "--cov-branch",
-    "--cov-fail-under=1",
+    "--cov-fail-under=0",
     "--cov-report=term-missing:skip-covered",
     "--cov-report=json:tests/.reports/coverage.json",
-    "--asyncio-mode=auto",
-    "--numprocesses=auto",
 ]
 asyncio_default_fixture_loop_scope = "function"
 asyncio_mode = "auto"

{markitecture-0.2.2 → markitecture-0.2.31}/src/markitecture/__init__.py

@@ -1,5 +1,3 @@
-from importlib.metadata import version
-
 from markitecture import metrics
 
 from .errors import (
@@ -19,8 +17,7 @@ from .processing.reflink_converter import (
 from .processing.text_splitter import MarkdownTextSplitter
 from .utils.file_handler import FileHandler
 from .utils.printer import RichPrinter
-
-__version__ = version("markitecture")
+from .version import __version__
 
 __all__: list[str] = [
     "FileHandler",

{markitecture-0.2.2 → markitecture-0.2.31}/src/markitecture/errors.py

@@ -4,7 +4,9 @@ from __future__ import annotations
 
 from typing import Any
 
-# ----- Base ----- #
+# -------------------------------------------------------------------
+# Base Exceptions
+# -------------------------------------------------------------------
 
 
 class MarkitectureBaseError(Exception):
@@ -25,7 +27,9 @@ class FileOperationError(MarkitectureBaseError):
     ...
 
 
-# ----- CLI ----- #
+# -------------------------------------------------------------------
+# Command-Line Interface (CLI) Exceptions
+# -------------------------------------------------------------------
 
 
 class CLIError(MarkitectureBaseError):
@@ -35,7 +39,9 @@ class CLIError(MarkitectureBaseError):
         super().__init__(f"Invalid option provided to CLI: {message}", *args)
 
 
-# ----- File IO ----- #
+# -------------------------------------------------------------------
+# File System Exceptions
+# -------------------------------------------------------------------
 
 
 class FileSystemError(MarkitectureBaseError):

markitecture-0.2.31/src/markitecture/version.py

@@ -0,0 +1 @@
+__version__ = "0.2.31"