This commit is contained in:
50
README.md
50
README.md
@@ -6,7 +6,8 @@ lmwsip is a python library for the lmw sip protocol.
|
|||||||
## Package
|
## Package
|
||||||
|
|
||||||
The lmwsip package contains the class LmwSip to connect to the
|
The lmwsip package contains the class LmwSip to connect to the
|
||||||
LMW meetnet using de SIP protocol. The library contains documentation
|
[LMW](https://waterberichtgeving.rws.nl/water-en-weer/metingen/lmw-info)
|
||||||
|
meetnet using de SIP protocol. The library contains documentation
|
||||||
how to use it.
|
how to use it.
|
||||||
|
|
||||||
## Installing
|
## Installing
|
||||||
@@ -16,35 +17,18 @@ At the moment the package is hosted at https://marceln.org/download/python.
|
|||||||
|
|
||||||
You can install the package with pip:
|
You can install the package with pip:
|
||||||
```
|
```
|
||||||
pip install -i https://marceln.org/download/python lmwsip
|
pip install --extra-index-url https://marceln.org/download/python lmwsip
|
||||||
```
|
```
|
||||||
|
|
||||||
## Tools
|
|
||||||
### lmwsip-test
|
|
||||||
|
|
||||||
A small test program containing some functions to test the library.
|
|
||||||
|
|
||||||
### siprun
|
|
||||||
|
|
||||||
A prgram to run SIP command files.
|
|
||||||
See "siprun -H" for usage information.
|
|
||||||
|
|
||||||
#### hoek-h10.sip
|
|
||||||
|
|
||||||
A sample sip command file to request the waterlevel at hoek van holland
|
|
||||||
from the last hour
|
|
||||||
|
|
||||||
## Username password
|
|
||||||
|
|
||||||
All files contain "USER", "PASS".
|
|
||||||
These values should be replaced by real credentials.
|
|
||||||
Otherwise the connection fails.
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
### Library
|
### Username password
|
||||||
|
|
||||||
#### Use send (low level)
|
All examples contain "USER", "PASS".
|
||||||
|
These values should be replaced by real credentials.
|
||||||
|
Otherwise the connection fails.
|
||||||
|
|
||||||
|
### Use send (low level)
|
||||||
|
|
||||||
``` python
|
``` python
|
||||||
from lmwsip import LmwSip
|
from lmwsip import LmwSip
|
||||||
@@ -94,12 +78,16 @@ $ python -m lmwsip.run /tmp/hoek-h10.sip
|
|||||||
< [! ]
|
< [! ]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Git pre commit hook
|
## Unit tests
|
||||||
|
|
||||||
Er is een git pre-commit hook aanwezig in "githooks". Deze moet geactiveerd
|
The code containts a python unittest.
|
||||||
worden door hem te symlinken naar .git/hooks.
|
|
||||||
|
|
||||||
Deze git hook verzorgt een versie nummer en een syntax check voor commit.
|
This code runs a dummy sip server and runs a number of test against the dummy
|
||||||
|
server.
|
||||||
|
|
||||||
Het versie nummer komt uit de setup.py en word in de module geplaats als
|
## Git pre commit hook
|
||||||
`__version__`.
|
|
||||||
|
There is a pre-commit `githooks/pre-commit' with two functions:
|
||||||
|
* Updating the `__version__` in the module from setup.py
|
||||||
|
* Running the unit test code.
|
||||||
|
* Running a syntaxt test.
|
||||||
|
2
setup.py
2
setup.py
@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
|
|||||||
|
|
||||||
setuptools.setup(
|
setuptools.setup(
|
||||||
name="lmwsip", # Replace with your own username
|
name="lmwsip", # Replace with your own username
|
||||||
version="0.1.5",
|
version="0.1.6",
|
||||||
author="Marcel Nijenhof",
|
author="Marcel Nijenhof",
|
||||||
author_email="pip@pion.xs4all.nl",
|
author_email="pip@pion.xs4all.nl",
|
||||||
description="Interface for the lmw sip protocol",
|
description="Interface for the lmw sip protocol",
|
||||||
|
Reference in New Issue
Block a user