Welcome to Thorgate API Core’s documentation!

Thorgate API Core

Opinionated API framework on top of Django REST framework

• Free software: ISC license

Supports Python 3.5+, Django 1.11+, Django REST framework 3.6+

Features

• API documentation automatically generated from your views

  • General intro can be added
  • You can add example request/response data
  • Autogenerated Python requests-based examples
  • Not interactive yet

• Integrates JSON API

  • Cursor pagination with configurable page size

• Viewset classes for using different serializers and querysets for list/detail/edit endpoints
• API-specific 404 view
• Test utilities, e.g. for response validation

• Versioning (WIP)

  • Transformer-based approach, inspired by djangorestframework-version-transforms and Stripe

Usage

• pip install tg-apicore

• Add tg_apicore to INSTALLED_APPS

• Ensure your REST_FRAMEWORK setting contains ALLOWED_VERSIONS, e.g:

  # In your Django project settings:
  REST_FRAMEWORK = {
      'ALLOWED_VERSIONS': ('2018-01-01',),
  }
  

• Note that the default paginator requires that your models have created field

• Create API documentation view by subclassing APIDocumentationView and making necessary modifications. See example/example/views.py for example.

• Add main API urls plus 404 view (as fallback).

Here’s an example urls.py:

from tg_apicore.views import PageNotFoundView

from myproject.views import MyProjectAPIDocumentationView

urlpatterns = [
    # The documentation view
    url(r'^api-docs/', MyProjectAPIDocumentationView.as_view(), name='api-docs'),

    # myproject.urls_api should contain your API urls patterns
    url(r'^api/(?P<version>(\d{4}-\d{2}-\d{2}))/', include('myproject.urls_api')),

    # API-specific 404 for everything under api/ prefix
    url(r'^api/', include(PageNotFoundView.urlpatterns())),
]

See example directory for a more in-depth demo.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install Thorgate API Core, run this command in your terminal:

$ pip install tg-apicore

This is the preferred method to install Thorgate API Core, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for Thorgate API Core can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/thorgate/tg-apicore

Or download the tarball:

$ curl  -OL https://github.com/thorgate/tg-apicore/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

• For the quickstart, see the Usage section of the introduction page.
• For a real-world example, see the example/ directory in the Github repo.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/thorgate/tg-apicore/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

Thorgate API Core could always use more documentation, whether as part of the official Thorgate API Core docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/thorgate/tg-apicore/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up tg-apicore for local development.

1. Fork the tg-apicore repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/tg-apicore.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv tg-apicore
   $ cd tg-apicore/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ make test
   $ make lint
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 3.5 and 3.6. Check https://travis-ci.org/thorgate/tg-apicore/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_importing

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

• Rivo Laks <code@rivolaks.com>

Contributors

• Jürno Ader <jyrno42@gmail.com>
• Simon Schmidt <schmidt.simon@gmail.com>

History

0.3.0 (2018-05-23)

• Add Usage section to README (to make starting up easier)
• Most REST_FRAMEWORK settings are now automatically configured by Thorgate API Core. Users only need to specify ALLOWED_VERSIONS, the rest is optional.

0.2.1 (2018-04-14)

• Fix packaging (tg_apicore subdirs weren’t included)

0.2.0 (2018-04-14)

• Added PageNotFoundView (JSON-based 404 views)
• Added DetailSerializerViewSet (different serializers and queryset for list/detail/edit views)
• Added CreateOnlyFieldsSerializerMixin, ModelValidationSerializerMixin and BaseModelSerializer
• Renamed APIDocumentationView.get_patterns() to .urlpatterns()
• Improved example app a lot. It now also includes tests that partially test tg-apicore itself

0.1.0 (2018-03-08)

• First release on PyPI.

Indices and tables

• Index
• Module Index
• Search Page