Skip to content

Commit b44c612

Browse files
committed
Point to schema on Tranco site
1 parent 47a5efc commit b44c612

File tree

1 file changed

+2
-14
lines changed

1 file changed

+2
-14
lines changed

tranco/tranco.py

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -109,20 +109,8 @@ def configure(self, configuration):
109109
"""
110110
Configure a custom list (https://tranco-list.eu/configure).
111111
Requires that valid credentials were passed when creating the `Tranco` object.
112-
:param configuration: dictionary that conforms to the following schema
113-
(https://tranco-list.eu/api_documentation#datatypes-configuration):
114-
```
115-
{
116-
"providers": [
117-
String("alexa"|"majestic"|"umbrella")
118-
],
119-
"startDate": Date(YYYY-mm-dd),
120-
"endDate": Date(YYYY-mm-dd),
121-
"combinationMethod": String("dowdall"|"borda"),
122-
"listPrefix": Integer|"full", # Only aggregate domains from the list prefixes of length
123-
"filterPLD": "on"|"off" # Whether to retain only pay-level domains
124-
}
125-
```
112+
:param configuration: dictionary that conforms to the schema at
113+
https://tranco-list.eu/api_documentation#datatypes-configuration
126114
:return Tuple[bool, str]: whether the list is already available; the ID (to be) assigned to this list.
127115
Use `list_metadata` with this ID to (continuously) check whether the list has finished generating
128116
and is now available.

0 commit comments

Comments
 (0)