Release 0.1.0

.github/workflows/commit_checks.yaml

@@ -13,6 +13,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'  # Specify a Python version explicitly
       - uses: pre-commit/[email protected]
 
   test:
@@ -25,14 +27,15 @@ jobs:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest", "macos-latest", "windows-latest"]
-        # TODO": Enable py313 support when all packages will be available on the conda 'main' channel
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
-    #environment: mailgun
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     env:
       APIKEY: ${{ secrets.APIKEY }}
       DOMAIN: ${{ secrets.DOMAIN }}
     steps:
-      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required for setuptools-scm
+
       - uses: conda-incubator/setup-miniconda@v3
         with:
           python-version: ${{ matrix.python-version }}
@@ -44,5 +47,6 @@ jobs:
         run: |
           pip install .
           conda info
+
       - name: Test package imports
         run: python -c "import mailgun"

.github/workflows/pr_validation.yml

@@ -0,0 +1,28 @@
+name: PR Validation
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Build package
+        run: |
+          pip install build setuptools wheel setuptools-scm
+          python -m build
+
+      - name: Test installation
+        run: |
+          pip install dist/*.whl
+          python -c "from importlib.metadata import version; print(version('mailgun-python'))"

.github/workflows/publish.yml

@@ -0,0 +1,77 @@
+name: Publish Package
+
+on:
+  push:
+    tags: ['v*']  # Triggers on any tag push
+  release:
+    types: [published]  # Triggers when a GitHub release is published
+  workflow_dispatch:  # Manual trigger
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install build tools
+        run: pip install build setuptools wheel setuptools-scm twine
+
+      - name: Extract version
+        id: get_version
+        run: |
+          # Get clean version from the tag or release
+          if [[ "${{ github.event_name }}" == "release" ]]; then
+            # For releases, get the version from the release tag
+            TAG_NAME="${{ github.event.release.tag_name }}"
+          else
+            # For tags, get version from the tag
+            TAG_NAME="${{ github.ref_name }}"
+          fi
+
+          # Remove 'v' prefix
+          VERSION=$(echo $TAG_NAME | sed 's/^v//')
+
+          # Check if this is a stable version (no rc, alpha, beta, dev, etc.)
+          if [[ $TAG_NAME =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "IS_STABLE=true" >> $GITHUB_ENV
+          else
+            echo "IS_STABLE=false" >> $GITHUB_ENV
+          fi
+
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Build package
+        run: |
+          # Force clean version
+          export SETUPTOOLS_SCM_PRETEND_VERSION=$VERSION
+          python -m build
+          twine check dist/*
+
+      # Always publish to TestPyPI for all tags and releases
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          skip-existing: true
+          verbose: true
+
+      # Only publish to PyPI for stable GitHub releases (no RC/alpha/beta)
+      - name: Publish to PyPI
+        if: github.event_name == 'release' && env.IS_STABLE == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          verbose: true

.pre-commit-config.yaml

@@ -67,7 +67,7 @@ repos:
         exclude: ^tests
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.31.1
+    rev: 0.32.1
     hooks:
       - id: check-github-workflows
 
@@ -93,7 +93,7 @@ repos:
           - --ignore-init-module-imports
 
   - repo: https://github.com/pycqa/flake8
-    rev: 7.1.1
+    rev: 7.2.0
     hooks:
     -   id: flake8
         additional_dependencies:
@@ -104,7 +104,7 @@ repos:
         exclude: ^tests
 
   - repo: https://github.com/PyCQA/pylint
-    rev: v3.3.4
+    rev: v3.3.6
     hooks:
       - id: pylint
         args:
@@ -114,11 +114,11 @@ repos:
     rev: v3.19.1
     hooks:
       - id: pyupgrade
-        args: [--py38-plus, --keep-runtime-typing]
+        args: [--py39-plus, --keep-runtime-typing]
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     # Ruff version.
-    rev: v0.9.6
+    rev: v0.11.4
     hooks:
       # Run the linter.
       - id: ruff
@@ -143,12 +143,12 @@ repos:
         exclude: ^mailgun/examples/
 
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.393
+    rev: v1.1.398
     hooks:
     - id: pyright
 
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.8.2
+    rev: 1.8.3
     hooks:
       - id: bandit
         args: ["-c", "pyproject.toml", "-r", "."]
@@ -157,7 +157,7 @@ repos:
         additional_dependencies: [".[toml]"]
 
   - repo: https://github.com/crate-ci/typos
-    rev: typos-dict-v0.12.4
+    rev: v1.31.1
     hooks:
       - id: typos
 

CHANGELOG.md

@@ -0,0 +1,23 @@
+# CHANGELOG
+
+We [keep a changelog.](http://keepachangelog.com/)
+
+## Next release
+
+## Version 0.1.0 (2025-04-02) - Public Release
+
+### Added
+
+- CHANGELOG.md
+
+### Technical (internal)
+
+- Initial version
+
+### Tickets closed
+
+- [DE-1453](https://mailgun.atlassian.net/browse/DE-1453) - Define MVP - Support all of the major functionality and Mailgun APIs
+
+### Pull Requests Merged
+
+- [PR_2](https://github.com/mailgun/mailgun-python/pull/2) - JIRA-727: Done ticket title

Makefile

@@ -38,7 +38,7 @@ export PRINT_HELP_PYSCRIPT
 
 BROWSER := python -c "$$BROWSER_PYSCRIPT"
 
-clean: clean-cov clean-build clean-env clean-pyc clean-test clean-temp clean-other ## remove all build, test, coverage and Python artifacts
+clean: clean-cov clean-build clean-pyc clean-test clean-temp clean-other ## remove all build, test, coverage and Python artifacts
 
 clean-cov:
 	rm -rf .coverage
@@ -90,7 +90,6 @@ environment:    ## handles environment creation
 environment-dev:       ## Handles environment creation
 	conda env create -n $(CONDA_ENV_NAME)-dev -y --file environment-dev.yml
 	conda run --name $(CONDA_ENV_NAME)-dev pip install -e .
-	$(CONDA_ACTIVATE) $(CONDA_ENV_NAME)-dev
 
 install: clean	## install the package to the active Python's site-packages
 	pip install .