Files
edx-platform/requirements/edx/github.in
Awais Qureshi 46776e92e2 chore: using edx-proctoring-proctortrack hash for django42 compatib… (#33406)
* chore: using `edx-proctoring-proctortrack` hash for django42 compatibility.
* docs: link the follow up issue for github dependency

---------

Co-authored-by: edX requirements bot <49161187+edx-requirements-bot@users.noreply.github.com>
Co-authored-by: UsamaSadiq <usama7274@gmail.com>
2023-10-06 17:52:05 +05:00

93 lines
3.9 KiB
Plaintext

# This file holds all GitHub-hosted edx-platform Python dependencies.
# Such dependencies should be added here, not to kernel.in.
# That being said....
#
# ---->>> DON'T JUST ADD NEW DEPENDENCIES!!! <<<----
#
# Every new GitHub-hosted dependency slows down the edx-platform build and
# subverts our continuous dependency upgrade process. This file should
# only be added to in exceptional circumstances.
#
# "I don't have time to publish my package to PyPI" is **not** an
# acceptable excuse. You can add a GitHub Action workflow to automatically
# upload your package to PyPI with the push of a button:
#
# * Go to https://github.com/openedx/<YOUR_REPO>/actions/new
# * Find "Publish Python Package"
# * Merge the generated PR and push package.
# * You're done! Add your dependency to kernel.in, and the requirements
# bot will automatically keep it fresh in edx-platform.
#
# If you think you must add a URL to this file, read this section of OEP-18 first:
# https://docs.openedx.org/projects/openedx-proposals/en/latest/best-practices/oep-0018-bp-python-dependencies.html#installing-dependencies-from-urls
#
# If you are sure that you need to install from GitHub, then
# use this exact format:
#
# # ISSUE-LINK
# git+https://github.com/OWNER/REPO-NAME.git@TAG-OR-SHA#egg=DIST-NAME==VERSION
#
# For example:
#
# # https://github.com/openedx/blockstore/issues/212
# git+https://github.com/openedx/blockstore.git@v1.3.0#egg=openedx-blockstore==1.3.0
#
# where:
#
# ISSUE-LINK = https://github.com/openedx/blockstore/issues/212
# OWNER = openedx
# REPO-NAME = blockstore
# TAG-OR-SHA = v1.3.0
# DIST-NAME = openedx-blockstore
# VERSION = 1.3.0
#
# Rules to follow:
#
# * Don't leave out any of these pieces.
#
# * ISSUE-LINK points to an item in a public issue tracker. The issue
# should be in the backlog of a particular contributor or team
# who will make sure that it is resolved.
#
# * TAG-OR-SHA is the specific commit to install. It must be a git tag,
# or a git SHA commit hash. Don't use branch names here. If OWNER is
# not openedx, then it must be a SHA. If you use a SHA,
# please make sure there is a tag associated with it, so the commit can't
# be lost during rebase.
#
# * DIST-NAME is the distribution name, the same name you'd use in a
# "pip install" command. It might be different than REPO-NAME. It must
# be the same as the `name="DIST-NAME"` value in the repo's setup.py.
#
# * VERSION might not be the same as TAG-OR-SHA, but if the tag names the
# version, please make it match the VERSION, but with a "v" prefix.
# VERSION must be the same as the `version="VERSION"` value in the repo's
# setup.py. An alternative is to use 0.0 as VERSION: this forces pip to
# re-install the package each time, and can be useful when working with two
# repos before picking a version number. Don't use 0.0 on master, only for
# tight-loop work in progress.
#
# * Don't prefix the URL with "-e". That would install the package in "editable"
# mode A.K.A "development" mode, which takes longer and does not
# fully respect setup.py, making the transition back to PyPI more complex.
#
# * Organize the URL into one of the two categories below:
##############################################################################
# Release candidates being tested.
##############################################################################
# ... add dependencies here
##############################################################################
# Critical fixes for packages that are not yet available in a PyPI release.
##############################################################################
# ... add dependencies here
# django42 support PR merged but new release is pending.
# https://github.com/openedx/edx-platform/issues/33431
-e git+https://github.com/anupdhabarde/edx-proctoring-proctortrack.git@31c6c9923a51c903ae83760ecbbac191363aa2a2#egg=edx_proctoring_proctortrack