Jaymon / prom

A PostgreSQL or SQLite orm for Python
MIT License
22 stars 4 forks source link

commandline script that creates documentation #64

Open Jaymon opened 6 years ago

Jaymon commented 6 years ago

Similar to how we've generated api and chat documentation, it would be cool to have a command line script that goes through and looks at all the models and builds a relationship and db schema from that.

Something like:

$ prom doc modulepath.foo otherpath.bar

Then it would go through all the modules in modulepath.foo and modulepath.bar, find the prom.Orm children and build a relationship and prints markdown documentation (you can either supply the template or it can use a built-in template?)

This was suggested by Eric to make it easier to see how the tables are laid out and what the foreign key relationships are and stuff since we have a tendency to leave old and dead tables in the db