summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <mail2xengineering@protonmail.com>2021-06-10 14:23:31 +0200
committerxengineering <mail2xengineering@protonmail.com>2021-06-10 14:23:31 +0200
commitace35c20c96ca737886328e4a035308ac1da44c1 (patch)
treeef0b1d0f35600180f0787bca4d10e629c1994882
parent706714072a2c00fbd8de865c63bf86c80f2e97f0 (diff)
downloadbirdscan-ace35c20c96ca737886328e4a035308ac1da44c1.tar
birdscan-ace35c20c96ca737886328e4a035308ac1da44c1.tar.zst
birdscan-ace35c20c96ca737886328e4a035308ac1da44c1.zip
Update Python Code and Documentation
-rw-r--r--python/birdscan/__init__.py8
-rw-r--r--python/birdscan/__main__.py18
2 files changed, 23 insertions, 3 deletions
diff --git a/python/birdscan/__init__.py b/python/birdscan/__init__.py
index e69de29..fe911a9 100644
--- a/python/birdscan/__init__.py
+++ b/python/birdscan/__init__.py
@@ -0,0 +1,8 @@
+
+
+"""birdscan
+
+This package is part of the birdscan software (https://xengineering.eu).
+The birdscan python package contains all the necessary code for its main
+module which is responsible for image capturing and live processing.
+"""
diff --git a/python/birdscan/__main__.py b/python/birdscan/__main__.py
index 34eb665..a25dee2 100644
--- a/python/birdscan/__main__.py
+++ b/python/birdscan/__main__.py
@@ -2,10 +2,22 @@
# vim: shiftwidth=4 tabstop=4 expandtab
+"""__main__.py
+
+This is the main executable of the birdscan package.
+"""
+
+
import time
-while True:
- print("Active!")
- time.sleep(2)
+def main():
+ """Main function of this module"""
+
+ while True:
+ print("Active!")
+ time.sleep(1)
+
+if __name__ == "__main__":
+ main()