Skip to content

Commit 3444993

Browse files
committed
README: Educate about retrieving the document's description and claims
1 parent e406ad9 commit 3444993

File tree

1 file changed

+32
-7
lines changed

1 file changed

+32
-7
lines changed

README.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,42 @@
77

88
python-epo-ops-client is an [Apache2 licensed][apache license] client library
99
for accessing the [European Patent Office][epo]'s ("EPO") [Open Patent
10-
Services][ops] ("OPS") v.3.2 (based on [v 1.3.16 of the reference guide][ops guide]).
10+
Services][ops] ("OPS") v3.2 (based on [v1.3.16 of the reference guide][ops guide]).
1111

1212
```python
1313
import epo_ops
1414

15-
client = epo_ops.Client(key='abc', secret='xyz') # Instantiate client
16-
response = client.published_data( # Retrieve bibliography data
17-
reference_type = 'publication', # publication, application, priority
18-
input = epo_ops.models.Docdb('1000000', 'EP', 'A1'), # docdb, epodoc
19-
endpoint = 'biblio', # optional, defaults to biblio in case of published_data
20-
constituents = [] # optional, list of constituents
15+
# Instantiate client.
16+
client = epo_ops.Client(key="abc", secret="xyz")
17+
18+
# Retrieve bibliography data.
19+
response = client.published_data(
20+
21+
# publication, application, priority
22+
reference_type="publication",
23+
24+
# docdb, epodoc
25+
input=epo_ops.models.Docdb("1000000", "EP", "A1"),
26+
27+
# optional, defaults to biblio in case of published_data
28+
endpoint="biblio",
29+
30+
# optional, list of constituents
31+
constituents=[],
32+
)
33+
34+
# Retrieve description.
35+
response = client.published_data(
36+
reference_type="publication",
37+
input=epo_ops.models.Docdb("1000000", "EP", "A1"),
38+
endpoint="description",
39+
)
40+
41+
# Retrieve claims.
42+
response = client.published_data(
43+
reference_type="publication",
44+
input=epo_ops.models.Docdb("1000000", "EP", "A1"),
45+
endpoint="claims",
2146
)
2247
```
2348

0 commit comments

Comments
 (0)