.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,12 @@
+## This configuration file overrides the inherited configuration file defined
+## in openedx/.github/.github/ISSUE_TEMPLATE because this repo currently does
+## not have Issues turned on, so we create this override to *only* show DEPR
+## issues to users creating Issues. Once Issues are turned on and the repo is
+## ready to accept Issues of all types, this file must be deleted so inheritance
+## of standard openedx configuration works properly.
+
+blank_issues_enabled: false
+contact_links:
+  - name: Open edX Community Support
+    url: https://discuss.openedx.org/
+    about: Please ask all questions, suggest all enhancements, and report all bugs here.

.github/ISSUE_TEMPLATE/depr-ticket.yml

@@ -0,0 +1,91 @@
+## This configuration file overrides the inherited configuration file defined
+## in openedx/.github/.github/ISSUE_TEMPLATE because this repo currently does
+## not have Issues turned on, so we create this override to *only* show DEPR
+## issues to users creating Issues. Once Issues are turned on and the repo is
+## ready to accept Issues of all types, this file must be deleted so inheritance
+## of standard openedx configuration works properly.
+
+name: Deprecation (DEPR) Ticket
+description: Per OEP-21, use this template to begin the technology deprecation process.
+title: "[DEPR]: <Technology Name>"
+labels: ["DEPR"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Refer to [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html) for more detail on the deprecation and removal process. This ticket should only be used for proposing the removal of an Open edX technology.
+        Please leave [DEPR] in the title of your ticket!
+  - type: input
+    id: todays-date
+    attributes:
+      label: Proposal Date
+      description: The start date of this proposal (likely today)
+      placeholder: 29 February 2020
+    validations:
+      required: true
+  - type: input
+    id: accept-date
+    attributes:
+      label: Ticket Acceptance Date
+      description: When is the target date for getting this proposal accepted?
+      placeholder: 29 February 2020
+    validations:
+      required: true
+  - type: input
+    id: remove-date
+    attributes:
+      label: Technology Removal Date
+      description: When is the target date for getting this technology removed?
+      placeholder: 29 February 2020
+    validations:
+      required: true
+  - type: input
+    id: named-release-without
+    attributes:
+      label: First Open edX Named Release Without This Functionality
+      description: Named releases are generally CUT in early April and early October. Based on the above removal date, what named release would be the first without this code? Please reach out to the Build Test Release working group (#wg-build-test-release in Slack) if you're not sure.
+      placeholder: Dogwood
+    validations:
+      required: true
+  - type: textarea
+    id: rationale
+    attributes:
+      label: Rationale
+      description: Explain, in a few sentences, why this technology should be removed - what's the usage pattern? What's wrong with keeping it around?
+    validations:
+      required: true
+  - type: textarea
+    id: removal
+    attributes:
+      label: Removal
+      description: Include a description with links to what exactly is being removed.
+    validations:
+      required: true
+  - type: textarea
+    id: replacement
+    attributes:
+      label: Replacement
+      description: Include a description with links to what this is being replaced by.
+    validations:
+      required: true
+  - type: textarea
+    id: deprecation
+    attributes:
+      label: Deprecation
+      description: If you plan to mark the code for deprecation, explain how.
+    validations:
+      required: false
+  - type: textarea
+    id: migration
+    attributes:
+      label: Migration
+      description: If automated migration will be needed, explain your migration plan.
+    validations:
+      required: false
+  - type: textarea
+    id: addl-info
+    attributes:
+      label: Additional Info
+      description: If there is any additional publicly sharable information or data from your earlier analysis, include that.
+    validations:
+      required: false

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+    # Adding new check for github-actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+        interval: "weekly"

.github/workflows/add-depr-ticket-to-depr-board.yml

@@ -0,0 +1,19 @@
+# Run the workflow that adds new tickets that are either:
+# - labelled "DEPR"
+# - title starts with "[DEPR]"
+# - body starts with "Proposal Date" (this is the first template field)
+# to the org-wide DEPR project board
+
+name: Add newly created DEPR issues to the DEPR project board
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  routeissue:
+    uses: openedx/.github/.github/workflows/add-depr-ticket-to-depr-board.yml@master
+    secrets:
+      GITHUB_APP_ID: ${{ secrets.GRAPHQL_AUTH_APP_ID }}
+      GITHUB_APP_PRIVATE_KEY: ${{ secrets.GRAPHQL_AUTH_APP_PEM }}
+      SLACK_BOT_TOKEN: ${{ secrets.SLACK_ISSUE_BOT_TOKEN }}

.github/workflows/add-remove-label-on-comment.yml

@@ -0,0 +1,20 @@
+# This workflow runs when a comment is made on the ticket
+# If the comment starts with "label: " it tries to apply
+# the label indicated in rest of comment.
+# If the comment starts with "remove label: ", it tries
+# to remove the indicated label.
+# Note: Labels are allowed to have spaces and this script does
+# not parse spaces (as often a space is legitimate), so the command
+# "label: really long lots of words label" will apply the
+# label "really long lots of words label"
+
+name: Allows for the adding and removing of labels via comment
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  add_remove_labels:
+    uses: openedx/.github/.github/workflows/add-remove-label-on-comment.yml@master
+

.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: Python CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches:
+    - '**'
+
+jobs:
+  run_tests:
+    name: Tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.11', '3.12']
+        toxenv: [quality, django42]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: setup python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install pip
+      run: pip install -r requirements/pip.txt
+
+    - name: Install pip-tools
+      run: pip install -r requirements/pip-tools.txt
+
+    - name: Install Dependencies
+      run: pip install -r requirements/ci.txt
+
+    - name: Run Tests
+      env:
+        TOXENV: ${{ matrix.toxenv }}
+      run: tox
+
+    - name: Run Coverage
+      if: matrix.python-version == '3.12' && matrix.toxenv=='django42'
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        flags: unittests
+        fail_ci_if_error: true

.github/workflows/commitlint.yml

@@ -0,0 +1,10 @@
+# Run commitlint on the commit messages in a pull request.
+
+name: Lint Commit Messages
+
+on:
+  - pull_request
+
+jobs:
+  commitlint:
+    uses: openedx/.github/.github/workflows/commitlint.yml@master

.github/workflows/pypi-publish.yml

@@ -0,0 +1,33 @@
+name: Publish package to PyPi
+
+on:
+  release:
+    types: [published]
+
+jobs:
+
+  push:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Install pip
+        run: pip install -r requirements/pip.txt
+
+      - name: Install Dependencies
+        run: pip install setuptools wheel
+
+      - name: Build package
+        run: python setup.py sdist bdist_wheel
+
+      - name: Publish to PyPi
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_UPLOAD_TOKEN }}

