https://github.com/openedx/edx-drf-extensions

edX extensions for Django REST Framework
https://github.com/openedx/edx-drf-extensions

Last synced: 5 days ago
JSON representation

edX extensions for Django REST Framework

• Host: GitHub
• URL: https://github.com/openedx/edx-drf-extensions
• Owner: openedx
• License: apache-2.0
• Created: 2016-03-11T12:28:52.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-12-13T04:05:37.000Z (14 days ago)
• Last Synced: 2024-12-14T10:04:34.045Z (12 days ago)
• Language: Python
• Homepage: http://edx-drf-extensions.readthedocs.org
• Size: 755 KB
• Stars: 17
• Watchers: 88
• Forks: 16
• Open Issues: 14
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
edX Django REST Framework Extensions  |CI|_ |Codecov|_

==========================================================

.. |CI| image:: https://github.com/openedx/edx-drf-extensions/workflows/Python%20CI/badge.svg?branch=master

.. _CI: https://github.com/openedx/edx-drf-extensions/actions?query=workflow%3A%22Python+CI%22

.. |Codecov| image:: https://codecov.io/github/edx/edx-drf-extensions/coverage.svg?branch=master

.. _Codecov: https://codecov.io/github/edx/edx-drf-extensions?branch=master

.. |doc-badge| image:: https://readthedocs.org/projects/edx-drf-extensions/badge/?version=latest

.. _doc-badge: http://edx-drf-extensions.readthedocs.io/en/latest/

This library includes various cross-cutting concerns related to APIs. API functionality added to this library must be required for multiple Open edX applications or multiple repositories.

Some of these concerns include extensions of `Django REST Framework `_ (DRF), which is how the repository initially got its name.

Publishing a Release

--------------------

After a PR merges, a new version of the package will automatically be released by Travis when the commit is tagged. Use::

    git tag -a X.Y.Z -m "Releasing version X.Y.Z"

    git push origin X.Y.Z

Do **not** create a Github Release, or ensure its message points to the CHANGELOG.rst and ADR 0001-use-changelog.rst.

JWT Authentication and REST API Endpoints

-----------------------------------------

JWT Authentication is the preferred method of authentication for Open edX API endpoints. See `JWT Authentication README`_ for more details.

.. _JWT Authentication README: ./edx_rest_framework_extensions/auth/jwt/README.rst

CSRF API

--------

One feature of this library is a ``csrf`` app containing an API endpoint for retrieving CSRF tokens from the Django service in which it is installed. This is useful for frontend apps attempting to make POST, PUT, and DELETE requests to a Django service with Django's CSRF middleware enabled.

To make use of this API endpoint:

#. Install edx-drf-extensions in your Django project.

#. Add ``csrf.apps.CsrfAppConfig`` to ``INSTALLED_APPS``.

#. Add ``'edx_rest_framework_extensions.auth.jwt.middleware.JwtAuthCookieMiddleware'`` to ``MIDDLEWARE``.

#. Add ``csrf.urls`` to urls.py.

Documentation

-------------

The latest documentation for this repository can be found on `Read the Docs `_

License

-------

The code in this repository is licensed under Apache 2.0 unless otherwise noted.

Please see ``LICENSE.txt`` for details.

How To Contribute

-----------------

Contributions are very welcome.

Please read `How To Contribute `_ for details.

Reporting Security Issues

-------------------------

Please do not report security issues in public. Please email [email protected].