python-epo-ops-client 4.0.0__tar.gz → 4.2.0__tar.gz

{python-epo-ops-client-4.0.0 → python_epo_ops_client-4.2.0}/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## 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
+- Verify support for Python 3.10, 3.11, and 3.12
+- Project: Use `versioningit` for versioning
+- Tests: Remove dependency on Apiary Mock Server API
+
 ## 4.0.0 (2021-09-19)
 
 - Upgrade dependencies
@@ -17,7 +30,7 @@
 ## 3.1.1 (2019-10-28)
 
 - GET instead of POST for family services, thanks to [amotl][]. See
-  [#33](https://github.com/gsong/python-epo-ops-client/issues/33) for more
+  [#33](https://github.com/ip-tools/python-epo-ops-client/issues/33) for more
   info.
 
 ## 3.1.0 (2019-10-27)

python-epo-ops-client-4.0.0/LICENSE.txt → python_epo_ops_client-4.2.0/LICENSE

@@ -174,28 +174,3 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

{python-epo-ops-client-4.0.0 → python_epo_ops_client-4.2.0}/MANIFEST.in

@@ -1,5 +1,5 @@
 include *.md
-include *.txt
+include LICENSE
 include Makefile
-include __version__.py
 recursive-include epo_ops *.py
+recursive-include docs *.md

{python-epo-ops-client-4.0.0 → python_epo_ops_client-4.2.0}/Makefile

@@ -15,53 +15,54 @@ help: ## Display this help message
 	@echo "Please use \`make <target>' where <target> is one of the following:"
 	@perl -nle'print $& if m{^[\.a-zA-Z_-]+:.*?## .*$$}' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}'
 
-seed-isort-config: ## Update known third party dependencies
-	seed-isort-config --application-directories .:epo_ops --exclude setup.py
-
-pip-compile: ## Update compiled requirement files
-	bin/pip-compile.sh
+install-develop: ## Install project into sandbox.
+	pip install --use-pep517 --prefer-binary --editable=.[develop,docs,test]
 
 clean: clean-build clean-pyc
 
 clean-build:
 	rm -fr build/
 	rm -fr dist/
-	rm -fr *.egg-info
 
 clean-pyc:
 	find . -name '*.pyc' -exec rm -f {} +
 	find . -name '*.pyo' -exec rm -f {} +
 	find . -name '*~' -exec rm -f {} +
 
-lint: ## flake8 lint the project
-	flake8 epo_ops tests
+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 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 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-report term --cov epo_ops tests
+	pytest --lf
 
 test-ci: clean ## Run tests in CI environment with virtualenv Python
-	py.test -v --cov epo_ops --cov-report term-missing
+	pytest
 
-tox: clean ## Run tests with all supported Python versions
-	tox
-
-coverage: clean ## Check code coverage locally
-	py.test -s -v --cov-report html --cov-report term --cov epo_ops tests
+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.0.0 → python_epo_ops_client-4.2.0}/PKG-INFO

@@ -1,13 +1,14 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-epo-ops-client
-Version: 4.0.0
-Summary: Python Client for the European Patent Office's Open Patent Services API
-Home-page: https://github.com/gsong/python-epo-ops-client
+Version: 4.2.0
+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
 Author: George Song
 Author-email: george@monozuku.com
