Public documentation for pinax-api endpoints comes from resource endpoint docstrings. This information is the contract between the developer and the resource consumer.

Endpoint tests verify proper results, but test results and documentation are not connected, so when tests change but documentation does not there is a problem.

We'd be well served by some kind of connection between tests and the API documentation, for both consistency and DRY (expected results only written once).

When using a builtin type for the model, i.e. "dict", the pinax.api.registry.register.as_jsonapi() function fails with:

builtins.TypeError: can't set attributes of built-in/extension type 'dict'

pip install -vvv pinax-api
Collecting pinax-api
1 location(s) to search for versions of pinax-api:

• https://pypi.python.org/simple/pinax-api/
  Getting page https://pypi.python.org/simple/pinax-api/
  Looking up "https://pypi.python.org/simple/pinax-api/" in the cache
  Current age based on date: 577
  Freshness lifetime from max-age: 600
  Freshness lifetime from request max-age: 600
  The response is "fresh", returning cached response
  600 > 577
  Analyzing links from page https://pypi.python.org/simple/pinax-api/
  Could not find a version that satisfies the requirement pinax-api (from versions: )
  Cleaning up...
  No matching distribution found for pinax-api

Patch is missing for this repo

Looking for maintainers!

There is a lot of pull requests and open issues that the current maintainers, myself included, are just not finding the time to properly get to.

Maybe you've submitted some PRs and are frustrated with the lack of attention. Maybe you use this project in one or more of your projects and want to see that it is properly carried forward.

Whatever you reasons may be, let me know if you have interest and I'll add you to the repo and to PyPI (will need your PyPI name).

Preference will go to those who have commits on this repo and/or have shown an active interest in the issues.

Thanks!
Patrick

If an API endpoint, i.e. "create" is missing a docstring, the automatic documentation feature fails with 'NoneType' object has no attribute 'expandtabs', originating here:

  File "/Users/graham/.pyenv/versions/3.5.2/lib/python3.5/site-packages/pinax/api/docs.py", line 61, in endpointset_actions
    doc = trim(view.__doc__).splitlines()

The fix is simple, add test for if view.__doc__ in the preceding conditional and continue if docstring is empty.

Replace hyphens and dumb quotes with "em" dashes, "en" dashes, and smart quotes where appropriate.

See http://www.toptentypography.tips/ section Six. (thanks Joni!)

This should be as simple as adding type check for datetime.date or datetime.datetime at https://github.com/pinax/pinax-api/blob/master/pinax/api/resource.py#L301 as the encode() should work for both types.