{"id":20037786,"url":"https://github.com/openedx/edx-drf-extensions","last_synced_at":"2025-04-04T21:08:21.777Z","repository":{"id":37092829,"uuid":"53665596","full_name":"openedx/edx-drf-extensions","owner":"openedx","description":"edX extensions for Django REST Framework","archived":false,"fork":false,"pushed_at":"2025-03-28T04:05:33.000Z","size":799,"stargazers_count":18,"open_issues_count":12,"forks_count":16,"subscribers_count":84,"default_branch":"master","last_synced_at":"2025-03-28T20:07:53.999Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://edx-drf-extensions.readthedocs.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openedx.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-03-11T12:28:52.000Z","updated_at":"2025-03-21T06:00:16.000Z","dependencies_parsed_at":"2022-06-24T14:04:58.023Z","dependency_job_id":"1e3df5bb-55c3-4daf-9266-3dc9e7e055c5","html_url":"https://github.com/openedx/edx-drf-extensions","commit_stats":{"total_commits":275,"total_committers":54,"mean_commits":5.092592592592593,"dds":0.7272727272727273,"last_synced_commit":"8d40a8c902ec02990516b20b3517771d1598600c"},"previous_names":[],"tags_count":113,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-drf-extensions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-drf-extensions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-drf-extensions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-drf-extensions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/edx-drf-extensions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247249525,"owners_count":20908212,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T10:22:08.901Z","updated_at":"2025-04-04T21:08:21.739Z","avatar_url":"https://github.com/openedx.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"edX Django REST Framework Extensions  |CI|_ |Codecov|_\n==========================================================\n.. |CI| image:: https://github.com/openedx/edx-drf-extensions/workflows/Python%20CI/badge.svg?branch=master\n.. _CI: https://github.com/openedx/edx-drf-extensions/actions?query=workflow%3A%22Python+CI%22\n\n.. |Codecov| image:: https://codecov.io/github/edx/edx-drf-extensions/coverage.svg?branch=master\n.. _Codecov: https://codecov.io/github/edx/edx-drf-extensions?branch=master\n\n.. |doc-badge| image:: https://readthedocs.org/projects/edx-drf-extensions/badge/?version=latest\n.. _doc-badge: http://edx-drf-extensions.readthedocs.io/en/latest/\n\nThis 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.\n\nSome of these concerns include extensions of `Django REST Framework \u003chttps://www.django-rest-framework.org/\u003e`_ (DRF), which is how the repository initially got its name.\n\nPublishing a Release\n--------------------\n\nAfter a PR merges, a new version of the package will automatically be released by Travis when the commit is tagged. Use::\n\n    git tag -a X.Y.Z -m \"Releasing version X.Y.Z\"\n    git push origin X.Y.Z\n\nDo **not** create a Github Release, or ensure its message points to the CHANGELOG.rst and ADR 0001-use-changelog.rst.\n\nJWT Authentication and REST API Endpoints\n-----------------------------------------\n\nJWT Authentication is the preferred method of authentication for Open edX API endpoints. See `JWT Authentication README`_ for more details.\n\n.. _JWT Authentication README: ./edx_rest_framework_extensions/auth/jwt/README.rst\n\nCSRF API\n--------\n\nOne 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.\n\nTo make use of this API endpoint:\n\n#. Install edx-drf-extensions in your Django project.\n#. Add ``csrf.apps.CsrfAppConfig`` to ``INSTALLED_APPS``.\n#. Add ``'edx_rest_framework_extensions.auth.jwt.middleware.JwtAuthCookieMiddleware'`` to ``MIDDLEWARE``.\n#. Add ``csrf.urls`` to urls.py.\n\nDocumentation\n-------------\n\nThe latest documentation for this repository can be found on `Read the Docs \u003chttp://edx-drf-extensions.readthedocs.io/en/latest/\u003e`_\n\n\nLicense\n-------\n\nThe code in this repository is licensed under Apache 2.0 unless otherwise noted.\n\nPlease see ``LICENSE.txt`` for details.\n\nHow To Contribute\n-----------------\n\nContributions are very welcome.\n\nPlease read `How To Contribute \u003chttps://github.com/openedx/.github/blob/master/CONTRIBUTING.md\u003e`_ for details.\n\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@openedx.org.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Fedx-drf-extensions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Fedx-drf-extensions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Fedx-drf-extensions/lists"}