From e3b99edd588b302d1080ad6ef29069de2b6f01e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= Date: Tue, 30 Aug 2022 10:45:10 +0200 Subject: [PATCH] Transfer ownership to openfun This plugin is about to change considerably in the way it is interfaced with Tutor/Open edX. From now on, the plugin will be managed by the FUN-MOOC team. In practical terms, it means that the following changes will occur: - On pypi the plugin will be moved to "tutor-contrib-richie". The existing plugin will be kept for backward compatibility but upgrades will be available only in the contrib package. Thus, end users should uninstall tutor-richie before installing tutor-contrib-richie. - The code repo will be moved from github.com/overhangio/tutor-richie to github.com/openfun/tutor-contrib-richie. - The "richie" plugin will be removed from the list of default plugins that ship with `pip install tutor[full]` and the tutor binary. The plugin should then be manually installed from pypi (see above). --- .github/workflows/sync.yml | 17 ----------------- .gitlab-ci.yml | 10 ---------- README.rst | 4 +++- contrib/edx-platform/setup.py | 10 ++++------ setup.py | 14 +++++++------- .../openedx-dockerfile-post-python-requirements | 2 +- tutorrichie/plugin.py | 2 +- 7 files changed, 16 insertions(+), 43 deletions(-) delete mode 100644 .github/workflows/sync.yml delete mode 100644 .gitlab-ci.yml diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml deleted file mode 100644 index 2eb53ff..0000000 --- a/.github/workflows/sync.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: Sync with private repo - -on: - push: - branches: [ master ] - -jobs: - sync: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - with: - fetch-depth: 0 - - name: Add remote - run: git remote add overhangio https://${{ secrets.GIT_USERNAME }}:${{ secrets.GIT_PASSWORD }}@git.overhang.io/core/tutor-richie.git - - name: Push - run: git push overhangio master diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index 4df1e77..0000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,10 +0,0 @@ -variables: - TUTOR_PLUGIN: richie - TUTOR_IMAGES: richie - TUTOR_PYPI_PACKAGE: tutor-richie - OPENEDX_RELEASE: maple - GITHUB_REPO: overhangio/tutor-richie - -include: - - project: 'community/tutor-ci' - file: 'plugin-gitlab-ci.yml' diff --git a/README.rst b/README.rst index 4007822..7f672e6 100644 --- a/README.rst +++ b/README.rst @@ -3,12 +3,14 @@ Richie plugin for `Tutor `__ This is a plugin to integrate `Richie `__, the learning portal CMS, with `Open edX `__. The integration takes the form of a `Tutor `__ plugin. + ⚠ WARNING This plugin is currently undergoing major changes and is being transferred to the `openfun `__ organization. + Installation ------------ :: - pip install tutor-richie + pip install tutor-contrib-richie tutor plugins enable richie Running the Richie plugin will require that you rebuild the "openedx" Docker image:: diff --git a/contrib/edx-platform/setup.py b/contrib/edx-platform/setup.py index 4041832..b0d5436 100644 --- a/contrib/edx-platform/setup.py +++ b/contrib/edx-platform/setup.py @@ -13,13 +13,13 @@ def load_readme(): setup( name="richie-edx-platform", version="0.0.1", - url="https://github.com/overhangio/tutor-richie/", + url="https://github.com/openfun/tutor-contrib-richie/", project_urls={ - "Code": "https://github.com/overhangio/tutor-richie/tree/master/contrib/edx-platform", - "Issue tracker": "https://github.com/overhangio/tutor-richie/issues", + "Code": "https://github.com/openfun/tutor-contrib-richie/tree/master/contrib/edx-platform", + "Issue tracker": "https://github.com/openfun/tutor-contrib-richie/issues", }, license="AGPLv3", - author="Overhang.IO", + author="Open FUN (France Universite Numerique) & Overhang.IO", description="Open edX plugin app for integration with a Richie catalog", long_description=load_readme(), packages=find_packages(exclude=["tests*"]), @@ -39,8 +39,6 @@ def load_readme(): "License :: OSI Approved :: GNU Affero General Public License v3", "Operating System :: OS Independent", "Programming Language :: Python", - "Programming Language :: Python :: 3.5", - "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", diff --git a/setup.py b/setup.py index 8f00474..31ee448 100644 --- a/setup.py +++ b/setup.py @@ -25,20 +25,20 @@ def load_about(): setup( - name="tutor-richie", + name="tutor-contrib-richie", version=ABOUT["__version__"], - url="https://github.com/overhangio/tutor-richie", + url="https://github.com/openfun/tutor-contrib-richie", project_urls={ - "Code": "https://github.com/overhangio/tutor-richie", - "Issue tracker": "https://github.com/overhangio/tutor-richie/issues", + "Code": "https://github.com/openfun/tutor-contrib-richie", + "Issue tracker": "https://github.com/openfun/tutor-contrib-richie/issues", }, license="AGPLv3", - author="Overhang.IO", - description="richie plugin for Tutor", + author="Open FUN (France Universite Numerique) & Overhang.IO", + description="Richie plugin for Tutor", long_description=load_readme(), packages=find_packages(exclude=["tests*", "contrib*"]), include_package_data=True, - python_requires=">=3.5", + python_requires=">=3.7", install_requires=["tutor>=14.0.0,<15.0.0"], entry_points={ "tutor.plugin.v0": [ diff --git a/tutorrichie/patches/openedx-dockerfile-post-python-requirements b/tutorrichie/patches/openedx-dockerfile-post-python-requirements index 67ccbb5..d5431ae 100644 --- a/tutorrichie/patches/openedx-dockerfile-post-python-requirements +++ b/tutorrichie/patches/openedx-dockerfile-post-python-requirements @@ -1,2 +1,2 @@ # Install Richie catalog integration app -RUN pip install -e "git+https://github.com/overhangio/tutor-richie.git#egg=richie-edx-platform&subdirectory=contrib/edx-platform" +RUN pip install -e "git+https://github.com/openfun/tutor-contrib-richie.git#egg=richie-edx-platform&subdirectory=contrib/edx-platform" diff --git a/tutorrichie/plugin.py b/tutorrichie/plugin.py index cf2c460..aa90755 100644 --- a/tutorrichie/plugin.py +++ b/tutorrichie/plugin.py @@ -14,7 +14,7 @@ }, "defaults": { "VERSION": __version__, - "DOCKER_IMAGE": "{{ DOCKER_REGISTRY }}overhangio/openedx-richie:{{ RICHIE_VERSION }}", + "DOCKER_IMAGE": "{{ DOCKER_REGISTRY }}fundocker/openedx-richie:{{ RICHIE_VERSION }}", "RELEASE_VERSION": "v2.9.1", "HOST": "courses.{{ LMS_HOST }}", "MYSQL_DATABASE": "richie",