Merge branch 'release/0.9.0'

Author: stumpylog

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,74 @@
+name: Bug Report
+description: Create a report to help us improve gotenberg-client
+title: "[BUG] "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: "Please fill out this form to help us address your bug report."
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      placeholder: "e.g., 3.11.0"
+    validations:
+      required: true
+
+  - type: input
+    id: client-version
+    attributes:
+      label: gotenberg-client Version
+      placeholder: "e.g., 1.0.0"
+    validations:
+      required: true
+
+  - type: input
+    id: server-version
+    attributes:
+      label: Gotenberg Server Version
+      placeholder: "e.g., 7.8.3"
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of the bug
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps To Reproduce
+      description: Minimal code example that demonstrates the issue
+      render: python
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What you expected to happen
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Error Output
+      description: Error messages, stack traces, or any other relevant information
+      render: shell
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 🤔 Questions and Help
+    url: https://github.com/stumpylog/gotenberg-client/discussions/categories/q-a
+    about: This issue tracker is not for support questions. Please refer to our Discussions.
+  - name: 🚀 Feature Request
+    url: https://github.com/stumpylog/gotenberg-client/discussions/categories/ideas
+    about: Remember to search for existing feature requests and "up-vote" any you like

.github/workflows/ci.yml

@@ -58,7 +58,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', 'pypy3.9', 'pypy3.10']
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', 'pypy3.10']
 
     steps:
     -

.vscode/settings.json

@@ -6,5 +6,8 @@
 		"**/.pytest_cache": true,
 		"**/.cache": true,
 		"**/.coverage*": true
+	},
+	"yaml.schemas": {
+		"https://json.schemastore.org/github-issue-config.json": "file:///u%3A/projects/gotenberg-client/.github/ISSUE_TEMPLATE/config.yml"
 	}
 }

CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.0] - 2025-01-09
+
+### Breaking Change
+
+- Drop testing on PyPy3.9 ([#45](https://github.com/stumpylog/gotenberg-client/pull/45))
+  - The library should still work, but required wheels for testing are no longer built against pypy3.9. Flagging this as breaking just for an FYI
+
+### Added
+
+- Allow setting user agent string and provide a default ([#46](https://github.com/stumpylog/gotenberg-client/pull/46))
+- Allow providing an instance of [httpx.BasicAuth](https://www.python-httpx.org/advanced/authentication/#basic-authentication) when creating the client ([#47](https://github.com/stumpylog/gotenberg-client/pull/47))
+- Documentation and project management updates ([#48](https://github.com/stumpylog/gotenberg-client/pull/48))
+  - Enabled discussions for Q&A and Feature Requests
+  - Created a bug report template
+  - Created a contributing guide
+
 ## [0.8.2] - 2024-12-17
 
 ### Fixed

docs/contributing.md

@@ -0,0 +1,73 @@
+# Contributing
+
+This document outlines how to contribute to the gotenberg-client project effectively.
+
+## Questions and Support
+
+For general questions and support, please use our [Q&A Discussions](https://github.com/stumpylog/gotenberg-client/discussions/categories/q-a) forum.
+
+## Feature Requests
+
+We use the [Ideas category in Github Discussions](https://github.com/stumpylog/gotenberg-client/discussions/categories/ideas) for feature requests and project improvements. Please check existing discussions before creating a new one to avoid duplicates.
+
+## Bug Reports
+
+If you've identified a bug:
+
+1. Check existing issues to avoid duplicates
+2. Create a new issue using the bug report template
+3. Include:
+   - Python version
+   - gotenberg-client version
+   - Gotenberg server version
+   - Minimal code example demonstrating the bug
+   - Expected vs actual behavior
+   - Error messages/stack traces if applicable
+
+## Development Setup
+
+1. Fork and clone the repository
+1. Install [`uv`](https://astral.sh/uv/) for independent tool installations
+   ```bash
+   curl -LsSf https://astral.sh/uv/install.sh | sh  # Install uv
+   ```
+1. Install [`hatch`](https://github.com/pypa/hatch) and [`pre-commit`](https://github.com/pre-commit/pre-commit)
+   ```bash
+   uv tool install hatch pre-commit
+   ```
+1. Set up pre-commit hooks:
+   ```bash
+   pre-commit install
+   ```
+
+## Code Style
+
+We use [`hatch`](https://github.com/pypa/hatch) for project management, testing, and formatting:
+
+- Run tests: `hatch test`
+- Format & lint code: `hatch fmt`
+- Check formatting: `hatch fmt --check`
+- Check typing: `hatch run typing:run`
+- Build documentation: `hatch run docs:build`
+
+Please ensure all tests pass and code is properly formatted before submitting changes. The code must pass the CI to be merged.
+
+## Pull Request Process
+
+1. Create a new branch from `develop`
+2. Make your changes
+3. Update tests and documentation
+4. Run the test suite
+5. Submit a PR against `develop`
+6. Reference any related issues
+
+PRs should:
+
+- Focus on a single feature/fix
+- Include tests for new functionality
+- Update documentation as needed
+- Follow existing code style
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the same terms as the project.

mkdocs.yml

@@ -10,6 +10,7 @@ nav:
   - "index.md"
   - "usage.md"
   - "routes.md"
+  - "contributing.md"
   - "roadmap.md"
   - "changelog.md"
 

src/gotenberg_client/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2023-present Trenton H <rda0128ou@mozmail.com>
 #
 # SPDX-License-Identifier: MPL-2.0
-__version__ = "0.8.2"
+__version__ = "0.9.0"

src/gotenberg_client/_client.py

@@ -5,8 +5,10 @@
 from types import TracebackType
 from typing import Optional
 
+from httpx import BasicAuth
 from httpx import Client
 
+from gotenberg_client.__about__ import __version__
 from gotenberg_client._convert.chromium import ChromiumApi
 from gotenberg_client._convert.libre_office import LibreOfficeApi
 from gotenberg_client._convert.pdfa import PdfAApi
@@ -35,6 +37,8 @@ class GotenbergClient:
     def __init__(
         self,
         host: str,
+        user_agent: str = f"gotenberg-client/{__version__}",
+        auth: Optional[BasicAuth] = None,
         *,
         timeout: float = 30.0,
         log_level: int = logging.ERROR,
@@ -45,12 +49,20 @@ def __init__(
 
         Args:
             host (str): The base URL of the Gotenberg service.
+            user_agent (str): The value of the User-Agent header to set.  Defaults to gotenberg-client/{version}
+            auth (httpx.BasicAuth, optional): The value of the authentication for the server.  Defaults to None
             timeout (float, optional): The timeout for API requests in seconds. Defaults to 30.0.
             log_level (int, optional): The logging level for httpx and httpcore. Defaults to logging.ERROR.
             http2 (bool, optional): Whether to use HTTP/2. Defaults to True.
         """
         # Configure the client
-        self._client = Client(base_url=host, timeout=timeout, http2=http2)
+        self._client = Client(
+            base_url=host,
+            timeout=timeout,
+            http2=http2,
+            auth=auth,
+            headers={"User-Agent": user_agent},
+        )
 
         # Set the log level
         logging.getLogger("httpx").setLevel(log_level)