-License: UNKNOWN
-Download-URL: https://github.com/gsong/python-epo-ops-client/archive/v4.0.0.tar.gz
-Platform: UNKNOWN
+Maintainer: Andreas Motl
+Maintainer-email: andreas.motl@ip-tools.org
+Keywords: ops,epo,epo-ops,patent-data,patent-office,patent-data-api,european patent office,open patent services
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
@@ -17,32 +18,89 @@ Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 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.txt
-License-File: AUTHORS.md
+License-File: LICENSE
+Requires-Dist: dogpile.cache<1.5
+Requires-Dist: importlib-metadata; python_version < "3.8"
+Requires-Dist: python-dateutil<2.10
+Requires-Dist: requests<3,>=2.27
+Requires-Dist: six<2
+Provides-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<9; extra == "test"
+Requires-Dist: pytest-cache<2; extra == "test"
+Requires-Dist: pytest-cov<6.3; 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
 
 [![PyPI](https://img.shields.io/pypi/v/python-epo-ops-client)](https://pypi.org/project/python-epo-ops-client/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-epo-ops-client)](https://pypi.org/project/python-epo-ops-client/)
-[![Travis.org](https://img.shields.io/travis/gsong/python-epo-ops-client)](https://travis-ci.org/gsong/python-epo-ops-client)
-[![Coveralls github](https://img.shields.io/coveralls/github/gsong/python-epo-ops-client)](https://coveralls.io/github/gsong/python-epo-ops-client)
+[![GHA](https://github.com/ip-tools/python-epo-ops-client/actions/workflows/main.yml/badge.svg)](https://github.com/ip-tools/python-epo-ops-client/actions/workflows/main.yml)
+[![Codecov](https://codecov.io/gh/ip-tools/python-epo-ops-client/branch/main/graph/badge.svg)](https://codecov.io/gh/ip-tools/python-epo-ops-client)
 
 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",
 )
 ```
 
@@ -89,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.
@@ -187,130 +245,9 @@ 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]: http://documents.epo.org/projects/babylon/eponet.nsf/0/F3ECDCC915C9BCD8C1258060003AA712/$File/ops_v3.2_documentation_-_version_1.3.16_en.pdf
+[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
 [requests.response]: http://requests.readthedocs.org/en/latest/user/advanced/#request-and-response-objects
-
-# Change Log
-
-## 4.0.0 (2021-09-19)
-
-- Upgrade dependencies
-- Drop support for Python 2.7 and Python 3.5
-- Add support for Python 3.9
-
-## 3.1.3 (2020-09-23)
-
-- Upgrade dependencies
-
-## 3.1.2 (2020-07-04)
-
-- Upgrade dependencies
-
-## 3.1.1 (2019-10-28)
-
-- GET instead of POST for family services, thanks to [amotl][]. See
-  [#33](https://github.com/gsong/python-epo-ops-client/issues/33) for more
-  info.
-
-## 3.1.0 (2019-10-27)
-
-- Add support for bulk retrieval, thanks to [mmath][]
-
-## 3.0.0 (2019-10-27)
-
-- Drop support for PyPy, Python 3.4 (probably still works)
-- Add support for Python 3.7, 3.8
-- Invalid and expired tokens are now treated the same, since OPS doesn't
-  distinguish between the two use cases.
-
-## 2.3.2 (2018-01-15)
-
-- Bug fix: Cache 4xx results as well, thanks to [amotl][]
-
-## 2.3.1 (2017-11-10)
-
-- Bug fix: explicitly declare content-type during request
-
-## 2.3.0 (2017-10-22)
-
-- Drop support for Python 2.6
-- Officially support Python 3.6
-- Update to latest dependencies
-- Add image retrieval service, thanks to [rfaga][]
-
-## 2.2.0 (2017-03-30)
-
-- EPO OPS v3.2 compatibility, thanks to [eltermann][]
-
-## 2.1.0 (2016-02-21)
-
-- Add number service, thanks to [eltermann][]
-
-## 2.0.0 (2015-12-11)
-
-- Dropping support for Python 3.3 (although it probably still works).
-- Update to latest dependencies, no new features.
-
-## 1.0.0 (2015-09-20)
-
-- Allow no middleware to be specified
-- Minor tweaks to development infrastructure, no new features.
-- This has been working for a while now, let's call it 1.0!
-
-## 0.1.9 (2015-07-21)
-
-- No new features, just updating third party dependencies
-
-## 0.1.8 (2015-01-24)
-
-- No new features, just updating third party dependencies
-
-## 0.1.7 (2015-01-24)
-
-- Created default Dogpile DBM path if it doesn't exist
-
-## 0.1.6 (2014-12-12)
-
-- Fixed bug with how service URL is constructed
-
-## 0.1.5 (2014-10-17)
-
-- Added support for register retrieval and search
-
-## 0.1.4 (2014-10-10)
-
-- Verified PyPy3 support
-- Updated various dependency pacakges
-
-## 0.1.3 (2014-05-21)
-
-- Python 3.4 compatibility
-- Updated `requests` dependency to 2.3.0
-
-## 0.1.2 (2014-03-04)
-
-- Python 2.6 and 3.3 compatibility
-
-## 0.1.1 (2014-03-01)
-
-- Allow configuration of which HTTP responses (based on status code) to cache
-
-## 0.1.0 (2014-02-20)
-
-- Introduced dogpile.cache for caching http200 resopnses
-- Introduced the concept of middleware
-
-## 0.0.1 (2014-01-21)
-
-- Initial release
-
-[amotl]: https://github.com/amotl
-[eltermann]: https://github.com/eltermann
-[mmath]: https://github.com/mmath
-[rfaga]: https://github.com/rfaga
-
-

{python-epo-ops-client-4.0.0 → python_epo_ops_client-4.2.0}/README.md

@@ -2,22 +2,47 @@
 
 [![PyPI](https://img.shields.io/pypi/v/python-epo-ops-client)](https://pypi.org/project/python-epo-ops-client/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-epo-ops-client)](https://pypi.org/project/python-epo-ops-client/)
-[![Travis.org](https://img.shields.io/travis/gsong/python-epo-ops-client)](https://travis-ci.org/gsong/python-epo-ops-client)
-[![Coveralls github](https://img.shields.io/coveralls/github/gsong/python-epo-ops-client)](https://coveralls.io/github/gsong/python-epo-ops-client)
+[![GHA](https://github.com/ip-tools/python-epo-ops-client/actions/workflows/main.yml/badge.svg)](https://github.com/ip-tools/python-epo-ops-client/actions/workflows/main.yml)
+[![Codecov](https://codecov.io/gh/ip-tools/python-epo-ops-client/branch/main/graph/badge.svg)](https://codecov.io/gh/ip-tools/python-epo-ops-client)
 
 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,9 +187,9 @@ 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]: http://documents.epo.org/projects/babylon/eponet.nsf/0/F3ECDCC915C9BCD8C1258060003AA712/$File/ops_v3.2_documentation_-_version_1.3.16_en.pdf
+[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
 [requests.response]: http://requests.readthedocs.org/en/latest/user/advanced/#request-and-response-objects

python-epo-ops-client-4.0.0/AUTHORS.md → python_epo_ops_client-4.2.0/docs/authors.md

@@ -1,14 +1,23 @@
-# Credits
+# Authors
 
-## Development Lead
+The following people contributed to the software in one way or another,
+thank you so much. The list is alphabetically sorted.
+
+## Development Leads
 
 - [George Song](https://github.com/gsong)
 
-## Contributors
+## Maintainers
 
 - [Andreas Motl](https://github.com/amotl)
+
+## Contributors
+
+- [Alexander Meinhardt Scheurer](https://github.com/BeneCollyridam)
 - [Daniel Blasco](https://github.com/dablak)
+- [fe60](https://github.com/fe60)
 - [Felipe Eltermann](https://github.com/eltermann)
+- [Geoffrey Cline](https://github.com/geoffcline)
 - [Hiro Kobashi](https://github.com/kobaski)
 - [Mike Matheson](https://github.com/mmath)
 - [Roberto Faga](https://github.com/rfaga)

python_epo_ops_client-4.2.0/docs/backlog.md

@@ -0,0 +1,35 @@
+# Backlog
+
+
+## Iteration +1
+
+- Improve and clean up README
+- Set up project documentation on Read the Docs
+- Switch to `pyproject.toml`
+
+
+## Iteration +2
+
+This is the content of the original `TODOS.md` file.
+
+- Feature: Should the non-standard oAuth be coded as a requests plug-in?
+- Dogpile caching
+  - Generate the key based on a SortedDict of some kind to make sure the exact
+    same request with different argument order are still a hit
+- Additional services
+  - Legal service
+- Makefile: Comma in `echo` statements?
+
+
+## Done
+
+- Use new organization name `ip-tools`
+- CI: Add GHA recipe, dissolve Travis configuration
+- Dissolve `requirements` files, and inline them into `setup.py`
+- Add support for Python 3.10 and 3.11
+- Use `ruff` linter, dissolve `flake8` and `isort`
+- Use `versioningit` for versioning, dissolve `bumpversion`
+- Replace Apiary Mock server
+  https://github.com/ip-tools/python-epo-ops-client/issues/65
+- Testing: Replace Apiary tests with monkeypatch? Or
+  <https://pypi.python.org/pypi/pytest-localserver>.

python_epo_ops_client-4.2.0/docs/contributing.md

@@ -0,0 +1,87 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated. Every bit
+helps, and credit will always be given. You can contribute in many ways.
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at <https://github.com/ip-tools/python-epo-ops-client/issues>.
+
+If you are reporting a bug, please include:
+
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting.
+- Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" is open to
+whoever wants to fix it.
+
+### Implement Features
+
+We are tracking all sorts of tasks within the [backlog](backlog.md) file and
+as issues on GitHub. Just pick one, submit a corresponding patch, or start
+a discussion around it. Anything tagged with "feature" is open to whoever wants
+to implement it.
+
+### Write Documentation
+
+python-epo-ops-client could always use more documentation, whether as part of
+the official python-epo-ops-client docs, in docstrings, or even on the web in
+blog posts, articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at
+https://github.com/ip-tools/python-epo-ops-client/issues.
+
+If you are proposing a feature:
+
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+- Remember that this is a volunteer-driven project, and that contributions are
+  welcome. 😊
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `python-epo-ops-client` for local
+development. Before going into the forking process, you should first [install
+a development sandbox](sandbox.md).
+
+1.  Fork the `python-epo-ops-client` repository on GitHub and clone your fork.
+    ```shell
+    git clone git@github.com:[your_name_here]/python-epo-ops-client.git
+    cd python-epo-ops-client/
+    ```
+
+4.  Create a branch for local development:
+    ```shell
+    git switch -c <branchname>
+    ```
+    Now, make your changes within your working tree.
+
+5.  After making changes to the code base, you may want to check that your
+    changes pass test and linting procedures. For that purpose, run
+    `make check`.
+
+6.  Commit your changes and push your branch to GitHub.
+
+    ```shell
+    git add .
+    git commit -m "A detailed description of your changes."
+    git push origin <branchname>
+    ```
+
+7.  Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1.  The pull request should include tests.
+2.  If the pull request adds functionality, the docs should be updated. Put your
+    new functionality into a function with a docstring, and add the feature to
+    the list in README.md.

python_epo_ops_client-4.2.0/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 --follow-tags
+  ```