build: add Python package validation and fix CHANGELOG formatting (#222)

* build: add Python package validation

* docs: fix CHANGELOG header formatting

Author: Agrendalath

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         python-version: ['3.11', '3.12']
-        toxenv: [py, quality, django42, django52, e2e]
+        toxenv: [py, quality, django42, django52, e2e, package]
 
     steps:
       - uses: actions/checkout@v4

CHANGELOG.rst

@@ -16,11 +16,24 @@ Unreleased
 
 *
 
+0.3.4 – 2025-08-13
+******************
+
+Added
+-----
+
+* CI check to validate the Python package.
+
+Fixed
+-----
+
+* CHANGELOG header formatting.
+
 0.3.3 – 2025-08-12
 ******************
 
 Fixed
-=====
+-----
 
 * Do not raise runtime errors if an incorrect course ID is provided when
   checking if the MySQL backend is enabled.

forum/__init__.py

@@ -2,4 +2,4 @@
 Openedx forum app.
 """
 
-__version__ = "0.3.3"
+__version__ = "0.3.4"

requirements/doc.in

@@ -5,6 +5,4 @@
 
 doc8                      # reStructuredText style checker
 sphinx-book-theme         # Common theme for all Open edX projects
-twine                     # Validates README.rst for usage on PyPI
-build                     # Needed to build the wheel for twine check
 Sphinx                    # Documentation builder

requirements/doc.txt

@@ -37,7 +37,7 @@ billiard==4.2.1
     #   -r requirements/test.txt
     #   celery
 build==1.2.2.post1
-    # via -r requirements/doc.in
+    # via -r requirements/test.txt
 cachetools==5.5.0
     # via
     #   -r requirements/test.txt
@@ -420,7 +420,7 @@ text-unidecode==1.3
 tox==4.23.2
     # via -r requirements/test.txt
 twine==5.1.1
-    # via -r requirements/doc.in
+    # via -r requirements/test.txt
 typing-extensions==4.12.2
     # via
     #   -r requirements/test.txt

requirements/test.in

@@ -9,3 +9,5 @@ code-annotations          # provides commands used by the pii_check tox target.
 tox
 mongomock
 Faker
+twine                     # Validates README.rst for usage on PyPI
+build                     # Needed to build the wheel for twine check

requirements/test.txt

@@ -26,6 +26,8 @@ billiard==4.2.1
     # via
     #   -r requirements/base.txt
     #   celery
+build==1.2.2.post1
+    # via -r requirements/test.in
 cachetools==5.5.0
     # via tox
 camel-converter[pydantic]==4.0.1
@@ -294,6 +296,8 @@ text-unidecode==1.3
     #   python-slugify
 tox==4.23.2
     # via -r requirements/test.in
+twine==5.1.1
+    # via -r requirements/test.in
 typing-extensions==4.12.2
     # via
     #   -r requirements/base.txt

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py{311, 312}-django{42,52}
+envlist = py{311, 312}-django{42,52},package
 
 [doc8]
 ; D001 = Line too long
@@ -92,3 +92,11 @@ deps =
     -r{toxinidir}/requirements/test.txt
 commands =
     make test-e2e
+
+[testenv:package]
+deps =
+    build
+    twine
+commands =
+    python -m build
+    twine check dist/*