Catching the Python SDK up to the Node SDK

.github/workflows/acceptance.yaml

@@ -1,20 +1,31 @@
-name: Acceptance Tests                                                                                                                                                        
-                                                                                                                                                                     
+name: Acceptance Tests
+
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 6 * * *'  # Daily at 6am UTC                                                                                                                                             
-
-jobs:                                                                                                                                                              
-  test:                                                                                                                                                            
-    runs-on: ubuntu-latest                                                                                                                                         
-    steps:                                                                                                                                                         
-      - uses: actions/checkout@v4                                                                                                                                  
-
-      - name: Set up Python                                                                                                                                        
-        uses: actions/setup-python@v5                                                                                                                              
-        with:                                                                                                                                                      
-          python-version: '3.12'                                                                                                                                   
-
-      - name: Placeholder                                                                                                                                          
-        run: echo "Tests workflow placeholder - will be expanded"
+    - cron: '0 6 * * *'  # Daily at 6am UTC
+
+jobs:
+  acceptance:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run acceptance tests
+        run: pytest tests/acceptance/ -v
+        env:
+          HYPHEN_DEV: ${{ vars.HYPHEN_DEV }}
+          HYPHEN_API_KEY: ${{ secrets.HYPHEN_API_KEY }}
+          HYPHEN_PUBLIC_API_KEY: ${{ secrets.HYPHEN_PUBLIC_API_KEY }}
+          HYPHEN_APPLICATION_ID: ${{ vars.HYPHEN_APPLICATION_ID }}
+          HYPHEN_ORGANIZATION_ID: ${{ vars.HYPHEN_ORGANIZATION_ID }}
+          HYPHEN_PROJECT_ID: ${{ vars.HYPHEN_PROJECT_ID }}
+          HYPHEN_LINK_DOMAIN: ${{ vars.HYPHEN_LINK_DOMAIN }}

.github/workflows/release.yaml

@@ -1,18 +1,43 @@
 name: Release
-                                                                                                                                                                     
+
 on:
-  workflow_dispatch:                                                                                                                                        
-
-jobs:                                                                                                                                                              
-  test:                                                                                                                                                            
-    runs-on: ubuntu-latest                                                                                                                                         
-    steps:                                                                                                                                                         
-      - uses: actions/checkout@v4                                                                                                                                  
-
-      - name: Set up Python                                                                                                                                        
-        uses: actions/setup-python@v5                                                                                                                              
-        with:                                                                                                                                                      
-          python-version: '3.12'                                                                                                                                   
-
-      - name: Placeholder                                                                                                                                          
-        run: echo "Tests workflow placeholder - will be expanded"
+  workflow_dispatch:
+  release:
+    types: [released]
+
+permissions:
+  contents: read
+  id-token: write  # Required for OIDC publishing to PyPI
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          pip install -e ".[dev]"
+          pip install build twine
+
+      - name: Run linting
+        run: ruff check hyphen tests
+
+      - name: Run type checking
+        run: mypy hyphen
+
+      - name: Run tests
+        run: pytest --ignore=tests/acceptance
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # No password needed - uses OIDC trusted publishing

.github/workflows/tests.yaml

@@ -1,21 +1,40 @@
-name: Tests                                                                                                                                                        
-
-on:                                                                                                                                                                
-  push:                                                                                                                                                            
-    branches: [main]                                                                                                                                               
-  pull_request:                                                                                                                                                    
-    branches: [main]                                                                                                                                               
-
-jobs:                                                                                                                                                              
-  test:                                                                                                                                                            
-    runs-on: ubuntu-latest                                                                                                                                         
-    steps:                                                                                                                                                         
-      - uses: actions/checkout@v4                                                                                                                                  
-
-      - name: Set up Python                                                                                                                                        
-        uses: actions/setup-python@v5                                                                                                                              
-        with:                                                                                                                                                      
-          python-version: '3.12'                                                                                                                                   
-
-      - name: Placeholder                                                                                                                                          
-        run: echo "Tests workflow placeholder - will be expanded"
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run linting
+        run: ruff check hyphen tests
+
+      - name: Run type checking
+        run: mypy hyphen
+
+      - name: Run tests with coverage
+        run: pytest --cov=hyphen --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at in the repo issues
+or maintainers public email address.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
+
+Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+We release new versions of this project (maintenance/features) on a monthly cadence so please be aware that some items will not get released right away.
+
+# Pull Request Process
+You can contribute changes to this repo by opening a pull request:
+
+1) After forking this repository to your Git account, make the proposed changes on your forked branch.
+2) Run tests and linting locally `pip install -e ".[dev]" && pytest && ruff check hyphen tests` to ensure that your changes do not break any existing functionality.
+3) Commit your changes and push them to your forked repository.
+4) Navigate to the main `python-sdk` repository and select the *Pull Requests* tab.
+5) Click the *New pull request* button, then select the option "Compare across forks"
+6) Leave the base branch set to main. Set the compare branch to your forked branch, and open the pull request.
+7) Once your pull request is created, ensure that all checks have passed and that your branch has no conflicts with the base branch. If there are any issues, resolve these changes in your local repository, and then commit and push them to git.
+8) Similarly, respond to any reviewer comments or requests for changes by making edits to your local repository and pushing them to Git.
+9) Once the pull request has been reviewed, those with write access to the branch will be able to merge your changes into the `python-sdk` repository.
+
+If you need more information on the steps to create a pull request, you can find a detailed walkthrough in the [Github documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
+
+# Code of Conduct
+Please refer to our [Code of Conduct](CODE_OF_CONDUCT.md) readme for how to contribute to this open source project and work within the community.