chore: Release 6.0.0 (#121)

Author: miquelbeltran

CHANGELOG.md

@@ -1,3 +1,18 @@
+## 6.0.0 (23/05/25):
+
+Breaking changes:
+  - Filter keys support wildcard matching. See README for details.
+
+Features:
+  - Added `set_customdata` to `RaygunSender`.
+
+Bug Fixes:
+  - Ensure `on_grouping_key` always provides a `RaygunMessage` object to the callback.
+
+Internal changes:
+  - Fix static analysis errors and code formatting.
+  - GitHub CI setup. 
+
 ## 5.0.0 (13/02/24):
 Breaking changes:
   - Support for Python 2.7 has been dropped

CONTRIBUTING.MD

@@ -1,23 +1,9 @@
 ## Getting Started with Local Development
-Before starting, you'll need to ensure you have the appropriate version of Python installed.
-
----
 
-# Python 2
-1. Install the virtual environment manager: `python2 -m pip install virtualenv`
-2. Navigate to the project directory: `cd <project folder>`
-3. Create a new virtual environment using Python 2: `python2 -m virtualenv venv2`
-4. Activate the virtual environment. On Windows, use `venv2\Scripts\activate`. On Unix or MacOS, use `source venv2/bin/activate`.
-5. Install the development dependencies and prepare local package: `python2 -m pip install -e .[dev]`
-6. Run tests with the command: 
-```bash
-python2 -m unittest discover python2/tests
-```
-- Remember to deactivate the virtual environment when you're done: `deactivate`
+Before starting, you'll need to ensure you have the appropriate version of Python installed.
 
----
+### Python 3
 
-# Python 3
 1. Install the virtual environment manager: `python3 -m pip install virtualenv`
 2. Navigate to the project directory: `cd <project folder>`
 3. Create a new virtual environment using Python 3: `python3 -m virtualenv venv3`
@@ -29,4 +15,3 @@ python3 -m unittest discover python3/tests
 ```
 - Remember to deactivate the virtual environment when you're done: `deactivate`
 
----

README.rst

@@ -8,7 +8,7 @@ raygun4py
   :target: https://coveralls.io/r/MindscapeHQ/raygun4py?branch=master
 
 
-Official Raygun provider for **Python 2.7**, **Python 3.1+** and **PyPy**
+Official Raygun provider for **Python** and **PyPy**
 
 **Python 2.7** is supported in versions <= 4.4.0
 
@@ -293,14 +293,14 @@ Supports `*` at a position to indicate if you want to filter keys that start, en
 +--------------------+---------------+----------------------+
 | Filter             | Wildcard      | Matches              |
 +====================+===============+======================+
-| Start              | 'foo*'        | foobar, fooqux, foo  |
-+====================+===============+======================+
-| End                | '*foo'        | barfoo, quxfoo, foo  |
-+====================+===============+======================+
-| Contain            | '*foo*'       | foobar, tfooqux, foo |
-+====================+===============+======================+
-| Exact              | 'foo'         | foo                  |
-+====================+===============+======================+
+| Start              | `foo*`        | foobar, fooqux, foo  |
++--------------------+---------------+----------------------+
+| End                | `*foo`        | barfoo, quxfoo, foo  |
++--------------------+---------------+----------------------+
+| Contain            | `*foo*`       | foobar, tfooqux, foo |
++--------------------+---------------+----------------------+
+| Exact              | `foo`         | foo                  |
++--------------------+---------------+----------------------+
 
 +------------------+---------------+--------------------+
 | Function         | Arguments     | Type               |
@@ -318,6 +318,21 @@ Provide a list of exception types to ignore here. Any exceptions that are passed
 
 You can mutate the candidate payload by passing in a function that accepts one parameter using this function. This allows you to completely customize what data is sent, immediately before it happens.
 
+.. code:: python
+
+    def before_send_mutate_payload(message):
+        message["newKey"] = "newValue"
+        return message
+
+    def before_send_cancel_send(message):
+        return None
+
+    # Mutate the payload
+    client.on_before_send(before_send_mutate_payload)
+
+    # Cancel the send
+    client.on_before_send(before_send_cancel_send)
+
 +------------------+---------------+--------------------+
 | Function         | Arguments     | Type               |
 +==================+===============+====================+
@@ -326,6 +341,13 @@ You can mutate the candidate payload by passing in a function that accepts one p
 
 Pass a callback function to this method to configure custom grouping logic. The callback should take one parameter, an instance of RaygunMessage, and return a string between 1 and 100 characters in length (see 'Custom Grouping Logic' below for more details).
 
+.. code:: python
+
+    def group_by_message(message):
+        return message.get_error().message[:100]
+
+    client.on_grouping_key(group_by_message)
+
 +----------------+---------------+--------------------+
 | Function       | Arguments     | Type               |
 +================+===============+====================+

RELEASING.md

@@ -0,0 +1,71 @@
+# Releasing Raygun4Py
+
+Raygun for Python is published on PyPi as [`raygun4py`](https://pypi.org/project/raygun4py/).
+
+## Semantic versioning
+
+This package follows semantic versioning,
+
+Given a version number MAJOR.MINOR.PATCH (x.y.z), increment the:
+
+- MAJOR version when you make incompatible changes
+- MINOR version when you add functionality in a backward compatible manner
+- PATCH version when you make backward compatible bug fixes
+
+To learn more about semantic versioning check: https://semver.org/
+
+## Preparing for release
+
+### Release branch
+
+Create a new branch named `release/x.y.z` 
+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 CHANGELOG.md
+
+Add a new entry in the `CHANGELOG.md` file.
+
+Obtain a list of changes using the following git command:
+
+```
+git log --pretty=format:"- %s (%as)"
+```
+
+### Commit and open a PR
+
+Commit all the changes into a commit with the message `chore: Release x.y.z` where `x.y.z` is the Major, Minor and Patch release numbers.
+
+Then push the branch and open a new PR, ask the team to review it.
+
+## Publishing
+
+### PR approval
+
+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.
+
+### Merge PR to master
+
+With the PR approved and the package published, squash and merge the PR into `master`.
+
+### Tag and create Github Release
+
+Go to https://github.com/MindscapeHQ/raygun4py/releases and create a new Release.
+
+GitHub will create a tag for you, you don't need to create the tag manually.
+
+You can also generate the release notes automatically.

python3/raygun4py/version.py

@@ -2,4 +2,4 @@
 # 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
-__version__ = "5.0.0"
+__version__ = "6.0.0"

setup.py

@@ -1,12 +1,8 @@
-import sys
-
 from setuptools import setup
 
 packages = ["raygun4py", "raygun4py.middleware"]
 
-base_dir = "python2"
-if sys.version_info[0] == 3:
-    base_dir = "python3"
+base_dir = "python3"
 
 exec(open("%s/raygun4py/version.py" % base_dir).read())
 requirements = ["jsonpickle >= 4.0.4", "blinker >= 1.3.0", "requests >= 2.9.1"]
@@ -29,8 +25,9 @@
     url="https://raygun.com",
     author="Raygun",
     author_email="[email protected]",
-    description="Official Raygun provider for Python 2.7 and Python 3+",
+    description="Official Raygun provider for Python",
     long_description=open("README.rst").read(),
+    long_description_content_type="text/x-rst",
     install_requires=requirements,
     extras_require={"dev": dev_requirements},
     entry_points={"console_scripts": ["raygun4py = raygun4py.cli:main"]},
@@ -39,13 +36,11 @@
         "Intended Audience :: Developers",
         "License :: OSI Approved :: MIT License",
         "Programming Language :: Python",
-        "Programming Language :: Python :: 3.6",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
         "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",
     ],
 )