From 84c9a155eb0f9ca4437fe450649390460540ad73 Mon Sep 17 00:00:00 2001 From: Emad Rad Date: Mon, 29 Jul 2024 14:35:53 +0330 Subject: [PATCH] chore: cleanup - edx -> Open edX - trailing whitespace removed - rst cleanup in changelog --- CHANGELOG.rst | 19 ++++++++++++------- cookiecutter-python-library/README.rst | 2 +- .../requirements/base.in | 4 +++- .../requirements/dev.in | 1 + .../requirements/pip.in | 1 + .../requirements/test.in | 1 + requirements/base.in | 1 + requirements/ci.in | 1 + requirements/dev.in | 1 + requirements/pip-tools.in | 1 + requirements/pip.in | 1 + requirements/test.in | 1 + 12 files changed, 25 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a4b95c43..16cb5aaa 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -22,18 +22,21 @@ Change Log Changed ======= -- added new catalog-info field ``openedx.org/release`` -- removed openedx.yaml file + +- Added new catalog-info field ``openedx.org/release`` +- Removed ``openedx.yaml`` file 2023-12-18 ********** Added ======= + - Added python3.11 support. Changed ======= + - Add selfcheck target to Makefile 2023-12-15 @@ -41,6 +44,7 @@ Changed Changed ======= + - Remove incorrect build step from xblock ci template - Fix docstrings - Add a unit test so coverage can run @@ -50,6 +54,7 @@ Changed Changed ======= + - Remove pii_check from xblock cookiecutter 2023-12-06 @@ -95,7 +100,7 @@ Added Changed ======= -- In setup.py, support advertising constraints on packages with multiple extras +- In ``setup.py``, support advertising constraints on packages with multiple extras - Fail packaging if requirements are named differently in different places or have different extras listed 2023-08-11 @@ -229,9 +234,9 @@ Fixed Changed ======= -- Updated upgrade-python-requirements.yml GitHub Action to latest from `upgrade-python-requirements.yml template`_. -- Remove deprecated codecov CI package in requirements/ci.in -- Added linebreaks to root urls.py docstring for cookiecutter-django-ida to squash Sphinx error. +- Updated ``upgrade-python-requirements.yml`` GitHub Action to latest from `upgrade-python-requirements.yml template`_. +- Remove deprecated codecov CI package in ``requirements/ci.in`` +- Added line breaks to root ``urls.py`` docstring for ``cookiecutter-django-ida`` to squash Sphinx error. - Fixed cookiecutter-django-ida .coveragerc file so it references project_name, not source_name. - Fixed .github/workflow/ci.yml so it uploads coverage reports in the tox env that the coverage files are generated in. @@ -304,7 +309,7 @@ Removed Fixed ===== -- Fix or remove ``tags`` repo metadata in several templates; remove deprecated ``nick`` from openedx.yaml (see OEP-2) +- Fix or remove ``tags`` repo metadata in several templates; remove deprecated ``nick`` from ``openedx.yaml`` (see OEP-2) - Remove extraneous period after short description - Move short description to top of readme - Use project name, not repo name, for package name in setup.py diff --git a/cookiecutter-python-library/README.rst b/cookiecutter-python-library/README.rst index 78c9c41a..ab22bb83 100644 --- a/cookiecutter-python-library/README.rst +++ b/cookiecutter-python-library/README.rst @@ -7,7 +7,7 @@ A cookiecutter_ template for edX python projects. For django-related cookiecutte **This template produces a Python 3.12 project.** -This cookiecutter template is intended for new edX python libraries. +This cookiecutter template is intended for new Open edX python libraries. Usage ***** diff --git a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/base.in b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/base.in index 42ea69ff..a545f093 100644 --- a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/base.in +++ b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/base.in @@ -1,7 +1,9 @@ # Core requirements for using this application + -c constraints.txt django-statici18n edx-i18n-tools Mako -XBlock +XBlock +xblock-utils diff --git a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/dev.in b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/dev.in index eb8c92c5..784fa63b 100644 --- a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/dev.in +++ b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/dev.in @@ -1,4 +1,5 @@ # Additional requirements for development of this application + -c constraints.txt -r pip-tools.txt # pip-tools and its dependencies, for managing requirements files diff --git a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/pip.in b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/pip.in index 716c6f28..45714de7 100644 --- a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/pip.in +++ b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/pip.in @@ -1,4 +1,5 @@ # Core dependencies for installing other packages + -c constraints.txt pip diff --git a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/test.in b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/test.in index 3a923b40..c1caa28a 100644 --- a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/test.in +++ b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/test.in @@ -1,4 +1,5 @@ # Requirements for test runs. + -c constraints.txt -r base.txt # Core dependencies for this package diff --git a/requirements/base.in b/requirements/base.in index 49ab1abf..107bcbe8 100644 --- a/requirements/base.in +++ b/requirements/base.in @@ -1,4 +1,5 @@ # Core requirements for using this package template + -c constraints.txt cookiecutter # Utility to generate a package from this template diff --git a/requirements/ci.in b/requirements/ci.in index 6959b416..d27c9159 100644 --- a/requirements/ci.in +++ b/requirements/ci.in @@ -1,4 +1,5 @@ # Requirements for running tests on CI + -c constraints.txt tox # Virtualenv management for tests diff --git a/requirements/dev.in b/requirements/dev.in index c9805e18..1aeacb30 100644 --- a/requirements/dev.in +++ b/requirements/dev.in @@ -1,4 +1,5 @@ # Additional requirements for development of this template + -c constraints.txt -r pip-tools.txt # pip-tools and its dependencies, for managing requirements files diff --git a/requirements/pip-tools.in b/requirements/pip-tools.in index 3f1b64ae..0295d2c8 100644 --- a/requirements/pip-tools.in +++ b/requirements/pip-tools.in @@ -1,4 +1,5 @@ # Just the dependencies to run pip-tools, mainly for the "upgrade" make target + -c constraints.txt pip-tools # Contains pip-compile, used to generate pip requirements files diff --git a/requirements/pip.in b/requirements/pip.in index 716c6f28..45714de7 100644 --- a/requirements/pip.in +++ b/requirements/pip.in @@ -1,4 +1,5 @@ # Core dependencies for installing other packages + -c constraints.txt pip diff --git a/requirements/test.in b/requirements/test.in index 2eced3e0..7e739633 100644 --- a/requirements/test.in +++ b/requirements/test.in @@ -1,4 +1,5 @@ # Requirements for test runs + -c constraints.txt -r base.txt # Core dependencies for the cookiecutter