Skip to content

Commit f0d378c

Browse files
committed
Update README and fix license in setup.py
1 parent 55f938c commit f0d378c

File tree

2 files changed

+45
-24
lines changed

2 files changed

+45
-24
lines changed

README.md

Lines changed: 44 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,9 @@
33
This repository contains a Python client module for access to [Mergin](https://public.cloudmergin.com/)
44
service and a command-line tool for easy access to data stored in Mergin.
55

6-
## Development
7-
Python 3.6+ required. Create `mergin/deps` folder where [geodiff](https://github.com/lutraconsulting/geodiff) lib is supposed to be and install dependencies:
8-
9-
rm -r mergin/deps
10-
mkdir mergin/deps
11-
pipenv install --dev --three
12-
pipenv run pip install -r <(pipenv lock -r | grep pygeodiff) --target mergin/deps
13-
14-
For using mergin client with its dependencies packaged locally run:
15-
16-
pip install wheel
17-
python3 setup.py sdist bdist_wheel
18-
mkdir -p mergin/deps
19-
pip wheel -r mergin_client.egg-info/requires.txt -w mergin/deps
20-
unzip mergin/deps/pygeodiff-*.whl -d mergin/deps
21-
22-
## Tests
23-
For running test do:
6+
To install the module:
247

25-
cd mergin
26-
export TEST_MERGIN_URL=<url> # testing server
27-
export TEST_API_USERNAME=<username>
28-
export TEST_API_PASSWORD=<pwd>
29-
pipenv run pytest --cov-report html --cov=mergin test/
8+
pip3 install mergin-client
309

3110

3211
## Command-line Tool
@@ -82,3 +61,45 @@ working directory:
8261
```
8362
$ mergin push
8463
```
64+
65+
66+
## Development
67+
68+
### How to release
69+
70+
1. Update version in `setup.py`
71+
2. Tag git repository with the new version
72+
3. Create package and upload it
73+
74+
```
75+
python3 setup.py sdist
76+
python3 -m twine upload dist/mergin-client-x.y.z.tar.gz
77+
```
78+
79+
### Installing deps
80+
81+
[this section needs revising - now using pip for dependencies]
82+
83+
Python 3.6+ required. Create `mergin/deps` folder where [geodiff](https://github.com/lutraconsulting/geodiff) lib is supposed to be and install dependencies:
84+
85+
rm -r mergin/deps
86+
mkdir mergin/deps
87+
pipenv install --dev --three
88+
pipenv run pip install -r <(pipenv lock -r | grep pygeodiff) --target mergin/deps
89+
90+
For using mergin client with its dependencies packaged locally run:
91+
92+
pip install wheel
93+
python3 setup.py sdist bdist_wheel
94+
mkdir -p mergin/deps
95+
pip wheel -r mergin_client.egg-info/requires.txt -w mergin/deps
96+
unzip mergin/deps/pygeodiff-*.whl -d mergin/deps
97+
98+
### Tests
99+
For running test do:
100+
101+
cd mergin
102+
export TEST_MERGIN_URL=<url> # testing server
103+
export TEST_API_USERNAME=<username>
104+
export TEST_API_PASSWORD=<pwd>
105+
pipenv run pytest --cov-report html --cov=mergin test/

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
classifiers=[
3333
'Development Status :: 5 - Production/Stable',
3434
'Intended Audience :: Developers',
35-
'License :: MIT License',
35+
'License :: OSI Approved :: MIT License',
3636
'Operating System :: OS Independent',
3737
'Programming Language :: Python :: 3'
3838
],

0 commit comments

Comments
 (0)