things-py 0.0.4__tar.gz → 0.0.6__tar.gz

{things.py-0.0.4 → things.py-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: things.py
-Version: 0.0.4
+Version: 0.0.6
 Summary: A simple Python 3 library to read your Things app data.
 Home-page: https://github.com/thingsapi/things.py
 Author: Alexander Willner, Michael B.

{things.py-0.0.4 → things.py-0.0.6}/setup.py

@@ -20,7 +20,7 @@ AUTHOR = "Alexander Willner, Michael B."
 AUTHOR_MAIL = "alex@willner.ws"
 DESCRIPTON = "A simple Python 3 library to read your Things app data."
 URL = "https://github.com/thingsapi/things.py"
-VERSION = "0.0.4"
+VERSION = "0.0.6"
 DATA_FILES = package_files("")
 OPTIONS = {
     "argv_emulation": False,

{things.py-0.0.4 → things.py-0.0.6}/tests/test_things.py

@@ -24,12 +24,12 @@ class ThingsCase(unittest.TestCase):
     def test_inbox(self):
         """Test inbox."""
         tasks = things.inbox(**FILEPATH)
-        self.assertEqual(1, len(tasks))
+        self.assertEqual(2, len(tasks))
 
     def test_upcoming(self):
         """Test upcoming."""
         tasks = things.upcoming(**FILEPATH)
-        self.assertEqual(2, len(tasks))
+        self.assertEqual(1, len(tasks))
 
     def test_deadlines(self):
         """Test deadlines."""
@@ -39,12 +39,20 @@ class ThingsCase(unittest.TestCase):
     def test_today(self):
         """Test today."""
         tasks = things.today(**FILEPATH)
-        self.assertEqual(1, len(tasks))
+        self.assertEqual(2, len(tasks))
+
+    def test_checklist(self):
+        """Test checklist."""
+        tasks = things.checklist_items('3Eva4XFof6zWb9iSfYy4ej', **FILEPATH)
+        self.assertEqual(3, len(tasks))
+        tasks = things.checklist_items('K9bx7h1xCJdevvyWardZDq', **FILEPATH)
+        self.assertEqual(0, len(tasks))
 
     def test_anytime(self):
-        """Test antime."""
+        """Test anytime."""
         tasks = things.anytime(**FILEPATH)
-        self.assertEqual(8, len(tasks))
+        self.assertEqual(11, len(tasks))
+        self.assertTrue(any(task.pop('area_title', '') == 'Area 1' for task in tasks))
 
     def test_logbook(self):
         """Test logbook."""
@@ -78,22 +86,25 @@ class ThingsCase(unittest.TestCase):
     def test_todos(self):
         """Test all tasks."""
         tasks = things.todos(start="Anytime", **FILEPATH)
-        self.assertEqual(5, len(tasks))
+        self.assertEqual(8, len(tasks))
         tasks = things.todos(start="Anytime", status="completed", **FILEPATH)
         self.assertEqual(6, len(tasks))
         tasks = things.todos(status="completed", **FILEPATH)
         self.assertEqual(10, len(tasks))
         tasks = things.todos(include_items=True, **FILEPATH)
-        self.assertEqual(9, len(tasks))
+        self.assertEqual(12, len(tasks))
         with self.assertRaises(ValueError):
             things.todos(status="wrong_value", **FILEPATH)
         tasks = things.tasks("A2oPvtt4dXoypeoLc8uYzY", **FILEPATH)
-        self.assertEqual(13, len(tasks))
+        self.assertEqual(16, len(tasks))
 
     def test_tags(self):
         """Test all tags."""
         tags = things.tags(**FILEPATH)
         self.assertEqual(5, len(tags))
+        tasks = things.tasks(tag='Errand', **FILEPATH)
+        self.assertEqual(1, len(tasks))
+
 
     def test_projects(self):
         """Test all projects."""
@@ -103,7 +114,7 @@ class ThingsCase(unittest.TestCase):
     def test_areas(self):
         """Test all test_areas."""
         test_areas = things.areas(**FILEPATH)
-        self.assertEqual(1, len(test_areas))
+        self.assertEqual(3, len(test_areas))
 
     def test_database_version(self):
         """Test database version."""

{things.py-0.0.4 → things.py-0.0.6}/things/__init__.py

@@ -4,6 +4,7 @@ from things.api import (  # noqa
     anytime,
     areas,
     canceled,
+    checklist_items,
     completed,
     deadlines,
     get,

{things.py-0.0.4 → things.py-0.0.6}/things/api.py

@@ -4,6 +4,8 @@
 Module implementing Things API.
 """
 
+__version__ = "0.0.6"
+
 import os
 from shlex import quote
 import sys
@@ -111,10 +113,11 @@ def tasks(uuid=None, include_items=False, **kwargs):  # noqa: C901
 
     filepath : str, optional
         Any valid path of a SQLite database file generated by the Things app.
-        If no path is provided, then access the default database path.
+        If the environment variable THINGSDB is set, then that path will be used.
+        Otherwise, access the default database path.
 
-    database : things.Database, optional
-        Any valid `things.Database` object previously instantiated.
+    database : things.database.Database, optional
+        Any valid `things.database.Database` object previously instantiated.
 
     Returns
     -------
@@ -214,8 +217,8 @@ def areas(uuid=None, include_items=False, **kwargs):
         Any valid path of a SQLite database file generated by the Things app.
         If no path is provided, then access the default database path.
 
-    database : things.Database, optional
-        Any valid `things.Database` object previously instantiated.
+    database : things.database.Database, optional
+        Any valid `things.database.Database` object previously instantiated.
 
     Returns
     -------
@@ -284,8 +287,8 @@ def tags(title=None, include_items=False, **kwargs):
         Any valid path of a SQLite database file generated by the Things app.
         If no path is provided, then access the default database path.
 
-    database : things.Database, optional
-        Any valid `things.Database` object previously instantiated.
+    database : things.database.Database, optional
+        Any valid `things.database.Database` object previously instantiated.
 
     Returns
     -------
@@ -336,7 +339,7 @@ def search(query: str, **kwargs) -> List[Dict]:
     Currently any part of a title and note of a to-do, project,
     heading, or area is matched.
 
-    See the `search_query` parameter of `api.tasks` for details.
+    See the `search_query` parameter of `things.api.tasks` for details.
 
     Examples
     --------
@@ -389,7 +392,7 @@ def todos(uuid=None, **kwargs):
     """
     Read to-dos into dicts.
 
-    See `things.tasks` for details.
+    See `things.api.tasks` for details.
     """
     return tasks(uuid=uuid, type="to-do", **kwargs)
 
@@ -398,11 +401,24 @@ def projects(uuid=None, **kwargs):
     """
     Read projects into dicts.
 
-    See `things.tasks` for details.
+    See `things.api.tasks` for details.
     """
     return tasks(uuid=uuid, type="project", **kwargs)
 
 
+def checklist_items(uuid, **kwargs):
+    """
+    Read checklist items into dicts.
+    See `things.api.tasks` for details.
+
+    Returns
+    -------
+    list of dict
+        Representing checklist items. Or [] if none found.
+    """
+    return tasks(uuid=uuid, type="to-do", **kwargs).get("checklist", [])  # type: ignore
+
+
 # Filter by collections in the Things app sidebar.
 
 
@@ -410,7 +426,7 @@ def inbox(**kwargs):
     """
     Read inbox into dicts.
 
-    See `things.tasks` for details.
+    See `things.api.tasks` for details.
     """
     return tasks(start="Inbox", **kwargs)
 
@@ -452,7 +468,7 @@ def anytime(**kwargs):
     """
     Read anytime tasks into dicts.
 
-    See `things.tasks` for details.
+    See `things.api.tasks` for details.
     """
     return tasks(start="Anytime", **kwargs)
 
@@ -461,7 +477,7 @@ def someday(**kwargs):
     """
     Read someday tasks into dicts.
 
-    See `things.tasks` for details.
+    See `things.api.tasks` for details.
     """
     return tasks(start_date=False, start="Someday", **kwargs)
 
@@ -470,7 +486,7 @@ def logbook(**kwargs):
     """
     Read logbook tasks into dicts.
 
-    See `things.tasks` for details.
+    See `things.api.tasks` for details.
     """
     result = [*canceled(**kwargs), *completed(**kwargs)]
     result.sort(key=lambda task: task["stop_date"], reverse=True)
@@ -484,7 +500,7 @@ def canceled(**kwargs):
     """
     Read canceled tasks into dicts.
 
-    See `things.tasks` for details.
+    See `things.api.tasks` for details.
     """
     return tasks(status="canceled", **kwargs)
 
@@ -505,7 +521,7 @@ def deadlines(**kwargs):
     """
     Read tasks with deadlines into dicts.
 
-    See `things.tasks` for details.
+    See `things.api.tasks` for details.
     """
     result = tasks(deadline=True, **kwargs)
     result.sort(key=lambda task: task["deadline"])

{things.py-0.0.4 → things.py-0.0.6}/things/database.py

@@ -13,13 +13,14 @@ __author__ = "Alexander Willner"
 __copyright__ = "2020 Alexander Willner"
 __credits__ = ["Alexander Willner"]
 __license__ = "Apache License 2.0"
-__version__ = "2.6.3"
+__version__ = "0.0.6"
 __maintainer__ = "Alexander Willner"
 __email__ = "alex@willner.ws"
 __status__ = "Development"
 
 import datetime
 import os
+import plistlib
 import sqlite3
 import sys
 
@@ -45,7 +46,8 @@ TYPE_TO_FILTER = {"to-do": "type = 0", "project": "type = 1", "heading": "type =
 
 INDICES = ("index", "todayIndex")
 
-COLUMNS_TO_OMIT_IF_NONE = ("area", "project", "heading", "trashed", "checklist", "tags")
+COLUMNS_TO_OMIT_IF_NONE = ("area", "area_title", "project", "project_title",
+                           "heading", "heading_title", "trashed", "checklist", "tags")
 COLUMNS_TO_TRANSFORM_TO_BOOL = ("trashed", "checklist", "tags")
 
 
@@ -99,7 +101,7 @@ class Database:
 
     # pylint: disable=R0913
     def __init__(self, filepath=None):
-        self.filepath = filepath or DEFAULT_DATABASE_FILEPATH
+        self.filepath = filepath or os.environ.get("THINGSDB") or DEFAULT_DATABASE_FILEPATH
 
         # Automated migration to new database location in Things 3.12.6/3.13.1
         # --------------------------------
@@ -113,31 +115,29 @@ class Database:
 
     # Core methods
 
-    def get_tasks(
-        self,
-        uuid=None,
-        type=None,
-        status=None,
-        start=None,
-        area=None,
-        project=None,
-        heading=None,
-        tag=None,
-        start_date=None,
-        deadline=None,
-        index="index",
-        count_only=False,
-        search_query=None,
-    ):
+    def get_tasks(self,  # pylint: disable=R0914
+                  uuid=None,
+                  type=None,  # pylint: disable=W0622
+                  status=None,
+                  start=None,
+                  area=None,
+                  project=None,
+                  heading=None,
+                  tag=None,
+                  start_date=None,
+                  deadline=None,
+                  index="index",
+                  count_only=False,
+                  search_query=None):
         """Get tasks. See `api.tasks` for details on parameters."""
 
         # Overwrites
         start = start and start.title()
 
         # Validation
-        validate("type", type, [None] + list(TYPE_TO_FILTER))
-        validate("status", status, [None] + list(STATUS_TO_FILTER))
-        validate("start", start, [None] + list(START_TO_FILTER))
+        validate("type", type, [None] + list(TYPE_TO_FILTER))  # type: ignore
+        validate("status", status, [None] + list(STATUS_TO_FILTER))  # type: ignore
+        validate("start", start, [None] + list(START_TO_FILTER))  # type: ignore
         validate("index", index, list(INDICES))
 
         if tag is not None:
@@ -181,8 +181,8 @@ class Database:
         sql_query = self.make_task_sql_query(where_predicate)
         if count_only:
             return self.get_count(sql_query)
-        else:
-            return self.execute_query(sql_query)
+
+        return self.execute_query(sql_query)
 
     def make_task_sql_query(self, where_predicate):
         """Make SQL query for Task table"""
@@ -206,12 +206,21 @@ class Database:
                 CASE
                     WHEN AREA.uuid IS NOT NULL THEN AREA.uuid
                 END AS area,
+                CASE
+                    WHEN AREA.uuid IS NOT NULL THEN AREA.title
+                END AS area_title,
                 CASE
                     WHEN PROJECT.uuid IS NOT NULL THEN PROJECT.uuid
                 END AS project,
+                CASE
+                    WHEN PROJECT.uuid IS NOT NULL THEN PROJECT.title
+                END AS project_title,
                 CASE
                     WHEN HEADING.uuid IS NOT NULL THEN HEADING.uuid
                 END AS heading,
+                CASE
+                    WHEN HEADING.uuid IS NOT NULL THEN HEADING.title
+                END AS heading_title,
                 TASK.notes,
                 CASE
                     WHEN TAG.uuid IS NOT NULL THEN 1
@@ -228,7 +237,9 @@ class Database:
                 date(TASK.{self.DATE_DEADLINE}, "unixepoch") AS deadline,
                 date(TASK.stopDate, "unixepoch") AS "stop_date",
                 datetime(TASK.{self.DATE_CREATE}, "unixepoch", "localtime") AS created,
-                datetime(TASK.{self.DATE_MOD}, "unixepoch", "localtime") AS modified
+                datetime(TASK.{self.DATE_MOD}, "unixepoch", "localtime") AS modified,
+                TASK.'index',
+                TASK.todayIndex
             FROM
                 {self.TABLE_TASK} AS TASK
             LEFT OUTER JOIN
@@ -252,6 +263,7 @@ class Database:
             """
 
     def get_task_rows(self, where_predicate):
+        """Executes SQL query with given WHERE clauses."""
         return self.execute_query(self.make_task_sql_query(where_predicate))
 
     def get_areas(self, uuid=None, tag=None, count_only=False):
@@ -262,17 +274,13 @@ class Database:
             valid_tags = self.get_tags(titles_only=True)
             validate("tag", tag, [None] + list(valid_tags))
 
-        if (
-            uuid
-            and count_only is False
-            and not self.get_areas(uuid=uuid, count_only=True)
-        ):
+        if (uuid and count_only is False and not self.get_areas(uuid=uuid, count_only=True)):
             raise ValueError(f"No such area uuid found: {uuid!r}")
 
         # Query
         sql_query = f"""
                 SELECT
-                    AREA.uuid,
+                    DISTINCT AREA.uuid,
                     'area' as type,
                     AREA.title,
                     CASE
@@ -292,8 +300,8 @@ class Database:
                 """
         if count_only:
             return self.get_count(sql_query)
-        else:
-            return self.execute_query(sql_query)
+
+        return self.execute_query(sql_query)
 
     def get_checklist_items(self, task_uuid=None):
         """Get checklist items."""
@@ -339,21 +347,21 @@ class Database:
         if titles_only:
             sql_query = f'SELECT title FROM {self.TABLE_TAG} ORDER BY "index"'
             return self.execute_query(sql_query, row_factory=list_factory)
-        else:
-            sql_query = f"""
-                SELECT
-                    uuid,
-                    'tag' AS type,
-                    title,
-                    shortcut
-                FROM
-                    {self.TABLE_TAG}
-                WHERE
-                    TRUE
-                    {make_filter('title', title)}
-                ORDER BY "index"
-                """
-            return self.execute_query(sql_query)
+
+        sql_query = f"""
+            SELECT
+                uuid,
+                'tag' AS type,
+                title,
+                shortcut
+            FROM
+                {self.TABLE_TAG}
+            WHERE
+                TRUE
+                {make_filter('title', title)}
+            ORDER BY "index"
+            """
+        return self.execute_query(sql_query)
 
     def get_tags_of_task(self, task_uuid):
         """Get tag titles of task"""
@@ -391,7 +399,6 @@ class Database:
 
     def get_version(self):
         """Get Things Database version."""
-        import plistlib
 
         sql_query = f"SELECT value FROM {self.TABLE_META} WHERE key = 'databaseVersion'"
         result = self.execute_query(sql_query, row_factory=list_factory)
@@ -399,6 +406,7 @@ class Database:
         return plistlib.loads(plist_bytes)
 
     def get_count(self, sql):
+        """Count number of results."""
         sql_query = f"""SELECT COUNT(uuid) FROM ({sql})"""
         return self.execute_query(sql_query, row_factory=list_factory)[0]
 
@@ -410,7 +418,7 @@ class Database:
             print(sql_query)
         try:
             uri = f"file:{self.filepath}?mode=ro"  # "ro" means read-only
-            connection = sqlite3.connect(uri, uri=True)
+            connection = sqlite3.connect(uri, uri=True)  # pylint: disable=E1101
             connection.row_factory = row_factory or dict_factory
             cursor = connection.cursor()
             cursor.execute(sql_query, parameters)
@@ -419,7 +427,7 @@ class Database:
                 for task in tasks:
                     print(task)
             return tasks
-        except sqlite3.OperationalError as error:
+        except sqlite3.OperationalError as error:  # pylint: disable=E1101
             print(f"Could not query the database at: {self.filepath}.")
             print(f"Details: {error}.")
             sys.exit(2)
@@ -427,10 +435,12 @@ class Database:
     # -------- Utility methods --------
 
     def last_modified(self):
+        """Get last modified time."""
         mtime_seconds = os.path.getmtime(self.filepath)
         return datetime.datetime.fromtimestamp(mtime_seconds)
 
     def was_modified_today(self):
+        """Was task modified today?"""
         last_modified_date = self.last_modified().date()
         todays_date = datetime.datetime.now().date()
         return last_modified_date >= todays_date
@@ -653,7 +663,7 @@ def dict_factory(cursor, row):
     return result
 
 
-def list_factory(cursor, row):
+def list_factory(_cursor, row):
     """
     Convert SQL selects of one column into a list.
     """
@@ -661,6 +671,7 @@ def list_factory(cursor, row):
 
 
 def make_filter(column, value):
+    """Filter SQL query by AND {column} = "{value}"."""
     default = f'AND {column} = "{value}"'
     # special options
     return {

{things.py-0.0.4 → things.py-0.0.6}/things.py.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: things.py
-Version: 0.0.4
+Version: 0.0.6
 Summary: A simple Python 3 library to read your Things app data.
 Home-page: https://github.com/thingsapi/things.py
 Author: Alexander Willner, Michael B.