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.2.tar.gz (26.2 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.2-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: disambiguate-0.1.2.tar.gz
  • Upload date:
  • Size: 26.2 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.2.tar.gz
Algorithm Hash digest
SHA256 ec4ca80b2e9226fec986d4d7c0308613293f250fe4ad4642dcdd4217617a81ea
MD5 a5977f391a47dc483b5665d15f45651f
BLAKE2b-256 d24460a8521a25be3cc797b317858ccf5c6c1c47fc05fe4b34310b820bd4a495

See more details on using hashes here.

Provenance

The following attestation bundles were made for disambiguate-0.1.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: disambiguate-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 27a819c67ae5eebd8a01c2787836d7213057fd099591421b83f8b5564ec33720
MD5 cdc52d56b7dd2c20a77629b8dccdc12e
BLAKE2b-256 1646510de62f38e0133e77659a6b53e4ab51ea2e3d7c81b1917864fd0713e683

See more details on using hashes here.

Provenance

The following attestation bundles were made for disambiguate-0.1.2-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