pytodo-qt 0.2.4__tar.gz → 0.2.6__tar.gz

pytodo-qt-0.2.6/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: pytodo-qt
+Version: 0.2.6
+Summary: A small cross-platform to-do application written in Python 3 and PyQt6
+Author-email: Michael Berry <trismegustis@gmail.com>
+License: GPLv3
+Project-URL: Homepage, https://github.com/berrym/pytodo-qt
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: COPYING
+Requires-Dist: PyQt6
+Requires-Dist: pycryptodomex
+
+# pytodo-qt
+
+A simple to-do list program.
+
+## Description
+
+A small cross-platform application to manage multiple to-do lists written in Python 3 and PyQt6
+
+## Getting started
+
+- Install a recent version of Python, needs **at least** version *3.8*
+- For a package install you will need `pip` or `pipx`
+- For a manual install you will need `git` and the python modules `setuptools`, `wheel`, `build` and `PyQt6`
+  You can install these via your package manager or via `pip`
+
+## Installation
+
+- Install a package. **Recommended**.
+
+It can be installed from PyPi via pip or preferably pipx, all three of these methods should work
+
+    $ pipx install pytodo-qt       # for a local virtualenv install
+    $ pip install pytodo-qt        # for a systemwide install
+    $ pip install --user pytodo-qt # for a user local install
+
+- Manual install
+
+It can be installed by cloning the git repository and building the package:
+
+    $ git clone https://github.com/berrym/pytodo-qt.git
+    $ cd pytodo-qt
+    $ python3 -m venv /path/to/pytodo-qt/venv
+    $ sh /path/to/pytodo-qt/venv/bin/activate  # for linux/unix, activate the appropriate script for your os
+    $ python3 -m build
+    $ /path/to/pytodo-qt/venv/bin/pip install .
+
+### Executing program
+
+If you installed a package then a script named `todo` was installed
+
+    $ todo  # launches the application
+
+If you followed the manual local build instructions
+
+    $ /path/to/pytodo-qt/venv/bin/todo  # launches the application
+
+## Help
+
+    $ todo --help
+
+## Copyright
+
+Copyright 2024 Michael Berry <trismegustis@gmail.com>
+
+## Latest release
+
+- v0.2.5
+
+## License
+
+This project is licensed under the GNU General Public License version 3, or at your option any later version.
+See the COPYING file included in the git repository.
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

pytodo-qt-0.2.6/README.md

@@ -0,0 +1,65 @@
+# pytodo-qt
+
+A simple to-do list program.
+
+## Description
+
+A small cross-platform application to manage multiple to-do lists written in Python 3 and PyQt6
+
+## Getting started
+
+- Install a recent version of Python, needs **at least** version *3.8*
+- For a package install you will need `pip` or `pipx`
+- For a manual install you will need `git` and the python modules `setuptools`, `wheel`, `build` and `PyQt6`
+  You can install these via your package manager or via `pip`
+
+## Installation
+
+- Install a package. **Recommended**.
+
+It can be installed from PyPi via pip or preferably pipx, all three of these methods should work
+
+    $ pipx install pytodo-qt       # for a local virtualenv install
+    $ pip install pytodo-qt        # for a systemwide install
+    $ pip install --user pytodo-qt # for a user local install
+
+- Manual install
+
+It can be installed by cloning the git repository and building the package:
+
+    $ git clone https://github.com/berrym/pytodo-qt.git
+    $ cd pytodo-qt
+    $ python3 -m venv /path/to/pytodo-qt/venv
+    $ sh /path/to/pytodo-qt/venv/bin/activate  # for linux/unix, activate the appropriate script for your os
+    $ python3 -m build
+    $ /path/to/pytodo-qt/venv/bin/pip install .
+
+### Executing program
+
+If you installed a package then a script named `todo` was installed
+
+    $ todo  # launches the application
+
+If you followed the manual local build instructions
+
+    $ /path/to/pytodo-qt/venv/bin/todo  # launches the application
+
+## Help
+
+    $ todo --help
+
+## Copyright
+
+Copyright 2024 Michael Berry <trismegustis@gmail.com>
+
+## Latest release
+
+- v0.2.5
+
+## License
+
+This project is licensed under the GNU General Public License version 3, or at your option any later version.
+See the COPYING file included in the git repository.
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

{pytodo-qt-0.2.4 → pytodo-qt-0.2.6}/pyproject.toml

