Skip to main content

houdinimd-docs

Houdini's own documentation, read out of the Houdini install on this machine. It is the documentation engine of the HoudiniMD desktop app, compiled from Rust into a Python module. The HoudiniMCP bridge uses it.

No documentation ships in this package. Every page comes from the help files of an installed Houdini, so the text matches that build exactly.

import houdinimd_docs

docs = houdinimd_docs.Docs("/path/to/a/folder/for/the/index")
docs.installs()                          # the Houdini builds found, newest first
docs.page("nodes/sop/copytopoints")      # one page, as Markdown
docs.search("copy to points", limit=5)   # ranked full-text search
docs.page("hom/hou/Node", build="21.0.829")

Every call returns a JSON string. page raises ValueError when the build has no such page.

The first search on a build indexes it into a SQLite file in the folder you name, which takes a few seconds. The index stays there, so this happens once per build. A page read never waits for it.

Without build, the reader uses the Houdini in $HFS, then the newest build it finds. The build comes from the install's own SYS_Version.h, never from its folder name.

Download files

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

Source Distribution

houdinimd_docs-0.1.0.tar.gz (73.4 kB view details)

Uploaded Source

Built Distributions

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

houdinimd_docs-0.1.0-cp39-abi3-win_amd64.whl (1.1 MB view details)

Uploaded CPython 3.9+Windows x86-64

houdinimd_docs-0.1.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.1 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ x86-64

houdinimd_docs-0.1.0-cp39-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl (2.3 MB view details)

Uploaded CPython 3.9+macOS 10.12+ universal2 (ARM64, x86-64)macOS 10.12+ x86-64macOS 11.0+ ARM64

File details

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

File metadata

  • Download URL: houdinimd_docs-0.1.0.tar.gz
  • Upload date:
  • Size: 73.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for houdinimd_docs-0.1.0.tar.gz
Algorithm Hash digest
SHA256 db3cad217c124383465a57112ebf12b8fb567330356b87ed825c25baa241ab1c
MD5 cad0c114fc4c2e5d238411ebdd19c1c0
BLAKE2b-256 59a470a8625d09261de26614fb9a1b03622e7041047b8a42f2a0ea8fcc18d676

See more details on using hashes here.

File details

Details for the file houdinimd_docs-0.1.0-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: houdinimd_docs-0.1.0-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for houdinimd_docs-0.1.0-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 f827499784bc841c7dd8f4a5623b35a6dda1d87ae9e379652759a434eee1c06a
MD5 33354ec8b43f9783bd49d79e46da4079
BLAKE2b-256 1de0fc733b25c135ce04336a39d23a7d017a9d6487916e52c32f4217297b8988

See more details on using hashes here.

File details

Details for the file houdinimd_docs-0.1.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: houdinimd_docs-0.1.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: CPython 3.9+, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for houdinimd_docs-0.1.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 03203480ea920d1334994970f911c4e80f5ffa8fdbc913f2c93039d3350f41a0
MD5 53f141109187e5556de0347b60123d97
BLAKE2b-256 4bedc387dd432cc3b09c9adaec6f2d84892c3045c9af81775f0fa0280b64f5be

See more details on using hashes here.

File details

Details for the file houdinimd_docs-0.1.0-cp39-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl.

File metadata

  • Download URL: houdinimd_docs-0.1.0-cp39-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: CPython 3.9+, macOS 10.12+ universal2 (ARM64, x86-64), macOS 10.12+ x86-64, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for houdinimd_docs-0.1.0-cp39-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm Hash digest
SHA256 f283f5111c83b33aab1735c3d7a13103ba845f8aa119a0f1c729bf72814f6db0
MD5 1c3302881d558fde9fc3c26ba160b9cc
BLAKE2b-256 2f113825810c436a1cab31f43f854891799ceb1e06a2fe79bbaec2f108000947

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.1

4 files

This release

0.1.0 This release

4 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page