Update README
Some checks failed
continuous-integration/drone/push Build is failing

This commit is contained in:
Marcel Nijenhof
2021-08-06 19:11:47 +02:00
parent 948d3a4032
commit b94dbd9ed3
3 changed files with 15 additions and 17 deletions

View File

@@ -9,14 +9,14 @@ gebruikt voor het opvragen van:
* Verwachtingen
* Astronomisch getij
De digitale delta api is beschikbaar via:
De operationele digitale delta api is beschikbaar via:
* https://ddapi.rws.nl/dd-oper/2.0
De authenticatie op deze url is geregeld via PKI overheidscertificaten.
Zonder PKI overheidscertificaat is de api niet toegankelijk.
Deze git repository bevat een python module om de dd-oper api te benaderen
Deze git repository bevat een python module om de dd oper api te benaderen
inclusief:
* Autenticatie via certificaten.
@@ -29,29 +29,27 @@ De package is beschikbaar via https://marceln.org/download/python
Het installeren gaat via:
```
pip install -i https://marceln.org/download/python ddOperApi
pip install --extra-index-url https://marceln.org/download/python ddOperApi
```
## De inhoud van de git repository
TODO: Aanpassen aan module
* ddOperApi/: De module
* ddOperApi/tests: De module test code
* githooks: Standaard hooks voor een locale zelf test
* demo/DD-API-Oper demo.ipynb: [Jupyter notebook](https://jupyter.org/)
demo file
* ddapioper.py: Python module
* test-ddapi: Een klein voorbeeld en test programma voor de module
* DD-API-Oper demo.ipynb: Een [Jupyter notebook](met een demo).
### dd-oper-api
### ddOperApi
Deze module bevat documentatie. Deze is op te vragen door de module te
laden en vervolgens via de python hulp functie heb je toegang tot de
documentatie.
### test-ddapi
### ddOperApi/tests
Een werkend voorbeeld en test programma voor de api.
Wel moeten de paden van het certificaat en de bijbehorende private key
nog ingevuld worden. Er staat twee keer "<TODO>" in de code.
Bevat een flask webserver waartegen de module getest kan worden en
python unittest code.
### DD-API-Oper demo.ipynb
@@ -85,4 +83,4 @@ stabiele code!
## Vragen en/of uitbreidingen.
Vragen en of uitbreidingen kunnen gemaild worden naar ddoperapi@pion.xs4all.nl.
Vragen en of uitbreidingen kunnen gemaild worden naar ddoperapi(a)marceln(.)org.

View File

@@ -20,7 +20,7 @@ from datetime import datetime, timedelta
from dateutil.parser import parse
""" Version info changed by git hook """
__version__ = '0.1.0'
__version__ = '0.1.1'
class ddOperApi:
"""

View File

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
setuptools.setup(
name="ddOperApi", # Replace with your own username
version="0.1.0",
version="0.1.1",
author="Marcel Nijenhof",
author_email="pip@pion.xs4all.nl",
description="Interface for dd-oper protocol",