@@ -6,13 +6,13 @@ build-backend = "setuptools.build_meta"
 where = ["src"]
 
 [tool.setuptools.package-data]
-todo = ["*.png"]
-"todo.gui.icons" = ["*.png"]
+pytodo_qt = ["*.png"]
+"pytodo_qt.gui.icons" = ["*.png"]
 
 [project]
 name = "pytodo-qt"
-version = "0.2.4"
-description = "A simple To-Do list app written in PyQt6"
+version = "0.2.6"
+description = "A small cross-platform to-do application written in Python 3 and PyQt6"
 readme = "README.md"
 authors = [
     {name = "Michael Berry", email = "trismegustis@gmail.com"},
@@ -30,7 +30,7 @@ license = {text = "GPLv3"}
 requires-python = ">=3.8"
 
 [project.urls]
-Homepage = "https://github.com/berrym/todo"
+Homepage = "https://github.com/berrym/pytodo-qt"
 
 [project.scripts]
-todo = "todo.__main__:main"
+pytodo-qt = "pytodo_qt.__main__:main"

{pytodo-qt-0.2.4/src/todo → pytodo-qt-0.2.6/src/pytodo_qt}/__main__.py

@@ -1,5 +1,7 @@
 """__main__.py
 
+pytodo-qt
+
 A to-do list program written in Python using PyQt6
 
 Copyright (C) 2024 Michael Berry <trismegustis@gmail.com>
@@ -39,18 +41,18 @@ def main():
     for i in range(0, len(sys.path)):
         if sys.path[i].__contains__("site-packages"):
             location = sys.path[i]
-            location += "/todo"
+            location += "/pytodo_qt"
             os.chdir(location)
             break
 
     if location == "":
         logger.log.exception("Unknown installation or invocation, exiting")
-        sys.exit(0)
+        sys.exit(1)
 
     # create a command line arg_parser
     arg_parser = argparse.ArgumentParser(
-        prog="To-Do",
-        description="To-Do List Application written in Python with Qt6",
+        prog="pytodo-qt",
+        description="To-Do List Application written in Python 3 and PyQt6",
         epilog="Copyright Michael Berry 2024",
     )
 
@@ -73,7 +75,7 @@ def main():
         action="store",
         type=str,
         choices=["yes", "no"],
-        help="allow remote users to grab your lists",
+        help="allow remote users to copy your lists",
     )
 
     server_group.add_argument(
@@ -86,14 +88,14 @@ def main():
     )
 
     server_group.add_argument(
-        "-i", "--ip", type=str, help="set the servers ip addresses."
+        "-i", "--ip", type=str, help="set the database server's IP address."
     )
 
     server_group.add_argument(
         "-p",
         "--port",
         type=int,
-        help="specify which port the network server will bind to",
+        help="specify which port the database server will bind to",
     )
 
     arg_parser.add_argument(

{pytodo-qt-0.2.4/src/todo → pytodo-qt-0.2.6/src/pytodo_qt}/core/Logger.py

@@ -4,18 +4,32 @@ A Generic logging class.
 """
 
 import logging
-import os
 import sys
 
+from pathlib import Path
 
-home_dir = os.getenv("HOME")
+home_dir = Path.home()
 if home_dir is not None:
-    todo_dir = os.path.join(home_dir, ".todo")
+    app_dir = Path.joinpath(home_dir, ".pytodo-qt")
 else:
-    print("Error: unable to write log file, exiting")
+    print("Error: unable to get home directory, exiting")
     sys.exit(1)
 
-log_fn = os.path.join(todo_dir, "todo.log")
+if not Path.exists(app_dir):
+    try:
+        Path.mkdir(app_dir)
+    except OSError as e:
+        print(f"Error: failed to create pytodo-qt directory {app_dir}: {e}")
+        sys.exit(1)
+
+log_fn = Path.joinpath(app_dir, "pytodo-qt.log")
+
+if not Path.exists(log_fn):
+    try:
+        log_fn.touch()
+    except OSError as e:
+        print(f"Error: failed to create pytodo-qt log file {log_fn}: {e}")
+        sys.exit(1)
 
 
 class Logger:

{pytodo-qt-0.2.4/src/todo → pytodo-qt-0.2.6/src/pytodo_qt}/core/TodoDatabase.py

@@ -4,10 +4,11 @@ This module implements the to-do database.
 """
 
 import configparser
-import os
 import sys
 import threading
 
+from pathlib import Path
+
 from PyQt6.QtCore import QObject
 
 from ..core import settings
@@ -39,7 +40,7 @@ class TodoDatabase(QObject):
 
         # create an ini config parser
         self.config = configparser.ConfigParser()
-        if not os.path.exists(settings.ini_fn):
+        if not Path.exists(settings.ini_fn):
             self.write_default_config()
         self.parse_config()
 
@@ -65,7 +66,7 @@ class TodoDatabase(QObject):
         self.config["server"] = {}
         self.config["server"]["key"] = "BewareTheBlackGuardian"
         self.config["server"]["run"] = "yes"
-        self.config["server"]["address"] = "127.0.0.1"
+        self.config["server"]["address"] = "0.0.0.0"
         self.config["server"]["port"] = "5364"
         self.config["server"]["pull"] = "yes"
         self.config["server"]["push"] = "yes"
@@ -86,6 +87,7 @@ class TodoDatabase(QObject):
             self.config["database"]["reverse_sort"] = "yes"
         else:
             self.config["database"]["reverse_sort"] = "no"
+        self.config["server"]["key"] = settings.options["key"]
         if settings.options["run"]:
             self.config["server"]["run"] = "yes"
         else:
@@ -155,14 +157,14 @@ class TodoDatabase(QObject):
         if fn is None:
             return
 
-        logger.log.info("Writing todo list to file %s", fn)
+        logger.log.info("Writing pytodo-qt list to file %s", fn)
         try:
             with open(fn, "w", encoding="utf-8") as f:
                 f.write(f"{self.active_list:*^60}\n\n")
                 for todo in self.todo_lists[self.active_list]:
                     f.write(f'{todo["reminder"]}\n')
         except IOError as e:
-            logger.log.exception("Unable to write todo list to %s: %s", fn, e)
+            logger.log.exception("Unable to write pytodo-qt list to %s: %s", fn, e)
 
     def server_running(self):
         """Determine if the server is running"""

{pytodo-qt-0.2.4/src/todo → pytodo-qt-0.2.6/src/pytodo_qt}/core/__init__.py

@@ -1,6 +1,6 @@
 """__init__.py
 
-todo.core: A decorator to make security checks on the to-do database.
+pytodo-qt.core: A decorator to make security checks on the to-do database.
 """
 
 import sys

{pytodo-qt-0.2.4/src/todo → pytodo-qt-0.2.6/src/pytodo_qt}/core/json_helpers.py

@@ -1,7 +1,8 @@
 import json
-import os
 import sys
 
+from pathlib import Path
+
 from ..core import error_on_none_db, settings
 from ..core.Logger import Logger
 
@@ -21,9 +22,9 @@ def merge_todo_lists(*todo_lists):
 
 
 @error_on_none_db
-def read_json_data(fn=settings.lists_fn):
+def read_json_data(fn=settings.db_fn):
     """Read in to-do lists from a JSON file."""
-    if not os.path.exists(fn):
+    if not Path.exists(fn):
         msg = f"JSON file {fn} does not exist"
         logger.log.warning(msg)
         return False, msg
@@ -69,7 +70,7 @@ def read_json_data(fn=settings.lists_fn):
 
 
 @error_on_none_db
-def write_json_data(fn=settings.lists_fn):
+def write_json_data(fn=settings.db_fn):
     """Write to-do lists as a JSON file."""
     logger.log.info("Writing JSON file %s", fn)
     try:

pytodo-qt-0.2.6/src/pytodo_qt/core/settings.py

@@ -0,0 +1,37 @@
+"""settings.py
+
+This module creates To-Do core global variables and functions.
+"""
+
+import sys
+
+from pathlib import Path
+
+from ..core.Logger import Logger
+
+
+logger = Logger(__name__)
+
+
+__version__ = "0.2.6"
+options = {}
+DB = None
+
+home_dir = Path.home()
+if home_dir is not None:
+    app_dir = Path.joinpath(home_dir, ".pytodo-qt")
+else:
+    logger.log.exception("Unable to get home directory, exiting")
+    sys.exit(1)
+
+if not Path.exists(app_dir):
+    try:
+        Path.mkdir(app_dir)
+    except OSError as e:
+        logger.log.exception("Error creating pytodo-qt configuration directory: %s", e)
+        sys.exit(1)
+
+
+# private files
+ini_fn = Path.joinpath(app_dir, "pytodo-qt.ini")
+db_fn = Path.joinpath(app_dir, "pytodo-qt-db.json")

{pytodo-qt-0.2.4/src/todo → pytodo-qt-0.2.6/src/pytodo_qt}/gui/MainWindow.py

@@ -3,7 +3,6 @@
 This module implements the GUI for To-Do.
 """
 
-import os
 import sys
 
 from pathlib import Path
@@ -28,6 +27,7 @@ from PyQt6.QtPrintSupport import QPrinter, QPrintDialog
 
 from ..core import error_on_none_db, settings, json_helpers
 from ..core.Logger import Logger
+from ..crypto.AESCipher import AESCipher
 from ..gui.AddTodoDialog import AddTodoDialog
 from ..gui.SyncDialog import SyncDialog
 from ..net.sync_operations import sync_operations
@@ -49,7 +49,7 @@ class MainWindow(QMainWindow):
 
         # create the window, set title and tooltip, resize and center window
         super().__init__()
-        self.setWindowIcon(QIcon("gui/icons/todo.png"))
+        self.setWindowIcon(QIcon("gui/icons/pytodo-qt.png"))
         self.setWindowTitle("To-Do")
         self.setToolTip("Python3 + Qt5 = Happy <u>To-Do</u> Programmer!")
         QToolTip.setFont(QFont("Helvetica", 10))
@@ -68,7 +68,7 @@ class MainWindow(QMainWindow):
         # create some actions
         printer = QAction(QIcon(), "Print", self)
         printer.setShortcut("Ctrl+P")
-        printer.triggered.connect(self.printlist)
+        printer.triggered.connect(self.print_list)
 
         _quit = QAction(QIcon(), "Exit", self)
         _quit.setShortcut("Ctrl+Q")
@@ -83,12 +83,12 @@ class MainWindow(QMainWindow):
         delete.setShortcut("-")
         delete.triggered.connect(self.delete_todo)
 
-        toggle = QAction(QIcon("gui/icons/todo.png"), "Toggle to-do Status", self)
+        toggle = QAction(QIcon("gui/icons/pytodo-qt.png"), "Toggle to-do Status", self)
         toggle.setShortcut("%")
         toggle.triggered.connect(self.toggle_todo)
 
         # list actions
-        list_add = QAction(QIcon(), "Add new list", self)
+        list_add = QAction(QIcon("gui/icons/plus.png"), "Add new list", self)
         list_add.setShortcut("Ctrl++")
         list_add.triggered.connect(self.add_list)
 
@@ -126,9 +126,12 @@ class MainWindow(QMainWindow):
         change_bind_address = QAction(QIcon(), "Change network server address", self)
         change_bind_address.triggered.connect(self.db_server_bind_address)
 
+        change_crypto_key = QAction(QIcon(), "Change network AES cipher", self)
+        change_crypto_key.triggered.connect(self.db_change_crypto_key)
+
         # fanfare
         about = QAction(QIcon(), "About To-Do", self)
-        about.triggered.connect(self.about_todo)
+        about.triggered.connect(self.about_app)
 
         about_qt = QAction(QIcon(), "About Qt", self)
         about_qt.triggered.connect(self.about_qt)
@@ -184,6 +187,7 @@ class MainWindow(QMainWindow):
                 server_menu.addAction(stop_server)
                 server_menu.addAction(change_port)
                 server_menu.addAction(change_bind_address)
+                server_menu.addAction(change_crypto_key)
             else:
                 msg = "Could not populate server menu, exiting"
                 QMessageBox.warning(self, "Creation Error", msg)
@@ -245,10 +249,11 @@ class MainWindow(QMainWindow):
             QMessageBox.critical(self, "Creation Error", msg)
             logger.log.exception(msg)
             sys.exit(1)
+        self.update_status_bar()
 
         # system tray icon
         self.tray_icon = QSystemTrayIcon(self)
-        self.tray_icon.setIcon(QIcon("gui/icons/todo.png"))
+        self.tray_icon.setIcon(QIcon("gui/icons/pytodo-qt.png"))
 
         # system tray menu actions
         show_action = QAction("Show", self)
@@ -287,7 +292,7 @@ class MainWindow(QMainWindow):
 
     def read_todo_data(self):
         """Read lists of to-dos from database."""
-        if os.path.exists(settings.lists_fn):
+        if Path.exists(settings.db_fn):
             self.update_progress_bar(0)
             self.update_status_bar("Reading in JSON data")
             result, msg = json_helpers.read_json_data()
@@ -304,8 +309,7 @@ class MainWindow(QMainWindow):
     def write_todo_data(self, *args, **kwargs):
         """Write to-do lists to a JSON file."""
         if len(settings.DB.todo_lists.keys()) == 0:
-            msg = "No to-do information, aborting write"
-            QMessageBox.warning(self, "Write Error", msg)
+            logger.log.info("No to-do information, aborting write")
             return
 
         self.update_progress_bar(0)
@@ -395,7 +399,7 @@ class MainWindow(QMainWindow):
     def db_server_bind_address(self, *args, **kwargs):
         """Bind database server to an ip address."""
         address, ok = QInputDialog.getText(
-            self, "Change server ip address", "IP Address: "
+            self, "Change server IP address", "IP Address: "
         )
         if not ok:
             return
@@ -420,6 +424,33 @@ class MainWindow(QMainWindow):
                 settings.DB.write_config()
                 self.refresh()
 
+    @error_on_none_db
+    def db_change_crypto_key(self, *args, **kwargs):
+        """Change network AES cipher."""
+        key, ok = QInputDialog.getText(self, "Change network AES cipher", "Cipher: ")
+        if not ok:
+            return
+
+        if settings.options["key"] == key:
+            QMessageBox.information(self, "Info", f"AES cipher is already {key}")
+            return
+
+        settings.options["key"] = key
+        settings.DB.db_client.aes_cipher = AESCipher(key)
+        settings.DB.db_server.aes_cipher = AESCipher(key)
+        if settings.DB.server_running():
+            reply = QMessageBox.question(
+                self,
+                "Restart Database Server?",
+                "The server needs to be restarted for changes to take effect, would you like to do that now?",
+                QMessageBox.StandardButton.Yes,
+                QMessageBox.StandardButton.No,
+            )
+            if reply == QMessageBox.StandardButton.Yes:
+                settings.DB.restart_server()
+                settings.DB.write_config()
+                self.refresh()
+
     @error_on_none_db
     def add_list(self, *args, **kwargs):
         """Add a new list of to-dos."""
@@ -575,7 +606,6 @@ class MainWindow(QMainWindow):
 
             if not ok:
                 msg = "Did not finishing exporting list"
-                QMessageBox.warning(self, "Export List", msg)
                 logger.log.warning(msg)
                 return
 
@@ -592,7 +622,7 @@ class MainWindow(QMainWindow):
         self.update_status_bar(msg)
         self.update_progress_bar()
 
-    def printlist(self):
+    def print_list(self):
         """Print the active list."""
         self.update_progress_bar(0)
 
@@ -601,7 +631,7 @@ class MainWindow(QMainWindow):
             self.update_progress_bar()
             return
 
-        tmp_fn = Path.home().joinpath(settings.todo_dir, ".todo_printer.tmp")
+        tmp_fn = Path.home().joinpath(settings.app_dir, ".todo_printer.tmp")
 
         accept = QPrintDialog(self.printer).exec()
         if accept:
@@ -628,7 +658,7 @@ class MainWindow(QMainWindow):
             doc = QTextDocument(string)
             doc.print(self.printer)
 
-        msg = "Finished printing todo list"
+        msg = "Finished printing pytodo-qt list"
         QMessageBox.information(self, "Print List", msg)
         logger.log.info(msg)
         self.update_progress_bar()
@@ -753,9 +783,9 @@ class MainWindow(QMainWindow):
             ] = new_text
         self.write_todo_data()
 
