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.0.tar.gz (24.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.1.0-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: disambiguate-0.1.0.tar.gz
  • Upload date:
  • Size: 24.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.1.0.tar.gz
Algorithm Hash digest
SHA256 575b64994486c36a1acf435f56159966f48e97ad4bf415d6701037ae23968180
MD5 21082b3fc318b12ee5e79c8875dc1d5b
BLAKE2b-256 8bc217183d28699aab5733f6f15deef2d045fe82ed23d17f70b0798533561ac8

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: disambiguate-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 31.3 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1cb8d166c47a9e76069bbff24a432d1b9a3db49778c4b5fadc0a396f869a1006
MD5 a7b92d0115f0f7b4cf6bb608120a9acb
BLAKE2b-256 c749dd0fcb4d25682d4f8aef4f5abec87acd80415525b246be6035d367b12aa3

See more details on using hashes here.

Provenance

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