{"id":20037738,"url":"https://github.com/openedx/edx-notes-api","last_synced_at":"2025-04-07T07:08:52.625Z","repository":{"id":23098117,"uuid":"26452208","full_name":"openedx/edx-notes-api","owner":"openedx","description":"edx-notes-api","archived":false,"fork":false,"pushed_at":"2025-04-07T05:28:26.000Z","size":960,"stargazers_count":14,"open_issues_count":6,"forks_count":55,"subscribers_count":116,"default_branch":"master","last_synced_at":"2025-04-07T06:28:24.301Z","etag":null,"topics":["backend-service"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openedx.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.TXT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-11-10T19:37:29.000Z","updated_at":"2025-04-07T05:28:28.000Z","dependencies_parsed_at":"2023-10-25T22:30:55.245Z","dependency_job_id":"90777f3a-831f-4b7d-a8d6-3ae0a3159124","html_url":"https://github.com/openedx/edx-notes-api","commit_stats":{"total_commits":358,"total_committers":74,"mean_commits":4.837837837837838,"dds":0.8743016759776536,"last_synced_commit":"0214a57208415c05c6c6dfde44761bef169a79ed"},"previous_names":[],"tags_count":59,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-notes-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-notes-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-notes-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-notes-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/edx-notes-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247608151,"owners_count":20965952,"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":["backend-service"],"created_at":"2024-11-13T10:21:32.583Z","updated_at":"2025-04-07T07:08:52.579Z","avatar_url":"https://github.com/openedx.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"edX Student Notes API |build-status|\n####################################\n\nThis is a backend store for edX Student Notes.\n\nOverview\n********\n\nThe edX Notes API is designed to be compatible with the `Annotator \u003chttp://annotatorjs.org/\u003e`__.\n\nGetting Started\n***************\n\n1. Install `ElasticSearch 7.13.4 \u003chttps://www.elastic.co/downloads/past-releases/elasticsearch-7-13-4\u003e`__.\n\n2. Install the requirements:\n\n   .. code-block:: bash\n\n      make develop\n\n3. Create index and put mapping:\n\n   .. code-block:: bash\n\n      make create-index\n\n4. Run the server:\n\n   .. code-block:: bash\n\n      make run\n\nConfiguration\n*************\n\n``CLIENT_ID`` - OAuth2 Client ID, which is to be found in ``aud`` field of IDTokens which authorize users\n\n``CLIENT_SECRET`` - secret with which IDTokens should be encoded\n\n``ES_DISABLED`` - set to True when you need to run the service without ElasticSearch support.\n                  e.g if it became corrupted and you're rebuilding the index, while still serving users\n                  through MySQL\n\n``ELASTICSEARCH_DSL['default']['hosts']`` - Your ElasticSearch host\n\nRunning Tests\n*************\n\nInstall requirements::\n\n   make test.requirements\n\nStart mysql/elasticsearch services::\n\n   make test-start-services\n\nRun unit tests::\n\n   make test\n\nRun quality checks::\n\n   make quality\n\nHow To Resync The Index\n***********************\n\nedX Notes Store uses `Django elasticsearch DSL \u003chttps://django-elasticsearch-dsl.readthedocs.io/\u003e`_ which comes with several management commands.\n\nPlease read more about ``search_index`` management commands\n`here \u003chttps://django-elasticsearch-dsl.readthedocs.io/en/latest/management.html\u003e`_.\n\nLicense\n*******\n\nThe code in this repository is licensed under version 3 of the AGPL unless\notherwise 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://openedx.atlassian.net/wiki/spaces/COMM/pages/941457737/How+to+Start+Contributing+Code\u003e`_ for details.\n\nReporting Security Issues\n*************************\n\nPlease do not report security issues in public. Please email security@openedx.org\n\nMailing List and IRC Channel\n****************************\n\nYou can discuss this code on the `edx-code Google Group`__ or in the\n``edx-code`` IRC channel on Freenode.\n\n__ https://groups.google.com/g/edx-code\n\n.. |build-status| image:: https://github.com/openedx/edx-notes-api/actions/workflows/ci.yml/badge.svg\n   :target: https://github.com/openedx/edx-notes-api/actions/workflows/ci.yml\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Fedx-notes-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Fedx-notes-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Fedx-notes-api/lists"}