Migrate project to use pyproject.toml instead of setup.py

- Replaced setup.py with pyproject.toml as the primary configuration file.
- Updated build and installation process to leverage PEP 517/518 standards.
- Configured package metadata, dependencies, and optional dependencies in pyproject.toml.
- Removed legacy setup.py and its references across the project.
- Updated MANIFEST.in to ensure proper inclusion/exclusion of files in source distributions.
- Adjusted GitHub Actions workflows and deployment script to use modern build commands (e.g., `python -m build`).
- Updating .gitignore to include pyenv and some build dirs

This commit modernizes the package and aligns it with current Python packaging standards, improving maintainability and compatibility with tools like pip, build, and twine.

Author: mdevolde

.github/workflows/test.yml

@@ -25,10 +25,10 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip setuptools wheel
+        python -m pip install --upgrade pip setuptools wheel build
         pip install pytest pytest-xdist # Testing packages
-        python setup.py install_egg_info # Workaround https://github.com/pypa/pip/issues/4537
-        pip install -e . # Run pytest
+        python -m build --sdist --wheel
+        pip install dist/*.whl # Run pytest
     - name: Import language_tool_python
       run: |
         printf "import language_tool_python\n" | python

.gitignore

@@ -8,3 +8,12 @@ __pycache__/
 build/
 dist/
 language_tool_python/LanguageTool-*/
+language_tool_python-*/
+pytest-cache-files-*/
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/

MANIFEST.in

@@ -1,9 +1,12 @@
-exclude Makefile
-include COPYING
-include README.rst
 include run_doctest.py
-include test.bash
-include test.py
-include test_remote.bash
-include requirements.txt
-exclude language_tool_python/Language-Tool-*
+include tests/test_local.bash
+include tests/test_remote.bash
+prune pytest-cache-files-*/
+prune env/
+prune .env
+prune .venv
+prune env/
+prune venv/
+prune ENV/
+prune env.bak/
+prune venv.bak/

Makefile

@@ -15,4 +15,4 @@ check:
 		./language_tool_python \
 		$(wildcard ./language_tool_python/*.py) \
 		$(wildcard *.py)
-	python setup.py --long-description | rstcheck -
+	python extract_long_description.py | rstcheck -

build_and_publish.sh

@@ -1,4 +1,5 @@
-rm -rf build/ dist/
-python setup.py sdist bdist_wheel
+rm -rf build/ dist/ *.egg-info/
+python -m pip install --upgrade pip setuptools wheel build
+python -m build
 twine check dist/*
 twine upload dist/* --verbose

extract_long_description.py

@@ -0,0 +1,13 @@
+import tomllib
+import os
+
+with open("pyproject.toml", "rb") as f:
+    pyproject = tomllib.load(f)
+
+readme_path = pyproject["project"]["readme"]
+
+if os.path.exists(readme_path):
+    with open(readme_path, "r", encoding="utf-8") as readme_file:
+        print(readme_file.read())
+else:
+    raise FileNotFoundError(f"{readme_path} not found.")

pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "language_tool_python"
+version = "2.8.2"
+description = "Checks grammar using LanguageTool."
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [
+    { name = "Jack Morris", email = "jxmorris12@gmail.com" }
+]
+urls = { Homepage = "https://github.com/jxmorris12/language_tool_python" }
+
+dependencies = [
+    "pip",
+    "requests",
+    "tqdm",
+    "wheel"
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-xdist",
+    "pytest-cov",
+    "pytest-runner"
+]
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"