Skip to content

Commit 0852b44

Browse files
Update setup.py, add versioning in readme
1 parent f261042 commit 0852b44

File tree

3 files changed

+28
-19
lines changed

3 files changed

+28
-19
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,7 @@
44
/.eggs
55
__pycache__
66
cli.py
7-
.vscode/
7+
.vscode/
8+
9+
.DS_Store
10+
._.DS_Store

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,11 @@
11
# medmij-python
22

3-
## Installation
4-
5-
First start and activate a virtualenv:
6-
7-
```shell
8-
$ python3.7 -m venv env
9-
$ . env/bin/activate
10-
(env) $
11-
```
3+
Python implementation of de MedMij ZAL, OCL, Whitelist and GNL
124

13-
Clone the repo and install:
5+
## Installation
146

157
```shell
16-
(env) $ PATH_TO_CLONE=~/example/medmij-python
17-
(env) $ git clone https://github.com/GidsOpenStandaarden/OpenPGO-Medmij-ImplementatieBouwstenen-Python.git $PATH_TO_CLONE
18-
...
19-
(env) $ cd $PATH_TO_CLONE
20-
(env) $ python setup.py install
21-
...
8+
$ pip install medmij-lists
229
```
2310

2411
## Usage
@@ -122,3 +109,14 @@ Run `gnl.py`:
122109
(env) $ python gnl.py
123110
Basisgegevens Zorg
124111
```
112+
113+
## Version Guidance
114+
115+
This library follows [Semantic Versioning](https://semver.org/).
116+
The versions of the Afspraken set are mapped to the versions of the library as follows:
117+
118+
| Version Afsprakenset | Status | Version library |
119+
|----------------------------|------------|-----------------|
120+
| [Afsprakenset release 1.1] | Latest | 0.1.* |
121+
122+
[Afsprakenset release 1.1]: https://afsprakenstelsel.medmij.nl/display/PUBLIC/Afsprakenset+release+1.1

setup.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
11
from setuptools import setup
22

3+
with open("README.md", "r") as fh:
4+
long_description = fh.read()
5+
36
setup(
4-
name='medmij',
7+
name='medmij-lists',
58
install_requires=['lxml'],
69
packages=['medmij'],
710
zip_safe=True,
11+
url='https://github.com/GidsOpenStandaarden/OpenPGO-Medmij-ImplementatieBouwstenen-Python',
812
setup_requires=['nose'],
913
test_suite='nose.collector',
14+
description='Python implementation of de MedMij ZAL, OCL, Whitelist and GNL',
15+
long_description=long_description,
16+
long_description_content_type="text/markdown",
1017
tests_require=['nose'],
1118
python_require=">=3.7",
12-
package_data={'medmij': ['*.xsd']}
19+
package_data={'medmij': ['*.xsd']},
20+
version='0.1.0'
1321
)

0 commit comments

Comments
 (0)