Migrate from setup.cfg to pyproject.toml (#107)

* Migrate the Python package information from `setup.cfg` to `pyproject.toml`.

* fix document

.pre-commit-config.yaml

@@ -32,12 +32,6 @@ repos:
       - id: remove-crlf
       - id: remove-tabs
 
-  # Formatting for Python configuration files
-  - repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v2.5.0
-    hooks:
-      - id: setup-cfg-fmt
-
   # Linting and formatting for C++
   - repo: https://github.com/pocc/pre-commit-hooks
     rev: v1.3.5

CONTRIBUTING.md

@@ -132,7 +132,6 @@ The following checks are performed:
 * Python type checking with `mypy` for Python 3.8
 * Python package installation for Python 3.8 to 3.11
 * Pre-commit checks:
-  * Check `setup.cfg` (if modified)
   * Lint Python files with `Ruff` according to the configuration in `pyproject.toml`
     (if any Python files are modified, check all Python files)
 

python/README.md

@@ -97,17 +97,11 @@ To ensure a smooth contribution process, please follow the guidelines below.
 
 #### Option 2: Setup without pre-commit
 
-* Install `Ruff`:
+Install development dependencies:
 
-  ```shell
-  pip install ruff
-  ```
-
-* Install `mypy`:
-
-  ```shell
-  pip install mypy
-  ```
+```shell
+pip install '.[dev]'
+```
 
 ### Checking Changes
 
@@ -155,6 +149,28 @@ type checker, and unit tests.
   python3 -m unittest discover -v
   ```
 
+### Building the Package
+
+To build the package, run the following command:
+
+```shell
+python -m build
+```
+
+This will create a `dist` folder containing the built package.
+
+Install the built package for testing:
+
+```shell
+pip install dist/*.whl
+```
+
+Check whether your distribution's long description will render correctly on PyPI:
+
+```shell
+python -m twine check dist/*
+```
+
 Please ensure that your code passes all the checks and tests before submitting a
 pull request. If you have any questions, need further assistance, or want to report
 a bug or suggest an enhancement, feel free to [open an issue](https://github.com/HenryRLee/PokerHandEvaluator/issues).

python/pyproject.toml

@@ -1,6 +1,62 @@
 [build-system]
+requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
-requires = ["setuptools", "wheel"]
+
+[project]
+name = "phevaluator"
+version = "0.5.3.1"
+requires-python = ">=3.8, <4"
+authors = [
+    {name = "Henry Lee", email = "lee0906@hotmail.com"}
+]
+maintainers = [
+    {name = "azriel1rf", email = "azriel.1rf@gmail.com"}
+]
+description = "PH Evaluator - an efficient Poker Hand Evaluator based on a Perfect Hash algorithm"
+readme = {file = "README.md", content-type = "text/markdown"}
+license = {file = "LICENSE"}
+keywords = ["poker", "texas-holdem", "poker-evaluator"]
+classifiers = [
+    # How mature is this project? Common values are
+    #   3 - Alpha
+    #   4 - Beta
+    #   5 - Production/Stable
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Software Development :: Libraries",
+]
+
+[project.urls]
+Homepage = "https://github.com/HenryRLee/PokerHandEvaluator"
+# TODO(@azriel1rf): Add a link to documentation for Python after it's published
+# https://github.com/HenryRLee/PokerHandEvaluator/issues/105
+Documentation = "https://github.com/HenryRLee/PokerHandEvaluator/tree/master/Documentation"
+Repository = "https://github.com/HenryRLee/PokerHandEvaluator"
+Issues = "https://github.com/HenryRLee/PokerHandEvaluator/issues"
+# TODO(@azriel1rf): Add a link to the changelog after it's published
+# https://github.com/HenryRLee/PokerHandEvaluator/issues/106
+Changelog = "https://github.com/HenryRLee/PokerHandEvaluator/tags"
+Source = "https://github.com/HenryRLee/PokerHandEvaluator/tree/master/python"
+
+[project.optional-dependencies]
+dev = [
+    "mypy",
+    "ruff",
+    "twine",
+]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-data]
+phevaluator = ["tables/*.dat"]
 
 [tool.mypy]
 exclude = ["phevaluator/tables/"]