python-epo-ops-client 4.1.0__tar.gz → 4.2.1__tar.gz

{python-epo-ops-client-4.1.0 → python_epo_ops_client-4.2.1}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 4.2.1 (2025-09-09)
+
+- Made network timeout configurable. Thanks, @ofipify.
+
+## 4.2.0 (2025-07-26)
+
+- Added support for the "legal" service endpoint, providing legal status
+  information for patents as documented in chapter 3.5 of the OPS v3.2
+  documentation. Thanks, @MartiONE.
+
 ## 4.1.0 (2024-01-25)
 
 - Configure HTTP client to use a network timeout of 10 seconds

{python-epo-ops-client-4.1.0 → python_epo_ops_client-4.2.1}/Makefile

@@ -33,38 +33,36 @@ check: lint test        ## Run linter and software tests
 check-ci: lint test-ci  ## Run linter and software tests on CI
 
 lint: ## lint the project
-	ruff .
-	black --check .
+	ruff check .
+	ruff format --check .
 
 format: ## Run code formatting
+	ruff format .
 	# Configure Ruff not to auto-fix (remove!):
 	# Ignore unused imports (F401), unused variables (F841), `print` statements (T201), and commented-out code (ERA001).
-	ruff --fix --ignore=ERA --ignore=F401 --ignore=F841 --ignore=T20 --ignore=ERA001 .
-	black .
+	ruff check --fix --ignore=ERA --ignore=F401 --ignore=F841 --ignore=T20 --ignore=ERA001 .
 
 test: clean ## Run tests with virtualenv Python
-	py.test -s -v --lf --cov epo_ops tests --cov-report term-missing --cov-report xml
+	pytest --lf
 
 test-ci: clean ## Run tests in CI environment with virtualenv Python
-	py.test -v --cov epo_ops tests --cov-report term-missing --cov-report xml
+	pytest
 
-coverage: clean ## Check code coverage locally
-	py.test -s -v --cov epo_ops tests --cov-report term-missing --cov-report xml --cov-report html
+coverage: clean test-ci ## Check code coverage locally
+	coverage html
 	open htmlcov/index.html
 
 release: clean # Package and upload a release to PyPI
