make first release ready

.gitattributes

@@ -0,0 +1 @@
+*.whl filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -1,6 +1,7 @@
-dist/**
 *.egg-info
+*.egg*
 build/**
+dist/**
 __pycache__
 .idea
 MANIFEST

README.md

@@ -12,6 +12,8 @@ Instead, users are forced to install the buggy and heavy battery draining _MyMü
 
 So this tool aims to get rid of the app by parsing data from _MyMüll.de_ web service and synchronize the events with a conventional CalDAV server.
 
+##Changelog
+* 1.0.0 - initial version
 
 ## Implementation Status
 - all required functionality implemented for basic usage
@@ -46,6 +48,20 @@ So this tool aims to get rid of the app by parsing data from _MyMüll.de_ web se
 
 ![GUI](./doc/GUI.png)
 
+
+## Setup
+- install and setup latest python3 on your platform.
+- open a shell and check if the command `python --version` works and points the intended version
+- download the latest wheel package in subdirectory _releases/_ on this repository.
+- install it with via following shell command:
+  (the string "x.x.x" need to be replaced with the latest version number)
+  
+  `python -m pip install mymuell2caldav-x.x.x-py3-none-any.whl`
+
+  
+- start the tool via command `mymuell2caldav`
+  - alternatively, you could start with `python -m mymuell2caldav`
+
 ## Disclaimer
 This tool was developed by an annoyed _MyMüll.de_ app user as a free contribution 
 to the open source community and is licenced under the **GPLv3** Licence.

mymuell2caldav/mymuell2caldav.py

@@ -23,7 +23,7 @@ import sys
 from mymuell2caldav.databinding.CalendarSync import CalendarSync
 from mymuell2caldav.databinding.MyMuellDataModel import MyMuellDataModel
 from mymuell2caldav.utils.GuiWorker import GuiWorker
-
+from mymuell2caldav.version import VERSION
 
 class MyMuell2CalDavGui(QMainWindow):
     def __init__(self, parent=None):
@@ -249,7 +249,7 @@ class MyMuell2CalDavGui(QMainWindow):
 
         # self.setGeometry(300, 300, 1000, 800)
         self.setMinimumWidth(500)
-        self.setWindowTitle("MyMuell DAV GUI")
+        self.setWindowTitle("MyMuell 2 CalDAV Version " + VERSION )
 
     def slot_process_finished(self, result: bool, msg: str):
         if result:

mymuell2caldav/version.py

@@ -0,0 +1,3 @@
+# please do not do anything here besides changing version number!
+
+VERSION = '1.0.0'

setup.py

@@ -34,15 +34,22 @@ def generate_long_description_file():
         long_description = f.read()
     return long_description
 
+def get_version():
+    env = dict()
+    with open('mymuell2caldav/version.py', 'r') as f:
+        exec(f.read(), env)
+
+    return env['VERSION']
+
 
 setup(
     name='mymuell2caldav',
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='1.0.0',
+    version=get_version(),
 
-    description='...',
+    description='Tool to sync garbage disposal events from MyMüll.de to standard CalDAV server, e.g. Nextcloud',
     long_description=generate_long_description_file(),
     long_description_content_type='text/markdown',
 
@@ -60,8 +67,9 @@ setup(
     classifiers=[
         'Development Status :: 4 - Beta',
         'Intended Audience :: Developers',
-        'Topic :: Software Development :: Build Tools',
+        'Topic :: Home Automation',
-        'License :: OSI Approved :: MIT License',
+        'Topic :: Office/Business :: Scheduling',
+        'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
@@ -69,7 +77,7 @@ setup(
     ],
 
     # What does your project relate to?
-    keywords=['caldav'],
+    keywords=['caldav', 'mymuell', 'sync', 'garbage disposal'],
 
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().