mirror of
https://github.com/hanzoai/datastore-orm.git
synced 2026-08-07 09:54:16 +00:00
This is our fork, so it should read like it. `import datastore_orm` instead of `from infi.clickhouse_orm import ...`: `infi` was the original vendor's org namespace, and carrying someone else's org name through every import in the consuming codebase is not a fork, it is a vendored copy that never got renamed. The `infi` namespace package is gone entirely (src/infi/__init__.py with it), the distribution is `datastore-orm`, and the metadata points at Hanzo rather than at the upstream repo and author. NOT renamed, deliberately: the migration history tables are still `infi_clickhouse_orm_migrations`. That name is persisted state — 448 rows in production key off it — so changing it is a data migration, not a rename. Doing it carelessly reproduces the exact failure this fork just hit, where a package rename orphaned the history and silently blocked every migration.
This directory contains various scripts for use while developing.
generate_toc
Generates the table of contents (toc.md). Requires Pandoc. Usage:
cd docs
../scripts/generate_toc.sh
html_to_markdown_toc.py
Used by generate_toc.
docs2html
Converts markdown docs to html for preview. Requires Pandoc. Usage:
cd docs
../scripts/docs2html.sh
generate_ref
Generates a class reference. Usage:
cd docs
../bin/python ../scripts/generate_ref.py > class_reference.md
generate_all
Does everything:
- Generates the class reference using generate_ref
- Generates the table of contents using generate_toc
- Converts to HTML for visual inspection using docs2html
Usage:
cd docs
../scripts/generate_all.sh
test_python3
Creates a Python 3 virtualenv, clones the project into it, and runs the tests. Usage:
./test_python3.sh