llunn / relaxed Goto Github PK

Doc strings are needed for the majority of functions.

Develop a new python based API for CouchDB.

• Implement Server endpoints
  • /
  • /_active_tasks
  • /_all_dbs
  • /_dbs_info
  • /_cluster_setup
  • /_db_updates
  • /_membership
  • /_replicate
  • /_scheduler/jobs
  • /_scheduler/docs
  • /_scheduler/docs/{replicator_db}
  • /_scheduler/docs/{replicator_db}/{docid}
  • /_node/{node-name}/_stats
  • /_node/{node-name}/_system
  • /_node/{node-name}/_restart
  • /_utils Will not implement
  • /_up
  • /_uuids
  • /favicon.ico Will not implement
  • /_session
    • Basic authentication
    • Cookie authentication
    • Proxy authentication
  • /_node/{node-name}/_config
  • /_node/{node-name}/_config/section
  • /_node/node/_config/section/key
• Implement Database endpoints
  • /db
  • /db/_all_docs
  • /db/_design_docs
  • /db/_bulk_get
  • /db/_bulk_docs
  • /db/_find
  • /db/_index
  • /db/_explain
  • /db/_shards
  • /db/_shards/doc
  • /db/_sync_shards
  • /db/_changes
  • /db/_compact
  • /db/_compact/design-doc
  • /db/_ensure_full_commit
  • /db/_view_cleanup
  • /db/_security
  • /db/_purge
  • /db/_purged_infos_limit
  • /db/_missing_revs
  • /db/_revs_diff
  • /db/_revs_limit
• Implement Documents endpoints
  • /db/doc
  • /db/doc/attachment
• Implement Design Documents endpoints
  • /db/_design/design-doc
  • /db/_design/design-doc/attachment
  • /db/_design/design-doc/_info
  • /db/_design/design-doc/_view/view-name
  • /db/_design/design-doc/_show/show-name
  • /db/_design/design-doc/_show/show-name/doc-id
  • /db/_design/design-doc/_list/list-name/view-name
  • /db/_design/design-doc/_list/list-name/other-ddoc/view-name
  • /db/_design/design-doc/_update/update-name
  • /db/_design/design-doc/_update/update-name/doc-id
  • /db/_design/design-doc/_rewrite/path
• Local (non-replicating) Documents
  • /db/_local_docs
  • /db/_local/id

Clear, easy to use understand working examples need to be written.

Examples should be designed in such a way to allow for copy pasta easy mode

If a database does not exist, db.exists() returns None instead of a CouchError instance.

This is because the HEAD request in RelaxedDecorators is pulling the ETag and return it raw, which is None.

To fix:

1. In db.exists(), in addition to testing couch_data for a CouchError instance, check for is None