Skip to main content

A tool to resolve markdown glossary terms and their transitive dependencies in topological order in a GitHub project or Obsidian vault.

Project description

Disambiguate

CI Status Test coverage percentage

uv Ruff prek

PyPI Version Supported Python versions License


Source Code: https://github.com/frankify-app/disambiguate


Disambiguate resolves markdown glossary terms and their transitive dependencies in topological order. Point it at a directory of *.md term files in either GitHub format or Obsidian format, ask for a slug or two, and get back a self-contained markdown document where every term is defined before it is referenced.

Quickstart

uvx disambiguate                       # render the entire glossary
uvx disambiguate topological-order     # render one term and its dependency closure
uvx disambiguate --from notes.md       # extract glossary-shaped links from a doc
uvx disambiguate --explain             # render Disambiguate's own bundled spec
uvx disambiguate --lint                # validate the glossary

The runtime is stdlib-only — pip install disambiguate brings in nothing else. uvx works without an explicit install.

Installation

pip install disambiguate

How it works

The pipeline parses each term into a body plus a list of cross-references, builds a dependency graph from those references, then runs the resolver to produce topological order. The same pipeline backs from-mode and --explain.

For the architectural map, see docs/architecture.md. For the full vocabulary, see the bundled glossary — Disambiguate's own dogfood.

Contributing

See CONTRIBUTING.md. Conventional commits required — the release workflow uses them to compute the next version.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

disambiguate-0.1.1.tar.gz (26.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

disambiguate-0.1.1-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

Details for the file disambiguate-0.1.1.tar.gz.

File metadata

  • Download URL: disambiguate-0.1.1.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for disambiguate-0.1.1.tar.gz
Algorithm Hash digest
SHA256 44a62d334812aface6db6e5618ffd6c0b6637b4eac2791cc529d0620002d9908
MD5 e8832196b53d42e662da1e5e25f8123c
BLAKE2b-256 92020b813e2496b31f8437c948bad5331494b146e7e2fff7a702e31b3cac3e1e

See more details on using hashes here.

Provenance

The following attestation bundles were made for disambiguate-0.1.1.tar.gz:

Publisher: publish.yml on frankify-app/disambiguate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file disambiguate-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: disambiguate-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 31.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for disambiguate-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ebe66694d5e9118d02df7666d7d39270d13a7ceabaf1f406e122bc1bb9d2e49c
MD5 e5ae70ab87389b2f55b0b130e058a072
BLAKE2b-256 6ab48385aa6e62885a29bb09c4b933485d997ebd887451afb0b2f9f814fca8f5

See more details on using hashes here.

Provenance

The following attestation bundles were made for disambiguate-0.1.1-py3-none-any.whl:

Publisher: publish.yml on frankify-app/disambiguate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page