euipo-tm-client 0.1.0__tar.gz

euipo_tm_client-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

euipo_tm_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ansel Halliburton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

euipo_tm_client-0.1.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: euipo-tm-client
+Version: 0.1.0
+Summary: Minimal Python client for the EUIPO trademark search API
+Project-URL: Homepage, https://github.com/anseljh/euipo-tm-client
+Project-URL: Repository, https://github.com/anseljh/euipo-tm-client
+Project-URL: Issues, https://github.com/anseljh/euipo-tm-client/issues
+Author-email: Ansel Halliburton <anseljh@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api-client,euipo,intellectual-property,ip,trademark
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Legal Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.28.1
+Description-Content-Type: text/markdown
+
+# euipo-tm-client
+
+Minimal Python client for the [EUIPO](https://euipo.europa.eu/) (European Union
+Intellectual Property Office) trademark search API.
+
+It is a thin, synchronous wrapper (built on [`httpx`](https://www.python-httpx.org/))
+that handles OAuth2 authentication and returns responses as raw parsed JSON
+(`dict`). It covers the two core endpoints: searching for trade marks and
+retrieving the details of a single trade mark.
+
+## Installation
+
+```bash
+pip install euipo-tm-client
+```
+
+## Configuration
+
+The client reads credentials from environment variables (you can keep them in a
+`.env` file in the working directory — real environment variables take
+precedence):
+
+| Variable            | Description                                   |
+| ------------------- | --------------------------------------------- |
+| `EUIPO_API_KEY`     | Your application's client ID                  |
+| `EUIPO_API_SECRET`  | Your application's client secret              |
+| `EUIPO_ENVIRONMENT` | `"sandbox"` (default) or `"production"`       |
+
+Obtain credentials and subscribe your application to the *Trademark search* API
+plan via the [EUIPO developer portal](https://dev-sandbox.euipo.europa.eu/).
+
+## Usage
+
+```python
+from euipo_tm_client import TrademarkSearchClient
+
+with TrademarkSearchClient() as client:
+    # Search using an RSQL query expression.
+    results = client.search_trademarks(
+        query="wordMarkSpecification.verbalElement==apple",
+        size=10,
+    )
+    print(results["totalElements"])
+    for tm in results["trademarks"]:
+        print(tm["applicationNumber"], tm.get("status"))
+
+    # Retrieve full details for one trade mark.
+    detail = client.get_trademark("018692868", language="en")
+    print(detail["status"])
+```
+
+Credentials and environment can also be passed explicitly instead of via the
+environment:
+
+```python
+client = TrademarkSearchClient(
+    api_key="...", api_secret="...", environment="production",
+)
+```
+
+### Errors
+
+API and authentication failures raise typed exceptions, all subclasses of
+`EUIPOError`:
+
+- `EUIPOAuthError` — token acquisition failed.
+- `EUIPOAPIError` — the API returned a non-2xx response; exposes `.status_code`
+  and the parsed `.body`.
+
+## Query language (RSQL)
+
+The `query` argument of `search_trademarks()` accepts an **RSQL** (REST Query
+Language) expression — a compact, URL-friendly filter syntax. A clause is
+`field` + `operator` + `value`, and clauses combine with `and` / `or` (use
+parentheses to group). RSQL avoids unsafe characters, so no URL encoding is
+needed.
+
+Comparison operators:
+
+| Operator           | Meaning                                  |
+| ------------------ | ---------------------------------------- |
+| `==`               | equal to (supports `*` as a wildcard)    |
+| `!=`               | not equal to (supports `*` as a wildcard)|
+| `<` `<=` `>` `>=`  | range comparison (dates and numbers)     |
+| `=in=`             | in a set, e.g. `=in=(WORD,FIGURATIVE)`   |
+| `=out=`            | not in a set                             |
+| `=all=`            | contains all of a set                    |
+
+Each field supports only a subset of these operators. Date fields
+(`applicationDate`, `registrationDate`, `expiryDate`, …) expect `yyyy-MM-dd`
+values. Examples:
+
+```text
+# Verbal element exactly "apple"
+wordMarkSpecification.verbalElement==apple
+
+# Wildcard match + status, with nice-class membership
+niceClasses=all=(25,28,40) and wordMarkSpecification.verbalElement==*Dog* and status==REGISTERED
+
+# Date range with grouped OR logic
+applicationDate>=2023-05-04 and ((markFeature==FIGURATIVE and niceClasses=all=(25,26)) or (markFeature==WORD and niceClasses=out=(40)))
+```
+
+The full grammar, the list of supported fields, and the operators each field
+allows are documented in the `query` parameter of the OpenAPI spec
+(`specs/openapi.json`).
+
+## Development
+
+This project is managed with [`uv`](https://docs.astral.sh/uv/).
+
+```bash
+uv sync          # install dependencies
+uv run pytest    # run the test suite (mocks HTTP; no live credentials needed)
+uv run main.py   # run the live sandbox demo (requires credentials)
+```
+
+## License
+
+[MIT](LICENSE)

euipo_tm_client-0.1.0/README.md

@@ -0,0 +1,120 @@
+# euipo-tm-client
+
+Minimal Python client for the [EUIPO](https://euipo.europa.eu/) (European Union
+Intellectual Property Office) trademark search API.
+
+It is a thin, synchronous wrapper (built on [`httpx`](https://www.python-httpx.org/))
+that handles OAuth2 authentication and returns responses as raw parsed JSON
+(`dict`). It covers the two core endpoints: searching for trade marks and
+retrieving the details of a single trade mark.
+
+## Installation
+
+```bash
+pip install euipo-tm-client
+```
+
+## Configuration
+
+The client reads credentials from environment variables (you can keep them in a
+`.env` file in the working directory — real environment variables take
+precedence):
+
+| Variable            | Description                                   |
+| ------------------- | --------------------------------------------- |
+| `EUIPO_API_KEY`     | Your application's client ID                  |
+| `EUIPO_API_SECRET`  | Your application's client secret              |
+| `EUIPO_ENVIRONMENT` | `"sandbox"` (default) or `"production"`       |
+
+Obtain credentials and subscribe your application to the *Trademark search* API
+plan via the [EUIPO developer portal](https://dev-sandbox.euipo.europa.eu/).
+
+## Usage
+
+```python
+from euipo_tm_client import TrademarkSearchClient
+
+with TrademarkSearchClient() as client:
+    # Search using an RSQL query expression.
+    results = client.search_trademarks(
+        query="wordMarkSpecification.verbalElement==apple",
+        size=10,
+    )
+    print(results["totalElements"])
+    for tm in results["trademarks"]:
+        print(tm["applicationNumber"], tm.get("status"))
+
+    # Retrieve full details for one trade mark.
+    detail = client.get_trademark("018692868", language="en")
+    print(detail["status"])
+```
+
+Credentials and environment can also be passed explicitly instead of via the
+environment:
+
+```python
+client = TrademarkSearchClient(
+    api_key="...", api_secret="...", environment="production",
+)
+```
+
+### Errors
+
+API and authentication failures raise typed exceptions, all subclasses of
+`EUIPOError`:
+
+- `EUIPOAuthError` — token acquisition failed.
+- `EUIPOAPIError` — the API returned a non-2xx response; exposes `.status_code`
+  and the parsed `.body`.
+
+## Query language (RSQL)
+
+The `query` argument of `search_trademarks()` accepts an **RSQL** (REST Query
+Language) expression — a compact, URL-friendly filter syntax. A clause is
+`field` + `operator` + `value`, and clauses combine with `and` / `or` (use
+parentheses to group). RSQL avoids unsafe characters, so no URL encoding is
+needed.
+
+Comparison operators:
+
+| Operator           | Meaning                                  |
+| ------------------ | ---------------------------------------- |
+| `==`               | equal to (supports `*` as a wildcard)    |
+| `!=`               | not equal to (supports `*` as a wildcard)|
+| `<` `<=` `>` `>=`  | range comparison (dates and numbers)     |
+| `=in=`             | in a set, e.g. `=in=(WORD,FIGURATIVE)`   |
+| `=out=`            | not in a set                             |
+| `=all=`            | contains all of a set                    |
+
+Each field supports only a subset of these operators. Date fields
+(`applicationDate`, `registrationDate`, `expiryDate`, …) expect `yyyy-MM-dd`
+values. Examples:
+
+```text
+# Verbal element exactly "apple"
+wordMarkSpecification.verbalElement==apple
+
+# Wildcard match + status, with nice-class membership
+niceClasses=all=(25,28,40) and wordMarkSpecification.verbalElement==*Dog* and status==REGISTERED
+
+# Date range with grouped OR logic
+applicationDate>=2023-05-04 and ((markFeature==FIGURATIVE and niceClasses=all=(25,26)) or (markFeature==WORD and niceClasses=out=(40)))
+```
+
+The full grammar, the list of supported fields, and the operators each field
+allows are documented in the `query` parameter of the OpenAPI spec
+(`specs/openapi.json`).
+
+## Development
+
+This project is managed with [`uv`](https://docs.astral.sh/uv/).
+
+```bash
+uv sync          # install dependencies
+uv run pytest    # run the test suite (mocks HTTP; no live credentials needed)
+uv run main.py   # run the live sandbox demo (requires credentials)
+```
+
+## License
+
+[MIT](LICENSE)

euipo_tm_client-0.1.0/euipo_tm_client/__init__.py

@@ -0,0 +1,15 @@
+"""Minimal Python client for the EUIPO trademark search API."""
+
+from __future__ import annotations
+
+from .client import TrademarkSearchClient
+from .config import Settings
+from .errors import EUIPOAPIError, EUIPOAuthError, EUIPOError
+
+__all__ = [
+    "TrademarkSearchClient",
+    "Settings",
+    "EUIPOError",
+    "EUIPOAuthError",
+    "EUIPOAPIError",
+]

euipo_tm_client-0.1.0/euipo_tm_client/auth.py

@@ -0,0 +1,82 @@
+"""OAuth2 client-credentials authentication for the EUIPO trademark search API."""
+
+from __future__ import annotations
+
+import time
+
+import httpx
+
+from .errors import EUIPOAuthError
+
+# Refresh slightly before the token actually expires to avoid races near the boundary.
+_EXPIRY_SAFETY_MARGIN_SECONDS = 60
+
+
+class OAuth2ClientCredentials:
+    """Fetches and caches an OAuth2 access token using the client-credentials flow.
+
+    The EUIPO API authenticates applications anonymously: we POST the client id
+    and secret to the token endpoint and receive a bearer token, which is cached
+    until shortly before it expires.
+    """
+
+    def __init__(
+        self,
+        *,
+        client_id: str,
+        client_secret: str,
+        token_url: str,
+        http_client: httpx.Client,
+        scope: str = "uid",
+    ) -> None:
+        self._client_id = client_id
+        self._client_secret = client_secret
+        self._token_url = token_url
+        self._http = http_client
+        self._scope = scope
+        self._token: str | None = None
+        self._expires_at: float = 0.0
+
+    def get_token(self, *, force_refresh: bool = False) -> str:
+        """Return a valid bearer token, fetching a new one when needed."""
+        if not force_refresh and self._token is not None and time.monotonic() < self._expires_at:
+            return self._token
+        return self._fetch_token()
+
+    def _fetch_token(self) -> str:
+        try:
+            response = self._http.post(
+                self._token_url,
+                data={
+                    "grant_type": "client_credentials",
+                    "client_id": self._client_id,
+                    "client_secret": self._client_secret,
+                    "scope": self._scope,
+                },
+                headers={"Content-Type": "application/x-www-form-urlencoded"},
+            )
+        except httpx.HTTPError as exc:
+            raise EUIPOAuthError(f"Token request to {self._token_url} failed: {exc}") from exc
+
+        if response.status_code != httpx.codes.OK:
+            raise EUIPOAuthError(
+                f"Token request failed with status {response.status_code}: {response.text!r}"
+            )
+
+        try:
+            payload = response.json()
+        except ValueError as exc:
+            raise EUIPOAuthError(f"Token response was not valid JSON: {response.text!r}") from exc
+
+        token = payload.get("access_token")
+        if not token:
+            raise EUIPOAuthError(f"Token response did not contain an access_token: {payload!r}")
+
+        expires_in = payload.get("expires_in", 0)
+        try:
+            expires_in = int(expires_in)
+        except (TypeError, ValueError):
+            expires_in = 0
+        self._token = token
+        self._expires_at = time.monotonic() + max(expires_in - _EXPIRY_SAFETY_MARGIN_SECONDS, 0)
+        return token