build: Migrate build to hatchling platform (#124)

* hatchling migration

* Cleanup of unused files for hatchling

* Commentary in version.py changes

* Flake8 doesn't work natively with toml files and would require a plugin and additional dependency. Restored .flake8 config file and remove the setup from toml.

* flake8 comments

* Removed seemingly dead build tool references

Author: TheRealAgentK

.coveragerc

@@ -25,7 +25,8 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install black flake8 coverage .[dev]
+        pip install build
+        pip install -e .[dev]
     
     - name: Check formatting with black
       run: |
@@ -40,4 +41,8 @@ jobs:
         RAYGUN_API_KEY: ${{ secrets.RAYGUN_API_KEY }}
       run: |
         coverage run --source=python3 -m unittest discover python3/tests
-        coverage report -m 
+        coverage report -m
+    
+    - name: Build package
+      run: |
+        python -m build

.github/workflows/python-checks.yml

@@ -1,13 +1,6 @@
 raygun4py
 =========
 
-.. image:: https://travis-ci.org/MindscapeHQ/raygun4py.svg?branch=master
-  :target: https://travis-ci.org/MindscapeHQ/raygun4py?branch=master
-
-.. image:: https://coveralls.io/repos/MindscapeHQ/raygun4py/badge.svg?branch=master
-  :target: https://coveralls.io/r/MindscapeHQ/raygun4py?branch=master
-
-
 Official Raygun provider for **Python** and **PyPy**
 
 **Python 2.7** is supported in versions <= 4.4.0

MANIFEST

@@ -23,7 +23,7 @@ where `x.y.z` is the Major, Minor and Patch release numbers.
 
 ### Update version
 
-Update the `version` in the `python3/raygun4py/version.py` file.
+Update the `__version__` in the `python3/raygun4py/version.py` file.
 
 ### Update CHANGELOG.md
 
@@ -49,14 +49,14 @@ Once the PR has been approved, you can publish the provider.
 
 ### Publish to PyPi 
 
-1. Activate the local environment created in the `CONTRIBUTING.md` guideline.
-2. Install release tools: `python3 -m pip install setuptools twine`.
-3. Run `python setup.py sdist`.
-4. Check that the file `dist/raygun4py-x.y.z.tar.gz` has been created.
-5. Run `twine check dist/raygun4py-x.y.z.tar.gz` and fix any warnings. Repeat the `sdist` command if necessary.
-5. Run `twine upload dist/raygun4py-x.x.x.tar.gz` to upload the package.
-6. Provide the API token when asked.
-7. Now the package is available for customers.
+1. Install build tools: `pip install build`
+2. Build the package: `python -m build`
+3. Check that the files `dist/raygun4py-x.y.z.tar.gz` and `dist/raygun4py-x.y.z-py3-none-any.whl` have been created.
+4. Install twine: `pip install twine`
+5. Check the package: `twine check dist/*`
+6. Upload to PyPi: `twine upload dist/*`
+7. Provide the API token when asked.
+8. Now the package is available for customers.
 
 ### Merge PR to master
 

MANIFEST.in

@@ -0,0 +1,86 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "raygun4py"
+dynamic = ["version"]
+authors = [{ name = "Raygun", email = "hello@raygun.io" }]
+description = "Official Raygun provider for Python"
+readme = "README.rst"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Communications",
+]
+dependencies = [
+    "jsonpickle>=4.0.4",
+    "blinker>=1.3.0",
+    "requests>=2.9.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "unittest2>=1.1.0",
+    "coveralls>=1.5.1",
+    "mock>=2.0.0",
+    "django>=1.8.8",
+    "flask>=0.10",
+    "WebTest>=2.0.32",
+    "black",
+    "flake8",
+    "coverage",
+]
+
+[project.scripts]
+raygun4py = "raygun4py.cli:main"
+
+[project.urls]
+Homepage = "https://raygun.com"
+Documentation = "https://raygun.com/documentation/language-guides/python/crash-reporting/installation/"
+Repository = "https://github.com/MindscapeHQ/raygun4py"
+Changelog = "https://github.com/MindscapeHQ/raygun4py/blob/master/CHANGELOG.md"
+
+[tool.hatch.version]
+path = "python3/raygun4py/version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/python3/raygun4py",
+    "/README.rst",
+    "/LICENSE",
+    "/CHANGELOG.md",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["python3/raygun4py"]
+
+[tool.hatch.build.targets.wheel.sources]
+"python3/raygun4py" = "raygun4py"
+
+[tool.coverage.report]
+omit = [
+    "*/__init__.py",
+    "*/site-packages/*",
+    "*/dist-packages/*",
+    "*/tests/*",
+    "/opt/*",
+]
+exclude_lines = [
+    "pragma: no cover",
+    "except Exception as e:",
+    "except Exception:",
+]
+
+[tool.black]
+target-version = ["py39", "py310", "py311", "py312", "py313"]

README.rst

@@ -1,5 +1,5 @@
 # Store the version here so:
 # 1) we don't load dependencies by storing it in __init__.py
-# 2) we can import it in setup.py for the same reason
-# 3) we can import it into your module module
+# 2) hatchling can read it for dynamic versioning (pyproject.toml)
+# 3) we can import it into your module
 __version__ = "6.0.1"