.github/workflows/self-assign-issue.yml

@@ -0,0 +1,12 @@
+# This workflow runs when a comment is made on the ticket
+# If the comment starts with "assign me" it assigns the author to the
+# ticket (case insensitive)
+
+name: Assign comment author to ticket if they say "assign me"
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  self_assign_by_comment:
+    uses: openedx/.github/.github/workflows/self-assign-issue.yml@master

.pep8

@@ -1,4 +1,4 @@
-[pep8]
+[pycodestyle]
 ignore=E501
-max_line_length=119
-exclude=settings
+max_line_length=120
+exclude=.git,.tox,milestones/migrations,settings

MANIFEST.in

@@ -1,2 +1,5 @@
 include LICENSE
 include README.md
+include requirements/base.in
+include requirements/test.in
+include requirements/constraints.txt

Makefile

@@ -1,13 +1,54 @@
-all: install quality test
+.PHONY: clean help pii_check quality requirements selfcheck test upgrade validate
 
-install-test:
-	pip install -q -r test_requirements.txt
+.DEFAULT_GOAL := help
 
-install: install-test
-	pip install -q -r requirements.txt
+help: ## display this help message
+	@echo "Please use \`make <target>' where <target> is one of"
+	@grep '^[a-zA-Z]' $(MAKEFILE_LIST) | sort | awk -F ':.*?## ' 'NF==2 {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}'
+
+all: requirements quality test
+
+clean: ## remove generated byte code, coverage reports, and build artifacts
+	find . -name '__pycache__' -exec rm -rf {} +
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	coverage erase
+	rm -fr build/
+	rm -fr dist/
+	rm -fr *.egg-info
+
+pii_check: ## check for PII annotations on all Django models
+	tox -e pii_check
+
+requirements:
+	pip install -qr requirements/pip.txt
+	pip install -qr requirements/dev.txt
 
 quality:
 	tox -e quality
 
+selfcheck: ## check that the Makefile is well-formed
+	@echo "The Makefile is well-formed."
+
 test: ## run tests on every supported Python version
 	tox
+
+upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
+upgrade: ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
+	pip install -qr requirements/pip-tools.txt
+	# Make sure to compile files after any other files they include!
+	pip-compile --upgrade --allow-unsafe --rebuild -o requirements/pip.txt requirements/pip.in
+	pip-compile --upgrade --allow-unsafe -o requirements/pip-tools.txt requirements/pip-tools.in
+	pip install -qr requirements/pip.txt
+	pip install -qr requirements/pip-tools.txt
+	pip-compile --upgrade --allow-unsafe -o requirements/base.txt requirements/base.in
+	pip-compile --upgrade --allow-unsafe -o requirements/test.txt requirements/test.in
+	pip-compile --upgrade --allow-unsafe -o requirements/quality.txt requirements/quality.in
+	pip-compile --upgrade --allow-unsafe -o requirements/ci.txt requirements/ci.in
+	pip-compile --upgrade --allow-unsafe -o requirements/dev.txt requirements/dev.in
+	# Let tox control the Django version for tests
+	sed '/^[dD]jango==/d' requirements/test.txt > requirements/test.tmp
+	mv requirements/test.tmp requirements/test.txt
+
+validate: quality pii_check test ## run tests and quality checks