3 Commits

Author SHA1 Message Date
bcf0fa0a4f docs: enable docforge-linkfix in wiki config 2026-10-17 17:22:42 +05:30
a91cb67487 fix(drone): use AUTH_URL and private index in quality gate
All checks were successful
continuous-integration/drone/tag Build is passing
2026-10-17 04:24:27 +05:30
650d3a19e8 chore(release): 0.0.3
Squash-merge lib-standardisation: adopt repo standards across packaging,
tooling, docs, and CI.

- standardize pyproject.toml (canonical packaging, lint config, extras, GSDFC pydoclint)
- add py.typed marker, modernize type hints and Google-style docstrings
- nest generated docs under docs/lib and docs/mcp; add hand-written wiki
- adopt standard Type A PyPI CI pipeline (tag==version guard + quality gate)
- promote generated CHANGELOG.md; bump version to 0.0.3
2026-10-17 02:16:48 +05:30
4 changed files with 58 additions and 22 deletions

View File

@@ -23,13 +23,18 @@ steps:
commands: commands:
- PACKAGE_NAME=$(grep -E '^name\s*=' pyproject.toml | head -1 | cut -d'"' -f2) - PACKAGE_NAME=$(grep -E '^name\s*=' pyproject.toml | head -1 | cut -d'"' -f2)
- VERSION=$(grep -E '^version\s*=' pyproject.toml | head -1 | cut -d'"' -f2) - VERSION=$(grep -E '^version\s*=' pyproject.toml | head -1 | cut -d'"' -f2)
- echo "🔍 Checking if $PACKAGE_NAME==$VERSION exists on $PIP_REPO_URL ..."
- | - |
if curl -fsSL -u "$PIP_USERNAME:$PIP_PASSWORD" "$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -q "$VERSION"; then if [ "$DRONE_TAG" != "$VERSION" ]; then
echo "✅ $PACKAGE_NAME==$VERSION already exists — skipping build." echo "Tag '$DRONE_TAG' does not match pyproject version '$VERSION'; refusing to publish."
exit 1
fi
- echo "Checking if $PACKAGE_NAME==$VERSION exists on $PIP_REPO_URL ..."
- |
if curl -fsSL -u "$PIP_USERNAME:$PIP_PASSWORD" "$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -qE "${PACKAGE_NAME}-${VERSION}(-|\.tar\.gz|\.whl)"; then
echo "$PACKAGE_NAME==$VERSION already exists; skipping build."
exit 78 exit 78
else else
echo "🆕 New version detected: $PACKAGE_NAME==$VERSION" echo "New version detected: $PACKAGE_NAME==$VERSION"
fi fi
- name: quality-gate - name: quality-gate
@@ -44,19 +49,24 @@ steps:
commands: commands:
- pip install --upgrade pip build - pip install --upgrade pip build
- | - |
AUTH_URL="https://${PIP_USERNAME}:${PIP_PASSWORD}@$(echo "${PIP_REPO_URL#*://}" | sed 's:/*$::')/simple" if [ -z "$PIP_REPO_URL" ] || [ -z "$PIP_USERNAME" ] || [ -z "$PIP_PASSWORD" ]; then
pip install --index-url "$AUTH_URL" --extra-index-url https://pypi.org/simple/ -U ".[dev]" echo "PIP_REPO_URL / PIP_USERNAME / PIP_PASSWORD are not set" >&2
- echo "🛡️ Running quality gate..." exit 1
fi
- AUTH_URL="https://$PIP_USERNAME:$PIP_PASSWORD@$(echo "$PIP_REPO_URL" | sed -E 's|^[a-zA-Z]+://||; s|/*$||')/simple"
- pip install --index-url "$AUTH_URL" --extra-index-url https://pypi.org/simple/ -U ".[dev]" "pydoclint>=0.9.1"
- echo "Running quality gate..."
- python -m black --check . - python -m black --check .
- python -m ruff check . - python -m ruff check .
- python -m mypy - python -m mypy
- pydoclint .
- python -m pytest - python -m pytest
- name: build-package - name: build-package
image: python:3.13-slim image: python:3.13-slim
commands: commands:
- pip install --upgrade pip build - pip install --upgrade pip build
- echo "📦 Building Python package..." - echo "Building Python package..."
- python -m build - python -m build
- ls -l dist - ls -l dist
@@ -71,7 +81,7 @@ steps:
from_secret: PIP_PASSWORD from_secret: PIP_PASSWORD
commands: commands:
- pip install --upgrade twine - pip install --upgrade twine
- echo "🚀 Uploading to private PyPI at $PIP_REPO_URL ..." - echo "Uploading to private PyPI at $PIP_REPO_URL ..."
- | - |
twine upload \ twine upload \
--repository-url "$PIP_REPO_URL" \ --repository-url "$PIP_REPO_URL" \
@@ -118,25 +128,31 @@ steps:
set -e set -e
PACKAGE_NAME=$(grep -E '^name\s*=' pyproject.toml | cut -d'"' -f2) PACKAGE_NAME=$(grep -E '^name\s*=' pyproject.toml | cut -d'"' -f2)
echo "📦 Package: $PACKAGE_NAME" echo "Package: $PACKAGE_NAME"
for TAG in $(git tag --sort=version:refname); do for TAG in $(git tag --sort=version:refname); do
VERSION="$TAG" VERSION="$TAG"
echo "🔁 Version: $VERSION" echo "Version: $VERSION"
if curl -fsSL -u "$PIP_USERNAME:$PIP_PASSWORD" \ if curl -fsSL -u "$PIP_USERNAME:$PIP_PASSWORD" \
"$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -q "$VERSION"; then "$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -qE "${PACKAGE_NAME}-${VERSION}(-|\.tar\.gz|\.whl)"; then
echo "⏭️ Exists, skipping" echo "Exists, skipping"
continue continue
fi fi
git checkout --force "$TAG" git checkout --force "$TAG"
echo "🏗️ Building $VERSION" TAG_VERSION=$(grep -E '^version\s*=' pyproject.toml | head -1 | cut -d'"' -f2)
if [ "$TAG" != "$TAG_VERSION" ]; then
echo "Tag $TAG != pyproject version $TAG_VERSION at that commit; skipping"
continue
fi
echo "Building $VERSION"
rm -rf dist rm -rf dist
python -m build python -m build
echo "⬆️ Uploading $VERSION" echo "Uploading $VERSION"
twine upload \ twine upload \
--repository-url "$PIP_REPO_URL" \ --repository-url "$PIP_REPO_URL" \
-u "$PIP_USERNAME" \ -u "$PIP_USERNAME" \

View File

@@ -7,15 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [Unreleased]
## [0.0.3] - 2026-10-17
### Added ### Added
- `py.typed` marker for PEP 561 type information. - `py.typed` marker for PEP 561 type information.
- `.drone.yml` CI with a quality-gate step (black, ruff, mypy, pytest). - Type stubs for the `csv` and `xlsx` subpackages.
- Canonical `docforge.nav.yml`, generated `mkdocs.yml` and `mcp_docs/` via doc-forge. - Hand-written wiki, plus doc-forge-generated API reference under `docs/lib`
and MCP bundle under `docs/mcp` (per-kind MkDocs configs).
- MIT `LICENSE`. - MIT `LICENSE`.
### Changed ### Changed
- Standardized `pyproject.toml` (canonical packaging, lint tool config, extras). - Adopted the standard Type A PyPI CI pipeline: a `tag == version` guard and a
quality gate (black, ruff, mypy, pydoclint, pytest).
- Standardized `pyproject.toml` (canonical packaging, lint tool config, extras)
with a shared Google-style `[tool.pydoclint]` configuration.
- Docstring types modernised (`List` -> `list`, `Optional` -> `X | None`) to
match signatures.
### Fixed ### Fixed
- `XLSX`/`CSV` members added to the `content` type surface. - `XLSX`/`CSV` members added to the `content` type surface.
- Stub fixes for typed API surfaces. - Stub fixes for typed API surfaces.
[Unreleased]: https://git.aetoskia.com/aetos/omniread/compare/0.0.3...HEAD
[0.0.3]: https://git.aetoskia.com/aetos/omniread/compare/0.0.2...0.0.3

View File

@@ -67,3 +67,4 @@ extra_css:
- https://unpkg.com/dracula-prism/dist/css/dracula-prism.css - https://unpkg.com/dracula-prism/dist/css/dracula-prism.css
plugins: plugins:
- search - search
- docforge-linkfix

View File

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "omniread" name = "omniread"
version = "0.0.1" version = "0.0.3"
description = "Composable content ingestion framework with pluggable scrapers and parsers for HTML, PDF, and structured data" description = "Composable content ingestion framework with pluggable scrapers and parsers for HTML, PDF, and structured data"
readme = "README.md" readme = "README.md"
requires-python = ">=3.10" requires-python = ">=3.10"
@@ -171,6 +171,14 @@ module = [
ignore_missing_imports = true ignore_missing_imports = true
[tool.pydoclint]
style = "google"
exclude = '\.pyi$|tests/'
allow-init-docstring = true
skip-checking-raises = true
check-class-attributes = false
[tool.coverage.run] [tool.coverage.run]
source = ["omniread"] source = ["omniread"]
omit = [ omit = [