-    def about_todo(self):
+    def about_app(self):
         """Display a message box with Program/Author information."""
-        text = """<b><u>To-Do v0.2.4</u></b>
+        text = """<b><u>pytodo-qt v0.2.6</u></b>
         <br><br>To-Do list program that works with multiple To-Do
         lists locally and over a network.
         <br><br>License: <a href="http://www.fsf.org/licenses/gpl.html">GPLv3</a>
@@ -779,7 +809,7 @@ class MainWindow(QMainWindow):
         """Update the progress bar.
 
         Maximum value should be set to the total to-do count,
-        while value should be the number of completed todos.
+        while value should be the number of completed to-dos.
         This makes the progress bar show the total percentage
         of completed to-dos.
         """
@@ -819,7 +849,7 @@ class MainWindow(QMainWindow):
     def refresh(self, sync_occurred=0, *args, **kwargs):
         """Redraw the table and update the progress and status bars."""
         if sync_occurred:
-            logger.log.info("Sync operation occurred, refresh todo list")
+            logger.log.info("Sync operation occurred, refresh pytodo-qt list")
 
         self.update_status_bar("Redrawing table")
 

{pytodo-qt-0.2.4/src/todo → pytodo-qt-0.2.6/src/pytodo_qt}/net/tcp_client_lib.py

