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.2.0.tar.gz (27.4 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.2.0-py3-none-any.whl (32.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for disambiguate-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c9296f47ede2ebb2df9a9d31b9ef5f030c019cd8fcb94750c46240b02fb3d9d2
MD5 ead0f4429133a51692618cd0b2a7723c
BLAKE2b-256 10b926bb62b5bfda4404c77ab758f27d90f48866146c5c7786f292804d6c3061

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: disambiguate-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 32.5 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0e30cafca6d70f1640acf312ae812fbff182e5cb41aca9f6ead55c6aee5804ce
MD5 0c758dfeaf87854df56d1a82d0eb3b10
BLAKE2b-256 fe4ca2377fa652511f8f8ce6bf43083aa59fcd6ad56c47421622d4928410c4fd

See more details on using hashes here.

Provenance

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