Commit cf6654f6 authored by Daniel Eggert's avatar Daniel Eggert
Browse files

updated README.md and setup.py

parent 4ea1246d
## dasf-progress-api
Progress api for dasf modules based on python. Developed and tested with Python 3.8
Progress api for DASF modules based on python. Developed and tested with Python 3.8
### Scope
This library is part of the Data Analytics Software Framework DASF (https://git.geomar.de/digital-earth/dasf),
which was developed by the GFZ Potsdam (https://www.gfz-potsdam.de)
in the Digital Earth project (https://www.digitalearth-hgf.de/).
### Usage
......@@ -48,7 +53,7 @@ All sub-reports are again instances of `ProgressReport`, so you can create more
For now there is now distinct error flag in the report.
But you can update the `step_message` prop before marking it as complete to indicate an error.
```
```python
# some code that raises an exception
# ...
except Exception as e:
......@@ -56,4 +61,3 @@ except Exception as e:
progress_report.step_message = "error '{msg}': {err}".format(msg=progress_report.step_message, err=error)
progress_report.complete()
```
---
from distutils.core import setup
import os
readme_file = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'README.md')
try:
from m2r import parse_from_file
readme = parse_from_file(readme_file)
except ImportError:
# m2r may not be installed in user environment
print('m2r not installed, using fallback README.rst')
with open(os.path.join(os.path.dirname(os.path.abspath(__file__)), 'README.rst')) as f:
readme = f.read()
print(readme)
setup(
name='deprogressapi',
packages=['deprogressapi'],
version='0.1.0',
description='basic back-end progress api for the data analytics software framework dasf',
long_description=readme,
license='Apache-2.0',
author='Daniel Eggert <daniel.eggert@gfz-potsdam.de>, Adam Sasin <sasin@hu-potsdam.de>',
author_email = 'daniel.eggert@gfz-potsdam.de',
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment