Version 2.0 (#29)

* Removed handle_{get, patch, delete, get_all, post} in favour of handle_request

* Specify starlette 0.14.2 requirement in setup.py

* Renamed get_all to get_many

* Various documentation improvements

* Catch errors from before and after request hooks

* Implemented _BaseResourceHandler and moved common functionality

* Always include the JSONAPIException detail

* Include relationships in schema by default

* Relaxed implementation for pagination query params

* Fixed sparse fields logic for including unspecified types

* Make base_path optional for BaseResource.register_routes

* Return 400 if include requests are not supported

* Renamed prepare_relations to include_relations

Author: vladmunteanu

.github/workflows/test_suite.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ["3.6", "3.7", "3.8"]
+        python-version: ["3.6", "3.7", "3.8", "3.9"]
 
     steps:
       - uses: "actions/checkout@v2"

README.md

@@ -11,7 +11,7 @@ any available async ORM. This also means that you are going to get a very basic
 with some helpers to make your experience more pleasant, but nothing fancy.
 
 ##### Installing
-`pip install starlette-jsonapi==1.2.0`
+`pip install starlette-jsonapi`
 
 Since this project is under development, please pin your dependencies to avoid problems.
 
@@ -25,9 +25,9 @@ Since this project is under development, please pin your dependencies to avoid p
 - sparse fields
 - support for client generated IDs
 - support top level meta objects
+- [pagination helpers](https://jsonapi.org/format/#fetching-pagination)
 
 ### Todo:
-- [pagination helpers](https://jsonapi.org/format/#fetching-pagination)
 - [sorting helpers](https://jsonapi.org/format/#fetching-sorting)
 - examples for other ORMs
 - [support jsonapi objects](https://jsonapi.org/format/#document-jsonapi-object)
@@ -39,6 +39,18 @@ Available on [Read The Docs](https://starlette-jsonapi.readthedocs.io/)
 
 You should take a look at the [examples](examples) directory for full implementations.
 
+To generate documentation files locally, you should create a virtualenv,
+then activate it and install the requirements:
+```shell
+cd docs
+pip install -r requirements.txt
+```
+
+With the docs virtualenv activated, you can then run `make html` to generate the HTML files.
+
+The result will be written to `docs/build`, and you can open `docs/build/html/index.html` in your browser of choice
+to view the pages.
+
 ## Contributing
 This project is in its early days, so **any** help is appreciated.
 
@@ -47,4 +59,4 @@ As simple as running ```tox```.
 
 If you plan to use pyenv and want to run tox for multiple python versions,
 you can create multiple virtual environments and then make them available to tox by running
-something like: `pyenv shell starlette_jsonapi_venv36 starlette_jsonapi_venv37`.
+something like: `pyenv shell starlette_jsonapi_venv36 starlette_jsonapi_venv37 starlette_jsonapi_venv38 starlette_jsonapi_venv39`.

docs/source/_static/wide_theme.css

@@ -0,0 +1,3 @@
+.wy-nav-content {
+   /*max-width: 75%;*/
+}

docs/source/api_reference/modules.rst

@@ -4,4 +4,11 @@ starlette_jsonapi
 .. toctree::
    :maxdepth: 4
 
-   starlette_jsonapi
+   starlette_jsonapi.exceptions
+   starlette_jsonapi.fields
+   starlette_jsonapi.meta
+   starlette_jsonapi.pagination
+   starlette_jsonapi.resource
+   starlette_jsonapi.responses
+   starlette_jsonapi.schema
+   starlette_jsonapi.utils

docs/source/api_reference/starlette_jsonapi.pagination.rst

@@ -0,0 +1,14 @@
+starlette\_jsonapi.pagination module
+====================================
+
+.. automodule:: starlette_jsonapi.pagination
+   :members:
+   :exclude-members: Pagination
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+
+.. autoclass:: starlette_jsonapi.pagination.Pagination
+   :members:
+   :show-inheritance:

docs/source/api_reference/starlette_jsonapi.resource.rst

@@ -5,3 +5,4 @@ starlette\_jsonapi.resource module
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:

docs/source/api_reference/starlette_jsonapi.responses.rst

@@ -3,5 +3,11 @@ starlette\_jsonapi.responses module
 
 .. automodule:: starlette_jsonapi.responses
    :members:
+   :exclude-members: JSONAPIResponse
    :undoc-members:
    :show-inheritance:
+
+.. autoclass:: starlette_jsonapi.responses.JSONAPIResponse
+   :members:
+   :undoc-members:
+   :exclude-members: render

docs/source/api_reference/starlette_jsonapi.rst

@@ -4,4 +4,5 @@ starlette\_jsonapi.schema module
 .. automodule:: starlette_jsonapi.schema
    :members:
    :undoc-members:
+   :exclude-members: BaseSchemaOpts
    :show-inheritance:

docs/source/api_reference/starlette_jsonapi.schema.rst

@@ -58,6 +58,17 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path = ['_static']
 
 autodoc_typehints = 'description'
+
+autodoc_default_options = {
+    'member-order': 'bysource',
+    'special-members': '__init__',
+}
+
+autodoc_inherit_docstrings = False
+
+
+def setup(app):
+    app.add_css_file('wide_theme.css')