port back to postgres.py #1320
port back to postgres.py #1320
Conversation
Conflicts: gittip/participant.py
|
I love in the Redis docs how they give the complexity of each operation, e.g.: I want to do the same in Gittip's documentation with database usage. The documentation for every method should indicate whether and how that method uses the database. |
|
We really don't have that many interactions between models in the orm. I'm seeing:
|
|
We also need documentation for the schema. I think this should be autogenerated directly from PostgreSQL. We should survey existing tools and maybe write our own. This would be a read-only browse of the schema, no data and no mutation. We might want additional non-autogenerated explanations of principles and architecture and design decisions, etc. |
|
Cry for help re: schema browser: https://twitter.com/whit537/status/366227613137633280 Per @cmbeelby: http://schemaspy.sourceforge.net/sample/ |
|
I got SchemaSpy going locally. Looks like a win! I started a gittip.github.io repo to see about using GitHub Pages to host this. Reticketed as #1321. |
This gets us the one_or_zero method and a couple bug fixes.
Adapts to postgres.py upgrade.
|
I just reviewed @subssn21's talk from PyOhio a couple weeks ago. Here's the relevant section: http://www.youtube.com/watch?v=Wz1_GYc4GmU#t=25m6s I was thinking we might want a hand-rolled orm of the kind he was talking about there, [ab]using |
Sphinx has these automodule directives for building docs out of docstrings, but the way that works is that you have to manually tell Sphinx which modules to document in this way. There's an `sphinx-apidoc` cli for generating the necessary *.rst files for you, but it doesn't suit our needs: - We want one doc file per module. - We don't want "Module" or "Package" in the titles. - We want to use directories to organize doc files instead of dotted names. This commit adds a build-rst.py script that generates *.rst files for the gittip library the way we want.
|
✨ |
Merging regressed in #1320.
This regressed with #1320.
This is the same as the version we were running. We released 2.0.0 after landing #1320.
Let's get a PR going on this one. This addresses #1146.