6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-05 21:07:50 +00:00

chore: get rid of tutor-openedx

In the past, tutor was installed with "pip install tutor-openedx". For
some time (since v12.0.2), "tutor" was installed as a dependency of
"tutor-openedx". Now is the time to get rid of that old package.
The standard way of installing tutor is now with "pip install tutor".
This commit is contained in:
Régis Behmo 2021-11-02 18:15:06 +01:00
parent 10ea9dfc99
commit 999c23d1ff
7 changed files with 3 additions and 78 deletions

3
.gitignore vendored
View File

@ -7,6 +7,3 @@ __pycache__
/build/ /build/
/dist/ /dist/
/release_description.md /release_description.md
# Copied at build-time
/tutor-openedx/tutoropenedx/__about__.py

View File

@ -2,6 +2,7 @@
Note: Breaking changes between versions are indicated by "💥". Note: Breaking changes between versions are indicated by "💥".
- 💥[Improvement] Get rid of the "tutor-openedx" package, which is no longer supported.
- [Bugfix] Fix running Caddy container in k8s, which should always be the case even if `ENABLE_WEB_PROXY` is false. - [Bugfix] Fix running Caddy container in k8s, which should always be the case even if `ENABLE_WEB_PROXY` is false.
- 💥[Improvement] Run all services as unprivileged containers, for better security. This has multiple consequences: - 💥[Improvement] Run all services as unprivileged containers, for better security. This has multiple consequences:
- The "openedx-dev" image is now built with `tutor dev dc build lms`. - The "openedx-dev" image is now built with `tutor dev dc build lms`.

View File

@ -1,6 +1,6 @@
.DEFAULT_GOAL := help .DEFAULT_GOAL := help
.PHONY: docs .PHONY: docs
SRC_DIRS = ./tutor ./tests ./bin ./tutor-openedx SRC_DIRS = ./tutor ./tests ./bin
BLACK_OPTS = --exclude templates ${SRC_DIRS} BLACK_OPTS = --exclude templates ${SRC_DIRS}
###### Development ###### Development
@ -18,18 +18,13 @@ upgrade-requirements: ## Upgrade requirements files
pip-compile --upgrade requirements/dev.in pip-compile --upgrade requirements/dev.in
pip-compile --upgrade requirements/docs.in pip-compile --upgrade requirements/docs.in
build-pythonpackage: build-pythonpackage-tutor build-pythonpackage-tutor-openedx ## Build python packages ready to upload to pypi build-pythonpackage: build-pythonpackage-tutor ## Build python packages ready to upload to pypi
build-pythonpackage-tutor: ## Build the "tutor" python package for upload to pypi build-pythonpackage-tutor: ## Build the "tutor" python package for upload to pypi
python setup.py sdist python setup.py sdist
build-pythonpackage-tutor-openedx: ## Build the obsolete "tutor-openedx" python package for upload to pypi
cp tutor/__about__.py tutor-openedx/tutoropenedx/
cd tutor-openedx && python setup.py sdist --dist-dir ../dist
push-pythonpackage: ## Push python package to pypi push-pythonpackage: ## Push python package to pypi
twine upload --skip-existing dist/tutor-$(shell make version).tar.gz twine upload --skip-existing dist/tutor-$(shell make version).tar.gz
twine upload --skip-existing dist/tutor-openedx-$(shell make version).tar.gz
test: test-lint test-unit test-types test-format test-pythonpackage ## Run all tests by decreasing order or priority test: test-lint test-unit test-types test-format test-pythonpackage ## Run all tests by decreasing order or priority
@ -47,7 +42,6 @@ test-types: ## Check type definitions
test-pythonpackage: build-pythonpackage ## Test that package can be uploaded to pypi test-pythonpackage: build-pythonpackage ## Test that package can be uploaded to pypi
twine check dist/tutor-$(shell make version).tar.gz twine check dist/tutor-$(shell make version).tar.gz
twine check dist/tutor-openedx-$(shell make version).tar.gz
format: ## Format code automatically format: ## Format code automatically
black $(BLACK_OPTS) black $(BLACK_OPTS)

View File

@ -1,3 +0,0 @@
WARNING: This project has moved to https://pypi.org/project/tutor/. You should now install Tutor with::
pip install tutor

View File

@ -1,64 +0,0 @@
import io
import os
import sys
from setuptools import setup
HERE = os.path.abspath(os.path.dirname(__file__))
def load_readme():
with io.open(os.path.join(HERE, "README.rst"), "rt", encoding="utf8") as f:
return f.read()
def load_about():
about = {}
with io.open(
os.path.join(HERE, "tutoropenedx", "__about__.py"), "rt", encoding="utf-8"
) as f:
exec(f.read(), about) # pylint: disable=exec-used
return about
ABOUT = load_about()
setup(
name="tutor-openedx",
version=ABOUT["__version__"],
url="https://docs.tutor.overhang.io/",
project_urls={
"Documentation": "https://docs.tutor.overhang.io/",
"Code": "https://github.com/overhangio/tutor",
"Issue tracker": "https://github.com/overhangio/tutor/issues",
"Community": "https://discuss.overhang.io",
},
license="AGPLv3",
author="Overhang.io",
author_email="contact@overhang.io",
description="The Docker-based Open edX distribution designed for peace of mind",
long_description=load_readme(),
long_description_content_type="text/x-rst",
packages=["tutoropenedx"],
python_requires=">=3.5",
install_requires=["tutor=={}".format(ABOUT["__version__"])],
classifiers=[
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"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",
"Programming Language :: Python :: 3.10",
],
)
sys.stderr.write(
"""
Installing Tutor from tutor-openedx is deprecated. You should instead install the "tutor" package with:
pip install tutor
"""
)