Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: cleanup #474

Merged
merged 1 commit into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,29 @@ 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
**********

Changed
=======

- Remove incorrect build step from xblock ci template
- Fix docstrings
- Add a unit test so coverage can run
Expand All @@ -50,6 +54,7 @@ Changed

Changed
=======

- Remove pii_check from xblock cookiecutter

2023-12-06
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cookiecutter-python-library/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
*****
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Core requirements for using this application

-c constraints.txt

django-statici18n
edx-i18n-tools
Mako
XBlock
XBlock
xblock-utils
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Core dependencies for installing other packages

-c constraints.txt

pip
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Requirements for test runs.

-c constraints.txt

-r base.txt # Core dependencies for this package
Expand Down
1 change: 1 addition & 0 deletions requirements/base.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Core requirements for using this package template

-c constraints.txt

cookiecutter # Utility to generate a package from this template
Expand Down
1 change: 1 addition & 0 deletions requirements/ci.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Requirements for running tests on CI

-c constraints.txt

tox # Virtualenv management for tests
1 change: 1 addition & 0 deletions requirements/dev.in
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions requirements/pip-tools.in
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions requirements/pip.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Core dependencies for installing other packages

-c constraints.txt

pip
Expand Down
1 change: 1 addition & 0 deletions requirements/test.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Requirements for test runs

-c constraints.txt

-r base.txt # Core dependencies for the cookiecutter
Expand Down