-	python setup.py sdist
-	python setup.py bdist_wheel
+	python -m build
 	twine check dist/*
 	twine upload --repository pypi dist/*
-	open https://pypi.python.org/pypi/python-epo-ops-client
+	open https://pypi.org/project/python-epo-ops-client/
 
 release-test: clean # Package and upload a release to testpypi
-	python setup.py sdist
-	python setup.py bdist_wheel
+	python -m build
 	twine check dist/*
 	twine upload --repository testpypi dist/*
-	open https://testpypi.python.org/pypi/python-epo-ops-client
+	open https://test.pypi.org/project/python-epo-ops-client/
 
 sdist: clean
 	python setup.py sdist

{python-epo-ops-client-4.1.0 → python_epo_ops_client-4.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-epo-ops-client
-Version: 4.1.0
+Version: 4.2.1
 Summary: Python client for EPO OPS, the European Patent Office's Open Patent Services API.
 Home-page: https://github.com/ip-tools/python-epo-ops-client
 Download-URL: https://pypi.org/project/python-epo-ops-client/#files
@@ -21,26 +21,40 @@ Classifier: Programming Language :: Python :: 3.9
 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
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: dogpile.cache<1.2
+Requires-Dist: dogpile.cache<1.5
 Requires-Dist: importlib-metadata; python_version < "3.8"
-Requires-Dist: python-dateutil<2.9
+Requires-Dist: python-dateutil<2.10
 Requires-Dist: requests<3,>=2.27
 Requires-Dist: six<2
 Provides-Extra: develop
-Requires-Dist: black<24; extra == "develop"
-Requires-Dist: ruff==0.0.285; python_version >= "3.7" and extra == "develop"
-Requires-Dist: twine<5; extra == "develop"
+Requires-Dist: ruff<0.13; python_version >= "3.7" and extra == "develop"
+Requires-Dist: twine<7; extra == "develop"
 Requires-Dist: wheel<1; extra == "develop"
 Provides-Extra: test
-Requires-Dist: pytest<8; extra == "test"
+Requires-Dist: pytest<9; extra == "test"
 Requires-Dist: pytest-cache<2; extra == "test"
-Requires-Dist: pytest-cov<4.2; extra == "test"
-Requires-Dist: python-dotenv<0.20; extra == "test"
-Requires-Dist: responses<0.24; extra == "test"
+Requires-Dist: pytest-cov<7.1; extra == "test"
+Requires-Dist: python-dotenv<1.2; extra == "test"
+Requires-Dist: responses<0.26; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 # python-epo-ops-client
 
@@ -51,17 +65,42 @@ Requires-Dist: responses<0.24; extra == "test"
 
 python-epo-ops-client is an [Apache2 licensed][apache license] client library
 for accessing the [European Patent Office][epo]'s ("EPO") [Open Patent
-Services][ops] ("OPS") v.3.2 (based on [v 1.3.16 of the reference guide][ops guide]).
+Services][ops] ("OPS") v3.2 (based on [v1.3.16 of the reference guide][ops guide]).
 
 ```python
 import epo_ops
 
-client = epo_ops.Client(key='abc', secret='xyz')  # Instantiate client
-response = client.published_data(  # Retrieve bibliography data
-  reference_type = 'publication',  # publication, application, priority
-  input = epo_ops.models.Docdb('1000000', 'EP', 'A1'),  # original, docdb, epodoc
-  endpoint = 'biblio',  # optional, defaults to biblio in case of published_data
-  constituents = []  # optional, list of constituents
+# Instantiate client.
+client = epo_ops.Client(key="abc", secret="xyz")
+
+# Retrieve bibliography data.
+response = client.published_data(
+
+  # publication, application, priority
+  reference_type="publication",
+
+  # docdb, epodoc
+  input=epo_ops.models.Docdb("1000000", "EP", "A1"),
+
+  # optional, defaults to biblio in case of published_data
+  endpoint="biblio",
+
+  # optional, list of constituents
+  constituents=[],
+)
+
+# Retrieve description.
+response = client.published_data(
+  reference_type="publication",
+  input=epo_ops.models.Docdb("1000000", "EP", "A1"),
+  endpoint="description",
+)
+
+# Retrieve claims.
+response = client.published_data(
+  reference_type="publication",
+  input=epo_ops.models.Docdb("1000000", "EP", "A1"),
+  endpoint="claims",
 )
 ```
 
@@ -108,12 +147,12 @@ Currently the Client knows how to issue request for the following services:
 | ----------------------------------------------------------------------------- | --------------------- | --------- |
 | `family(reference_type, input, endpoint=None, constituents=None)`             | family                | inpadoc   |
 | `image(path, range=1, extension='tiff')`                                      | published-data/images | images    |
+| `legal(reference_type, input)`                                                | legal                 | other     |
 | `number(reference_type, input, output_format)`                                | number-service        | other     |
 | `published_data(reference_type, input, endpoint='biblio', constituents=None)` | published-data        | retrieval |
 | `published_data_search(cql, range_begin=1, range_end=25, constituents=None)`  | published-data/search | search    |
 | `register(reference_type, input, constituents=['biblio'])`                    | register              | other     |
 | `register_search(cql, range_begin=1, range_end=25)`                           | register/search       | other     |
-| `register_search(cql, range_begin=1, range_end=25)`                           | register/search       | other     |
 
 Bulk operations can be achieved by passing a list of valid models to the
 published_data input field.
@@ -206,8 +245,8 @@ details.
 
 [apache license]: http://www.apache.org/licenses/LICENSE-2.0
 [developer's area]: https://developers.epo.org/ops-v3-2/apis
-[dogpile.cache region]: http://dogpilecache.readthedocs.org/en/latest/api.html#module-dogpile.cache.region
-[dogpile.cache]: https://bitbucket.org/zzzeek/dogpile.cache
+[dogpile.cache region]: https://dogpilecache.sqlalchemy.org/en/latest/api.html#module-dogpile.cache.region
+[dogpile.cache]: https://github.com/sqlalchemy/dogpile.cache
 [epo]: http://epo.org
 [ops guide]: https://link.epo.org/web/ops_v3.2_documentation_-_version_1.3.19_en.pdf
 [ops]: https://www.epo.org/searching-for-patents/data/web-services/ops.html

{python-epo-ops-client-4.1.0 → python_epo_ops_client-4.2.1}/README.md

@@ -7,17 +7,42 @@
 
 python-epo-ops-client is an [Apache2 licensed][apache license] client library
 for accessing the [European Patent Office][epo]'s ("EPO") [Open Patent
-Services][ops] ("OPS") v.3.2 (based on [v 1.3.16 of the reference guide][ops guide]).
+Services][ops] ("OPS") v3.2 (based on [v1.3.16 of the reference guide][ops guide]).
 
 ```python
 import epo_ops
 
-client = epo_ops.Client(key='abc', secret='xyz')  # Instantiate client
-response = client.published_data(  # Retrieve bibliography data
-  reference_type = 'publication',  # publication, application, priority
-  input = epo_ops.models.Docdb('1000000', 'EP', 'A1'),  # original, docdb, epodoc
-  endpoint = 'biblio',  # optional, defaults to biblio in case of published_data
-  constituents = []  # optional, list of constituents
+# Instantiate client.
+client = epo_ops.Client(key="abc", secret="xyz")
+
+# Retrieve bibliography data.
+response = client.published_data(
+
+  # publication, application, priority
+  reference_type="publication",
+
+  # docdb, epodoc
+  input=epo_ops.models.Docdb("1000000", "EP", "A1"),
+
+  # optional, defaults to biblio in case of published_data
+  endpoint="biblio",
+
+  # optional, list of constituents
+  constituents=[],
+)
+
+# Retrieve description.
+response = client.published_data(
+  reference_type="publication",
+  input=epo_ops.models.Docdb("1000000", "EP", "A1"),
+  endpoint="description",
+)
+
+# Retrieve claims.
+response = client.published_data(
+  reference_type="publication",
+  input=epo_ops.models.Docdb("1000000", "EP", "A1"),
+  endpoint="claims",
 )
 ```
 
@@ -64,12 +89,12 @@ Currently the Client knows how to issue request for the following services:
 | ----------------------------------------------------------------------------- | --------------------- | --------- |
 | `family(reference_type, input, endpoint=None, constituents=None)`             | family                | inpadoc   |
 | `image(path, range=1, extension='tiff')`                                      | published-data/images | images    |
+| `legal(reference_type, input)`                                                | legal                 | other     |
 | `number(reference_type, input, output_format)`                                | number-service        | other     |
 | `published_data(reference_type, input, endpoint='biblio', constituents=None)` | published-data        | retrieval |
 | `published_data_search(cql, range_begin=1, range_end=25, constituents=None)`  | published-data/search | search    |
 | `register(reference_type, input, constituents=['biblio'])`                    | register              | other     |
 | `register_search(cql, range_begin=1, range_end=25)`                           | register/search       | other     |
-| `register_search(cql, range_begin=1, range_end=25)`                           | register/search       | other     |
 
 Bulk operations can be achieved by passing a list of valid models to the
 published_data input field.
@@ -162,8 +187,8 @@ details.
 
 [apache license]: http://www.apache.org/licenses/LICENSE-2.0
 [developer's area]: https://developers.epo.org/ops-v3-2/apis
-[dogpile.cache region]: http://dogpilecache.readthedocs.org/en/latest/api.html#module-dogpile.cache.region
-[dogpile.cache]: https://bitbucket.org/zzzeek/dogpile.cache
+[dogpile.cache region]: https://dogpilecache.sqlalchemy.org/en/latest/api.html#module-dogpile.cache.region
+[dogpile.cache]: https://github.com/sqlalchemy/dogpile.cache
 [epo]: http://epo.org
 [ops guide]: https://link.epo.org/web/ops_v3.2_documentation_-_version_1.3.19_en.pdf
 [ops]: https://www.epo.org/searching-for-patents/data/web-services/ops.html

{python-epo-ops-client-4.1.0 → python_epo_ops_client-4.2.1}/docs/authors.md

@@ -13,12 +13,17 @@ thank you so much. The list is alphabetically sorted.
 
 ## Contributors
 
+- [Alejandro Marti](https://github.com/MartiONE)
 - [Alexander Meinhardt Scheurer](https://github.com/BeneCollyridam)
 - [Daniel Blasco](https://github.com/dablak)
+- [Dan Bolser](https://github.com/CholoTook)
 - [fe60](https://github.com/fe60)
 - [Felipe Eltermann](https://github.com/eltermann)
 - [Geoffrey Cline](https://github.com/geoffcline)
 - [Hiro Kobashi](https://github.com/kobaski)
+- [Matt Keanny](https://github.com/mattkeanny)
 - [Mike Matheson](https://github.com/mmath)
+- [Oliver Fuerst](https://github.com/ofipify)
 - [Roberto Faga](https://github.com/rfaga)
+- [Sebastian Vilstrup](https://github.com/ipr-sv)
 - [Sotiris Fragkiskos](https://github.com/sfranky)

python_epo_ops_client-4.2.1/docs/release.md

@@ -0,0 +1,19 @@
+# Release
+
+Building Python packages and publishing to PyPI is automated
+using the GHA workflow `release-pypi.yml`.
+
+To release the package, exercise those steps:
+
+- Edit `CHANGELOG.md`, designating a new version. Commit the file
+  using a commit message like `Release 4.1.1`.
+
+- Create a tag using the new version, including a `v` prefix, e.g.
+  ```shell
+  git tag v4.1.1
+  ```
+
+- Push to remote.
+  ```shell
+  git push && git push --tags
+  ```