@@ -77,7 +77,7 @@ class DatabaseClient(QObject):
             return False, e
 
         # write data to a temporary file, then read it in
-        tmp = Path.joinpath(settings.todo_dir, ".todo_lists.tmp")
+        tmp = Path.joinpath(settings.app_dir, ".todo_lists.tmp")
         try:
             with open(tmp, "w", encoding="utf-8") as f:
                 f.write(deserialized)

{pytodo-qt-0.2.4/src/todo → pytodo-qt-0.2.6/src/pytodo_qt}/net/tcp_server_lib.py

@@ -4,11 +4,12 @@ This module implements a threaded tcp socket server and request handler for To-D
 """
 
 import json
-import os
 import socketserver
 import sys
 import time
 
+from pathlib import Path
+
 from PyQt6.QtWidgets import QMessageBox
 
 from ..core import error_on_none_db, settings
@@ -67,11 +68,9 @@ class TCPRequestHandler(socketserver.StreamRequestHandler):
             self.request.send(self.encrypted_reply)
             return
 
-        if os.path.exists(settings.lists_fn):
-            self.data = ""
-            with open(settings.lists_fn, encoding="utf-8") as f:
-                for line in f:
-                    self.data += line
+        if Path.exists(settings.db_fn):
+            with settings.db_fn.open(mode="r", encoding="utf-8") as db_file:
+                self.data = db_file.read()
 
         if self.data is not None:
             logger.log.info("PULL_REQUEST ACCEPTED")

pytodo-qt-0.2.6/src/pytodo_qt.egg-info/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: pytodo-qt
+Version: 0.2.6
+Summary: A small cross-platform to-do application written in Python 3 and PyQt6
+Author-email: Michael Berry <trismegustis@gmail.com>
+License: GPLv3
+Project-URL: Homepage, https://github.com/berrym/pytodo-qt
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: COPYING
+Requires-Dist: PyQt6
+Requires-Dist: pycryptodomex
+
+# pytodo-qt
+
+A simple to-do list program.
+
+## Description
+
+A small cross-platform application to manage multiple to-do lists written in Python 3 and PyQt6
+
+## Getting started
+
+- Install a recent version of Python, needs **at least** version *3.8*
+- For a package install you will need `pip` or `pipx`
+- For a manual install you will need `git` and the python modules `setuptools`, `wheel`, `build` and `PyQt6`
+  You can install these via your package manager or via `pip`
+
+## Installation
+
+- Install a package. **Recommended**.
+
+It can be installed from PyPi via pip or preferably pipx, all three of these methods should work
+
+    $ pipx install pytodo-qt       # for a local virtualenv install
+    $ pip install pytodo-qt        # for a systemwide install
+    $ pip install --user pytodo-qt # for a user local install
+
+- Manual install
+
+It can be installed by cloning the git repository and building the package:
+
+    $ git clone https://github.com/berrym/pytodo-qt.git
+    $ cd pytodo-qt
+    $ python3 -m venv /path/to/pytodo-qt/venv
+    $ sh /path/to/pytodo-qt/venv/bin/activate  # for linux/unix, activate the appropriate script for your os
+    $ python3 -m build
+    $ /path/to/pytodo-qt/venv/bin/pip install .
+
+### Executing program
+
+If you installed a package then a script named `todo` was installed
+
+    $ todo  # launches the application
+
+If you followed the manual local build instructions
+
+    $ /path/to/pytodo-qt/venv/bin/todo  # launches the application
+
+## Help
+
+    $ todo --help
+
+## Copyright
+
+Copyright 2024 Michael Berry <trismegustis@gmail.com>
+
+## Latest release
+
+- v0.2.5
+
+## License
+
+This project is licensed under the GNU General Public License version 3, or at your option any later version.
+See the COPYING file included in the git repository.
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

pytodo-qt-0.2.6/src/pytodo_qt.egg-info/SOURCES.txt

@@ -0,0 +1,29 @@
+COPYING
+README.md
+pyproject.toml
+src/pytodo_qt/__init__.py
+src/pytodo_qt/__main__.py
+src/pytodo_qt.egg-info/PKG-INFO
+src/pytodo_qt.egg-info/SOURCES.txt
+src/pytodo_qt.egg-info/dependency_links.txt
+src/pytodo_qt.egg-info/entry_points.txt
+src/pytodo_qt.egg-info/requires.txt
+src/pytodo_qt.egg-info/top_level.txt
+src/pytodo_qt/core/Logger.py
+src/pytodo_qt/core/TodoDatabase.py
+src/pytodo_qt/core/__init__.py
+src/pytodo_qt/core/json_helpers.py
+src/pytodo_qt/core/settings.py
+src/pytodo_qt/crypto/AESCipher.py
+src/pytodo_qt/crypto/__init__.py
+src/pytodo_qt/gui/AddTodoDialog.py
+src/pytodo_qt/gui/MainWindow.py
+src/pytodo_qt/gui/SyncDialog.py
+src/pytodo_qt/gui/__init__.py
+src/pytodo_qt/gui/icons/minus.png
+src/pytodo_qt/gui/icons/plus.png
+src/pytodo_qt/gui/icons/pytodo-qt.png
+src/pytodo_qt/net/__init__.py
+src/pytodo_qt/net/sync_operations.py
+src/pytodo_qt/net/tcp_client_lib.py
+src/pytodo_qt/net/tcp_server_lib.py

pytodo-qt-0.2.6/src/pytodo_qt.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pytodo-qt = pytodo_qt.__main__:main

pytodo-qt-0.2.6/src/pytodo_qt.egg-info/top_level.txt

@@ -0,0 +1 @@
+pytodo_qt

pytodo-qt-0.2.4/PKG-INFO

@@ -1,62 +0,0 @@
-Metadata-Version: 2.1
-Name: pytodo-qt
-Version: 0.2.4
-Summary: A simple To-Do list app written in PyQt6
-Author-email: Michael Berry <trismegustis@gmail.com>
-License: GPLv3
-Project-URL: Homepage, https://github.com/berrym/todo
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: COPYING
-Requires-Dist: PyQt6
-Requires-Dist: pycryptodomex
-
-# To-Do
-
-A simple to-do list program.
-
-## Description
-
-A small application to manage multiple to-do lists written in Python 3 and Qt5
-
-## Getting started
-
-* Clone the git repository from https://github.com/berrym/todo.git
-
-* Install a recent version of Python, needs version 3.8+.
-
-* A requirements.txt is provided in the repository so required packages can be installed using pip.
-    * pip install -r requirements.txt --user
-
-### Executing program
-
-The main script can be executed from the command line, e.g.
-
-* python3 todo.py
-
-## Help
-
-python3 todo.py --help
-
-## Authors
-
-Copyright 2020
-Michael Berry <trismegustis@gmail.com>
-
-## Version History
-* 0.1.1
-    * Needs Python 3.8 for walrus operator.
-    * Improved dialogs for syncing.
-    * Serialize network I/O with json.
-
-* 0.1.0
-    * Initial Release
-
-## License
-
-This project is licensed under the GNU General Public License version 3, or at your option any later version.
-
-See the COPYING file included in the git repository.

pytodo-qt-0.2.4/README.md

@@ -1,46 +0,0 @@
-# To-Do
-
-A simple to-do list program.
-
-## Description
-
-A small application to manage multiple to-do lists written in Python 3 and Qt5
-
-## Getting started
-
-* Clone the git repository from https://github.com/berrym/todo.git
-
-* Install a recent version of Python, needs version 3.8+.
-
-* A requirements.txt is provided in the repository so required packages can be installed using pip.
-    * pip install -r requirements.txt --user
-
-### Executing program
-
-The main script can be executed from the command line, e.g.
-
-* python3 todo.py
-
-## Help
-
-python3 todo.py --help
-
-## Authors
-
-Copyright 2020
-Michael Berry <trismegustis@gmail.com>
-
-## Version History
-* 0.1.1
-    * Needs Python 3.8 for walrus operator.
-    * Improved dialogs for syncing.
-    * Serialize network I/O with json.
-
-* 0.1.0
-    * Initial Release
-
-## License
-
-This project is licensed under the GNU General Public License version 3, or at your option any later version.
-
-See the COPYING file included in the git repository.

pytodo-qt-0.2.4/src/pytodo_qt.egg-info/PKG-INFO

@@ -1,62 +0,0 @@
-Metadata-Version: 2.1
-Name: pytodo-qt
-Version: 0.2.4
-Summary: A simple To-Do list app written in PyQt6
-Author-email: Michael Berry <trismegustis@gmail.com>
-License: GPLv3
-Project-URL: Homepage, https://github.com/berrym/todo
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: COPYING
-Requires-Dist: PyQt6
-Requires-Dist: pycryptodomex
-
-# To-Do
-
-A simple to-do list program.
-
-## Description
-
-A small application to manage multiple to-do lists written in Python 3 and Qt5
-
-## Getting started
-
-* Clone the git repository from https://github.com/berrym/todo.git
-
-* Install a recent version of Python, needs version 3.8+.
-
-* A requirements.txt is provided in the repository so required packages can be installed using pip.
-    * pip install -r requirements.txt --user
-
-### Executing program
-
-The main script can be executed from the command line, e.g.
-
-* python3 todo.py
-
-## Help
-
-python3 todo.py --help
-
-## Authors
-
-Copyright 2020
-Michael Berry <trismegustis@gmail.com>
-
-## Version History
-* 0.1.1
-    * Needs Python 3.8 for walrus operator.
-    * Improved dialogs for syncing.
-    * Serialize network I/O with json.
-
-* 0.1.0
-    * Initial Release
-
-## License
-
-This project is licensed under the GNU General Public License version 3, or at your option any later version.
-
-See the COPYING file included in the git repository.

pytodo-qt-0.2.4/src/pytodo_qt.egg-info/SOURCES.txt

@@ -1,29 +0,0 @@
-COPYING
-README.md
-pyproject.toml
-src/pytodo_qt.egg-info/PKG-INFO
-src/pytodo_qt.egg-info/SOURCES.txt
-src/pytodo_qt.egg-info/dependency_links.txt
-src/pytodo_qt.egg-info/entry_points.txt
-src/pytodo_qt.egg-info/requires.txt
-src/pytodo_qt.egg-info/top_level.txt
-src/todo/__init__.py
-src/todo/__main__.py
-src/todo/core/Logger.py
-src/todo/core/TodoDatabase.py
-src/todo/core/__init__.py
-src/todo/core/json_helpers.py
-src/todo/core/settings.py
-src/todo/crypto/AESCipher.py
-src/todo/crypto/__init__.py
-src/todo/gui/AddTodoDialog.py
-src/todo/gui/MainWindow.py
-src/todo/gui/SyncDialog.py
-src/todo/gui/__init__.py
-src/todo/gui/icons/minus.png
-src/todo/gui/icons/plus.png
-src/todo/gui/icons/todo.png
-src/todo/net/__init__.py
-src/todo/net/sync_operations.py
-src/todo/net/tcp_client_lib.py
-src/todo/net/tcp_server_lib.py

pytodo-qt-0.2.4/src/pytodo_qt.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-todo = todo.__main__:main

pytodo-qt-0.2.4/src/pytodo_qt.egg-info/top_level.txt

@@ -1 +0,0 @@
-todo

pytodo-qt-0.2.4/src/todo/core/settings.py

@@ -1,37 +0,0 @@
-"""settings.py
-
-This module creates To-Do core global variables and functions.
-"""
-
-import sys
-
-from pathlib import Path
-
-from ..core.Logger import Logger
-
-
-logger = Logger(__name__)
-
-
-__version__ = "0.2.4"
-options = {}
-DB = None
-
-home_dir = Path.home()
-if home_dir is not None:
-    todo_dir = Path.joinpath(home_dir, ".todo")
-else:
-    logger.log.exception("Unable to write log file, exiting")
-    sys.exit(1)
-
-if not Path.exists(todo_dir):
-    try:
-        Path.mkdir(todo_dir)
-    except OSError as e:
-        logger.log.exception("Error creating To-Do configuration directory: %s", e)
-        sys.exit(1)
-
-
-# private files
-ini_fn = Path.joinpath(todo_dir, "todo.ini")
-lists_fn = Path.joinpath(todo_dir, "todo_lists.json")