Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

chore: add catalog info #620

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## ready to accept Issues of all types, this file must be deleted so inheritance
## of standard openedx configuration works properly.

blank_issues_enabled: false
blank_issues_enabled: true
contact_links:
- name: Open edX Community Support
url: https://discuss.openedx.org/
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ jobs:
make validate_translations
- name: Run Coverage
if: matrix.python-version == '3.8' && matrix.toxenv=='django42'
uses: codecov/codecov-action@v1
uses: codecov/codecov-action@v4
with:
flags: unittests
file: ./coverage.xml
fail_ci_if_error: true
token: ${{ secrets.CODECOV_TOKEN }}
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
Registrar service |Travis|_ |Codecov|_
===================================================
.. |Travis| image:: https://travis-ci.com/edx/registrar.svg?branch=master
.. _Travis: https://travis-ci.com/edx/registrar

.. |Codecov| image:: http://codecov.io/github/edx/registrar/coverage.svg?branch=master
.. _Codecov: http://codecov.io/github/edx/registrar?branch=master
.. |Codecov| image:: http://codecov.io/github/openedx/registrar/coverage.svg?branch=master
.. _Codecov: http://codecov.io/github/openedx/registrar?branch=master

The Registrar service allows external organizations to integrate with edX programs,
The Registrar service allows external organizations to integrate with Open edX programs,
providing REST APIs involving program structure, enrollment, and grading.

Through Django Admin, it allows the definition of access roles for different API users.
Expand All @@ -28,14 +26,16 @@ as well as important information about PII annotation.
Using with Devstack
-----------------

! Note ! This section may be outdated. Tutor (https://docs.tutor.edly.io/gettingstarted.html) is now the supported development environment for the Open edX project, but we have not currently verified if Registrar works on Tutor.

The best way to run Registrar is within the edX Devstack: https://github.com/openedx/devstack.

See the Devstack README for information on how to install and run Registrar.

Using Standalone
-----------------

Alternatively, you may run Registrar locally without the edX Devstack. Note that in this configuration, functionality that depends on communication with other edX services (e.g. LMS authentication) will not work by default.
Alternatively, you may run Registrar locally. Note that in this configuration, functionality that depends on communication with other Open edX services (e.g. LMS authentication) will not work by default.

Requirements:

Expand Down
29 changes: 29 additions & 0 deletions catalog-info.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# This file records information about this repo. Its use is described in OEP-55:
# https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
# (Required) Must be the name of the repo, without the owning organization.
name: 'registrar'
description: >
The Registrar service allows external organizations to
integrate with Open edX programs, providing REST APIs involving
program structure, enrollment, and grading."
links:
- url: "https://github.com/openedx/registrar"
title: "openedx/registrar"
icon: "GitHub"
annotations:
openedx.org/arch-interest-groups: ""
openedx.org/release: "main"
spec:
# If you need a new team created, create an issue with Axim engineering:
# https://github.com/openedx/axim-engineering/issues/new/choose
owner: group:openedx-unmaintained

# (Required) Acceptable Type Values: service, website, library
type: 'service'

# (Required) Acceptable Lifecycle Values: experimental, production, deprecated
lifecycle: 'production'
4 changes: 2 additions & 2 deletions codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ coverage:
status:
patch:
default:
target: 100
target: 90
project:
default:
target: 100
target: 90
ignore:
- "registrar/apps/core/permissions.py"
44 changes: 34 additions & 10 deletions requirements/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#
# make upgrade
#
amqp==2.6.1
amqp==5.2.0
# via kombu
analytics-python==1.4.post1
# via -r requirements/base.in
Expand All @@ -17,13 +17,15 @@ async-timeout==4.0.3
# via redis
backoff==1.10.0
# via analytics-python
backports-zoneinfo==0.2.1
backports-zoneinfo[tzdata]==0.2.1
# via
# celery
# django
# djangorestframework
billiard==3.6.4.0
# kombu
billiard==4.2.0
# via celery
celery==4.4.7
celery==5.4.0
# via
# -c requirements/constraints.txt
# -r requirements/base.in
Expand All @@ -37,7 +39,18 @@ cffi==1.16.0
charset-normalizer==3.3.2
# via requests
click==8.1.7
# via edx-django-utils
# via
# celery
# click-didyoumean
# click-plugins
# click-repl
# edx-django-utils
click-didyoumean==0.3.1
# via celery
click-plugins==1.1.1
# via celery
click-repl==0.3.0
# via celery
cryptography==42.0.5
# via
# pyjwt
Expand Down Expand Up @@ -120,7 +133,7 @@ edx-auth-backends==4.3.0
# via -r requirements/base.in
edx-django-release-util==1.4.0
# via -r requirements/base.in
edx-django-utils==5.12.0
edx-django-utils==5.13.0
# via
# edx-drf-extensions
# edx-rest-api-client
Expand All @@ -134,7 +147,7 @@ idna==3.7
# via requests
inflection==0.5.1
# via drf-yasg
kombu==4.6.11
kombu==5.3.7
# via celery
monotonic==1.6
# via analytics-python
Expand All @@ -150,6 +163,8 @@ packaging==24.0
# via drf-yasg
pbr==6.0.0
# via stevedore
prompt-toolkit==3.0.43
# via click-repl
psutil==5.9.8
# via edx-django-utils
pycparser==2.22
Expand All @@ -166,7 +181,9 @@ pymongo==4.4.0
pynacl==1.5.0
# via edx-django-utils
python-dateutil==2.9.0.post0
# via analytics-python
# via
# analytics-python
# celery
python-slugify==4.0.1
# via
# -c requirements/constraints.txt
Expand All @@ -176,7 +193,6 @@ python3-openid==3.2.0
pytz==2024.1
# via
# -r requirements/base.in
# celery
# drf-yasg
pyyaml==6.0.1
# via
Expand Down Expand Up @@ -224,13 +240,21 @@ typing-extensions==4.11.0
# via
# asgiref
# edx-opaque-keys
# kombu
tzdata==2024.1
# via
# backports-zoneinfo
# celery
uritemplate==4.1.1
# via drf-yasg
urllib3==1.26.18
# via
# -c requirements/constraints.txt
# requests
vine==1.3.0
vine==5.1.0
# via
# amqp
# celery
# kombu
wcwidth==0.2.13
# via prompt-toolkit
2 changes: 1 addition & 1 deletion requirements/constraints.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ django-extensions<3.2.0
django-storages==1.10.1

# From base.in
celery<5.0 # version 5.0 drops support for python 3.5
celery<6.0 # keeping the version same as edx-platform


code-annotations>=0.3.1 # Pinned to avoid pyyaml security alerts. (https://github.com/openedx/registrar/pull/42)
Expand Down
Loading