Skip to content

Commit 5740846

Browse files
committed
Add basic info about python api to the readme
1 parent 6e3b23e commit 5740846

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ To install the module:
1212
[![Coverage Status](https://img.shields.io/coveralls/lutraconsulting/mergin-py-client.svg)](https://coveralls.io/github/lutraconsulting/mergin-py-client)
1313

1414

15+
## Using Python API
16+
17+
To use Mergin from Python, it is only needed to create `MerginClient` object and then use it:
18+
19+
```python
20+
import mergin
21+
22+
client = mergin.MerginClient(login='john', password='topsecret')
23+
client.download_project('lutraconsulting/Basic survey', '/tmp/basic-survey')
24+
```
25+
26+
1527
## Command-line Tool
1628

1729
When the module is installed, it comes with `mergin` command line tool.

0 commit comments

Comments
 (0)