build: modernize repo-tools-data-schema to use uv and pyproject.toml

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_call:
+
+jobs:
+  run_tests:
+    name: ${{ matrix.toxenv }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.12"]
+        toxenv: [quality, docs, py]
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # v6.8.0
+        with:
+          enable-cache: true
+          python-version: "${{ matrix.python-version }}"
+      - run: uv sync --group ci
+      - run: uv run tox -e ${{ matrix.toxenv }}
+      - if: matrix.toxenv == 'py' && matrix.python-version == '3.12'
+        uses: codecov/codecov-action@e53489f4d376d79066609109e7a95a29eb3740b1 # v7.0.0
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: unittests
+          fail_ci_if_error: true

MANIFEST.in

@@ -1,6 +1,10 @@
-include CHANGELOG.rst
-include LICENSE.txt
-include README.rst
-include requirements/base.in
-recursive-include repo_tools_data_schema *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg *.py
-include requirements/constraints.txt
+# Exclude development, test, and documentation folders
+prune .github
+prune docs
+prune tests
+
+# Exclude root level configuration and build files
+exclude Makefile
+exclude conftest.py
+exclude .gitignore
+exclude tox.ini

Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean help quality requirements selfcheck upgrade
+.PHONY: clean docs help quality requirements selfcheck upgrade
 
 .DEFAULT_GOAL := help
 
@@ -16,40 +16,22 @@ clean: ## remove generated byte code, coverage reports, and build artifacts
 	rm -fr dist/
 	rm -fr *.egg-info
 
-# Define PIP_COMPILE_OPTS=-v to get more information during make upgrade.
-PIP_COMPILE = pip-compile --rebuild --upgrade $(PIP_COMPILE_OPTS)
-
-COMMON_CONSTRAINTS_TXT=requirements/common_constraints.txt
-.PHONY: $(COMMON_CONSTRAINTS_TXT)
-$(COMMON_CONSTRAINTS_TXT):
-	wget -O "$(@)" https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt || touch "$(@)"
-
-upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
-upgrade: $(COMMON_CONSTRAINTS_TXT)
-	## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
-	pip install -r requirements/pip-tools.txt
-	# Make sure to compile files after any other files they include!
-	$(PIP_COMPILE) --allow-unsafe -o requirements/pip.txt requirements/pip.in
-	$(PIP_COMPILE) -o requirements/pip-tools.txt requirements/pip-tools.in
-	pip install -r requirements/pip.txt
-	pip install -r requirements/pip-tools.txt
-	$(PIP_COMPILE) -o requirements/base.txt requirements/base.in
-	$(PIP_COMPILE) -o requirements/test.txt requirements/test.in
-	$(PIP_COMPILE) -o requirements/doc.txt requirements/doc.in
-	$(PIP_COMPILE) -o requirements/quality.txt requirements/quality.in
-	$(PIP_COMPILE) -o requirements/ci.txt requirements/ci.in
-	$(PIP_COMPILE) -o requirements/dev.txt requirements/dev.in
+upgrade: ## update python dependencies
+	uv run --with edx-lint edx_lint write_uv_constraints pyproject.toml
+	uv lock --upgrade
+
+docs: ## validate RST files
+	doc8 README.rst CHANGELOG.rst
 
 quality: ## check coding style with pycodestyle and pylint
-	pylint repo_tools_data_schema *.py
-	pycodestyle repo_tools_data_schema *.py
-	isort --check-only --diff repo_tools_data_schema *.py
+	pylint repo_tools_data_schema
+	pycodestyle repo_tools_data_schema
+	isort --check-only --diff repo_tools_data_schema
 	make selfcheck
 
 requirements: ## install development environment requirements
-	pip install -r requirements/pip-tools.txt
-	pip-sync requirements/dev.txt requirements/private.*
-	pip install -e .
+	uv sync --group dev
+	uv tool install tox --with tox-uv
 
 test: ## run the few tests we have
 	pytest

pyproject.toml

@@ -0,0 +1,105 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "repo-tools-data-schema"
+version = "2.0"
+description = "Schema for repo-tools-data"
+requires-python = ">=3.12"
+license = "Apache-2.0"
+license-files = ["LICENSE*"]
+authors = [
+    {name = "Open edX Project", email = "oscm@openedx.org"},
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+]
+keywords = ["Python", "edx"]
+readme = "README.rst"
+
+dependencies = [
+    "PyYAML",
+    "schema",
+]
+
+[project.urls]
+Homepage = "https://github.com/openedx/repo-tools-data-schema"
+Repository = "https://github.com/openedx/repo-tools-data-schema"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+exclude = ["tests*", "*.tests", "*.tests.*"]
+
+[tool.setuptools.package-data]
+"*" = [
+    "*.html",
+    "*.png",
+    "*.gif",
+    "*.js",
+    "*.css",
+    "*.jpg",
+    "*.jpeg",
+    "*.svg",
+]
+
+[tool.uv]
+package = true
+constraint-dependencies = [
+    "Django<6.0",
+    "elasticsearch<7.14.0",
+]
+
+[tool.edx_lint]
+uv_constraints = []
+
+[dependency-groups]
+test = [
+    "pytest-cov",
+]
+quality = [
+    {include-group = "test"},
+    "edx-lint",
+    "isort",
+    "pycodestyle",
+]
+doc = [
+    {include-group = "test"},
+    "doc8",
+    "readme-renderer",
+    "Sphinx",
+    "sphinx-book-theme",
+]
+ci = [
+    "tox",
+    "tox-uv",
+]
+dev = [
+    {include-group = "quality"},
+    {include-group = "ci"},
+    "diff-cover",
+]
+
+[tool.doc8]
+max-line-length = 120
+
+[tool.isort]
+include_trailing_comma = true
+indent = "    "
+line_length = 120
+multi_line_output = 3
+
+[tool.pytest.ini_options]
+addopts = "--cov=repo_tools_data_schema --cov-report=xml"
+
+[tool.coverage.run]
+source = ["repo_tools_data_schema"]
+
+[tool.coverage.report]
+

repo_tools_data_schema/__init__.py

@@ -2,6 +2,11 @@
 Schema for repo-tools-data.
 """
 
-__version__ = '2.0'
+from importlib.metadata import PackageNotFoundError, version
 
 from .repo_tools_data_schema import validate_orgs, validate_salesforce_export
+
+try:
+    __version__ = version("repo-tools-data-schema")
+except PackageNotFoundError:
+    __version__ = "unknown"