things-py 0.0.1__tar.gz

things.py-0.0.1/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.1
+Name: things.py
+Version: 0.0.1
+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.
+Author-email: alex@willner.ws
+License: UNKNOWN
+Description: # Things Python API
+        
+        A simple Python 3 library to read your [Things app](https://culturedcode.com/things) data.
+        
+        [![Build Status](https://github.com/thingsapi/things.py/workflows/Build-Test/badge.svg)](https://github.com/thingsapi/things.py/actions)
+        [![Coverage Status](https://codecov.io/gh/thingsapi/things.py/branch/main/graph/badge.svg?token=DBWGKAEYAP)](https://codecov.io/gh/thingsapi/things.py)
+        [![GitHub Release](https://img.shields.io/github/v/release/thingsapi/things.py?sort=semver)](https://github.com/thingsapi/things.py/releases)
+        [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+        [![PyPI - Downloads](https://img.shields.io/pypi/dm/things?label=pypi%20downloads)](https://pypi.org/project/things/)
+        [![GitHub Download Count](https://img.shields.io/github/downloads/thingsapi/things.py/total.svg)](https://github.com/thingsapi/things.py/releases)
+        [![GitHub Issues](https://img.shields.io/github/issues/thingsapi/things.py)](https://github.com/thingsapi/things.py/issues)
+        [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/thingsapi/things.py)](https://scrutinizer-ci.com/g/thingsapi/things.py/?branch=master)
+        
+        ## Table of Contents
+        
+        - [Install](#install)
+        - [Examples](#examples)
+        - [Background](#background)
+        - [Things URLs](#things-urls)
+        
+        ## Install
+        
+        ```sh
+        $ pip3 install things.py
+        # or
+        $ git clone https://github.com/thingsapi/things.py && cd things.py && make install
+        ```
+        
+        ## Examples
+        
+        ```python
+        >>> import things
+        >>> things.todos()
+        [{'uuid': '2Ukg8I2nLukhyEM7wYiBeb',
+          'type': 'to-do',
+          'title': 'Make reservation for dinner',
+          'project': 'bNj6TPdKYhY6fScvXWVRDX',
+          ...},
+         {'uuid': 'RLZroza3jz0XPs3uAlynS7',
+          'type': 'to-do',
+          'title': 'Buy a whiteboard and accessories',
+          'project': 'w8oSP1HjWstPin8RMaJOtB',
+          'notes': "Something around 4' x 3' that's free-standing, two-sided, and magnetic.",
+          'checklist': True,
+          ...
+        >>> things.todos('RLZroza3jz0XPs3uAlynS7')
+        {'uuid': 'RLZroza3jz0XPs3uAlynS7',
+         'type': 'to-do',
+         'title': 'Buy a whiteboard and accessories',
+         ...
+         'checklist': [
+             {'title': 'Cleaning Spray', 'status': 'completed', ...},
+             {'title': 'Magnetic Eraser', 'status': 'incomplete', ...},
+             {'title': 'Round magnets', 'status': 'incomplete', ...}
+         ]
+         ...
+        }
+        
+        >>> things.projects()
+        [{'uuid': 'bNj6TPdKYhY6fScvXWVRDX',
+          'type': 'project',
+          'title': 'Throw Birthday Party',
+          'area': 'bNj6TPdKYhY6fScvXWVRDX',
+          ...},
+         {'uuid': 'w8oSP1HjWstPin8RMaJOtB',
+          'type': 'project',
+          'title': 'Set Up Home Office',
+          'area': 'Gw9QefIdgR6nPEoY5hBNSh',
+          ...
+        
+        >>> things.areas()
+        [{'uuid': 'ToLxnnBrWkfHC3tkx4vxdV',
+          'type': 'area',
+          'title': 'Family',
+          ...},
+         {'uuid': 'Gw9QefIdgR6nPEoY5hBNSh',
+          'type': 'area',
+          'title': 'Apartment',
+          ...
+        
+        >>> things.tags()
+        [{'uuid': 'CKILg3kKF2jlCRisNFcqOj',
+          'type': 'tag',
+          'title': 'Home',
+          'shortcut': None},
+         {'uuid': 'gfmpz8zxnyfqMDvRi3E8vo',
+          'type': 'tag',
+          'title': 'Office',
+          'shortcut': None},
+         ...
+        
+        >>> things.get('CKILg3kKF2jlCRisNFcqOj')
+        {'uuid': 'CKILg3kKF2jlCRisNFcqOj',
+          'type': 'tag',
+          'title': 'Home',
+          'shortcut': None}
+        
+        ```
+        
+        ## Background
+        
+        The task management app Things stores all your to-dos in a SQLite database file (details [here](https://culturedcode.com/things/support/articles/2982272/#get-the-things-3-database-file)). This format is machine-readable, not human-readable. The aim of this project is let you access all your data in a human-readable way. We thereby stay as true to the database as possible while doing SQL Joins and transformations to aid understanding of the data.
+        
+        Here's the terminology used involving the database:
+        
+        - area
+        - tag
+        - task
+          - type
+            - `'to-do'`: may have a checklist; may be in an area and have tags.
+            - `'project'`: may have to-dos and headings; may be in an area and have tags.
+            - `'heading'`:  part of a project; groups "tasks".
+          - status:  `"incomplete"`,  `"canceled"`, or `"completed"`
+          - trashed: `True` or `False`
+          - start: `"Inbox"`, `"Anytime"`, or `"Someday"`
+        - checklist item (contained within a to-do)
+        
+        ## Things URLs
+        
+        You can make good use of the `uuid` to link to to-dos, areas, tags, and more from other apps. Read more [here](https://culturedcode.com/things/blog/2018/02/hey-things/).
+        
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Natural Language :: English
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown

things.py-0.0.1/README.md

@@ -0,0 +1,120 @@
+# Things Python API
+
+A simple Python 3 library to read your [Things app](https://culturedcode.com/things) data.
+
+[![Build Status](https://github.com/thingsapi/things.py/workflows/Build-Test/badge.svg)](https://github.com/thingsapi/things.py/actions)
+[![Coverage Status](https://codecov.io/gh/thingsapi/things.py/branch/main/graph/badge.svg?token=DBWGKAEYAP)](https://codecov.io/gh/thingsapi/things.py)
+[![GitHub Release](https://img.shields.io/github/v/release/thingsapi/things.py?sort=semver)](https://github.com/thingsapi/things.py/releases)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/things?label=pypi%20downloads)](https://pypi.org/project/things/)
+[![GitHub Download Count](https://img.shields.io/github/downloads/thingsapi/things.py/total.svg)](https://github.com/thingsapi/things.py/releases)
+[![GitHub Issues](https://img.shields.io/github/issues/thingsapi/things.py)](https://github.com/thingsapi/things.py/issues)
+[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/thingsapi/things.py)](https://scrutinizer-ci.com/g/thingsapi/things.py/?branch=master)
+
+## Table of Contents
+
+- [Install](#install)
+- [Examples](#examples)
+- [Background](#background)
+- [Things URLs](#things-urls)
+
+## Install
+
+```sh
+$ pip3 install things.py
+# or
+$ git clone https://github.com/thingsapi/things.py && cd things.py && make install
+```
+
+## Examples
+
+```python
+>>> import things
+>>> things.todos()
+[{'uuid': '2Ukg8I2nLukhyEM7wYiBeb',
+  'type': 'to-do',
+  'title': 'Make reservation for dinner',
+  'project': 'bNj6TPdKYhY6fScvXWVRDX',
+  ...},
+ {'uuid': 'RLZroza3jz0XPs3uAlynS7',
+  'type': 'to-do',
+  'title': 'Buy a whiteboard and accessories',
+  'project': 'w8oSP1HjWstPin8RMaJOtB',
+  'notes': "Something around 4' x 3' that's free-standing, two-sided, and magnetic.",
+  'checklist': True,
+  ...
+>>> things.todos('RLZroza3jz0XPs3uAlynS7')
+{'uuid': 'RLZroza3jz0XPs3uAlynS7',
+ 'type': 'to-do',
+ 'title': 'Buy a whiteboard and accessories',
+ ...
+ 'checklist': [
+     {'title': 'Cleaning Spray', 'status': 'completed', ...},
+     {'title': 'Magnetic Eraser', 'status': 'incomplete', ...},
+     {'title': 'Round magnets', 'status': 'incomplete', ...}
+ ]
+ ...
+}
+
+>>> things.projects()
+[{'uuid': 'bNj6TPdKYhY6fScvXWVRDX',
+  'type': 'project',
+  'title': 'Throw Birthday Party',
+  'area': 'bNj6TPdKYhY6fScvXWVRDX',
+  ...},
+ {'uuid': 'w8oSP1HjWstPin8RMaJOtB',
+  'type': 'project',
+  'title': 'Set Up Home Office',
+  'area': 'Gw9QefIdgR6nPEoY5hBNSh',
+  ...
+
+>>> things.areas()
+[{'uuid': 'ToLxnnBrWkfHC3tkx4vxdV',
+  'type': 'area',
+  'title': 'Family',
+  ...},
+ {'uuid': 'Gw9QefIdgR6nPEoY5hBNSh',
+  'type': 'area',
+  'title': 'Apartment',
+  ...
+
+>>> things.tags()
+[{'uuid': 'CKILg3kKF2jlCRisNFcqOj',
+  'type': 'tag',
+  'title': 'Home',
+  'shortcut': None},
+ {'uuid': 'gfmpz8zxnyfqMDvRi3E8vo',
+  'type': 'tag',
+  'title': 'Office',
+  'shortcut': None},
+ ...
+
+>>> things.get('CKILg3kKF2jlCRisNFcqOj')
+{'uuid': 'CKILg3kKF2jlCRisNFcqOj',
+  'type': 'tag',
+  'title': 'Home',
+  'shortcut': None}
+
+```
+
+## Background
+
+The task management app Things stores all your to-dos in a SQLite database file (details [here](https://culturedcode.com/things/support/articles/2982272/#get-the-things-3-database-file)). This format is machine-readable, not human-readable. The aim of this project is let you access all your data in a human-readable way. We thereby stay as true to the database as possible while doing SQL Joins and transformations to aid understanding of the data.
+
+Here's the terminology used involving the database:
+
+- area
+- tag
+- task
+  - type
+    - `'to-do'`: may have a checklist; may be in an area and have tags.
+    - `'project'`: may have to-dos and headings; may be in an area and have tags.
+    - `'heading'`:  part of a project; groups "tasks".
+  - status:  `"incomplete"`,  `"canceled"`, or `"completed"`
+  - trashed: `True` or `False`
+  - start: `"Inbox"`, `"Anytime"`, or `"Someday"`
+- checklist item (contained within a to-do)
+
+## Things URLs
+
+You can make good use of the `uuid` to link to to-dos, areas, tags, and more from other apps. Read more [here](https://culturedcode.com/things/blog/2018/02/hey-things/).

things.py-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

things.py-0.0.1/setup.py

@@ -0,0 +1,54 @@
+"""A simple Python 3 library to read your Things app data."""
+
+import os
+from setuptools import setup, find_packages  # type: ignore
+
+
+def package_files(directory):
+    """Automatically add data resources."""
+    paths = []
+    # pylint: disable=unused-variable
+    for (path, _directories, filenames) in os.walk(directory):
+        for filename in filenames:
+            paths.append((directory, [os.path.join(path, filename)]))
+    return paths
+
+
+APP = ['']
+APP_NAME = "Things"
+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.1"
+DATA_FILES = package_files('')
+OPTIONS = {
+    'argv_emulation': False,
+}
+
+with open("README.md", "r") as fh:
+    LONG_DESRIPTION = fh.read()
+
+setup(
+    app=APP,
+    author=AUTHOR,
+    author_email=AUTHOR_MAIL,
+    name="things.py",
+    description=DESCRIPTON,
+    long_description=LONG_DESRIPTION,
+    long_description_content_type="text/markdown",
+    url=URL,
+    packages=find_packages(),
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: MacOS :: MacOS X",
+        "Natural Language :: English"
+    ],
+    python_requires='>=3.6',
+    version=VERSION,
+    data_files=DATA_FILES,
+    options={'py2app': OPTIONS},
+    setup_requires=['py2app'],
+)

things.py-0.0.1/tests/test_things.py

@@ -0,0 +1,115 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""Module documentation goes here."""
+
+import unittest
+
+import things
+
+
+FILEPATH = dict(filepath="tests/main.sqlite")
+
+
+class ThingsCase(unittest.TestCase):
+    """Class documentation goes here."""
+
+    def test_search(self):
+        """Test search."""
+        tasks = things.search('wrong_query', **FILEPATH)
+        self.assertEqual(0, len(tasks))
+        tasks = things.search('To-Do % Heading', **FILEPATH)
+        self.assertEqual(1, len(tasks))
+
+    def test_inbox(self):
+        """Test inbox."""
+        tasks = things.inbox(**FILEPATH)
+        self.assertEqual(1, len(tasks))
+
+    def test_upcoming(self):
+        """Test upcoming."""
+        tasks = things.upcoming(**FILEPATH)
+        self.assertEqual(2, len(tasks))
+
+    def test_due(self):
+        """Test due."""
+        tasks = things.due(**FILEPATH)
+        self.assertEqual(1, len(tasks))
+
+    def test_today(self):
+        """Test today."""
+        tasks = things.today(**FILEPATH)
+        self.assertEqual(1, len(tasks))
+
+    def test_anytime(self):
+        """Test antime."""
+        tasks = things.anytime(**FILEPATH)
+        self.assertEqual(8, len(tasks))
+
+    def test_logbook(self):
+        """Test logbook."""
+        tasks = things.logbook(**FILEPATH)
+        self.assertEqual(21, len(tasks))
+
+    def test_canceled(self):
+        """Test canceled."""
+        tasks = things.canceled(**FILEPATH)
+        self.assertEqual(11, len(tasks))
+
+    def test_completed(self):
+        """Test completed."""
+        tasks = things.completed(**FILEPATH)
+        self.assertEqual(10, len(tasks))
+
+    def test_someday(self):
+        """Test someday."""
+        tasks = things.someday(**FILEPATH)
+        self.assertEqual(1, len(tasks))
+
+    def test_get(self):
+        """Test get."""
+        tasks = things.get("wrong_uuid", **FILEPATH)
+        self.assertEqual(None, tasks)
+        tasks = things.get("wrong_uuid", "NOT FOUND", **FILEPATH)
+        self.assertEqual("NOT FOUND", tasks)
+        tasks = things.get("Qt2AY87x2QDdowSn9HKTt1", **FILEPATH)
+        self.assertEqual(4, len(tasks))
+
+    def test_todos(self):
+        """Test all tasks."""
+        tasks = things.todos(start="Anytime", **FILEPATH)
+        self.assertEqual(5, 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))
+        with self.assertRaises(ValueError):
+            things.todos(status="wrong_value", **FILEPATH)
+        tasks = things.tasks("A2oPvtt4dXoypeoLc8uYzY", **FILEPATH)
+        self.assertEqual(13, len(tasks))
+
+    def test_tags(self):
+        """Test all tags."""
+        tags = things.tags(**FILEPATH)
+        self.assertEqual(5, len(tags))
+
+    def test_projects(self):
+        """Test all projects."""
+        projects = things.projects(**FILEPATH)
+        self.assertEqual(2, len(projects))
+
+    def test_areas(self):
+        """Test all test_areas."""
+        test_areas = things.areas(**FILEPATH)
+        self.assertEqual(1, len(test_areas))
+
+    def test_database_version(self):
+        """Test database version."""
+        version = things.Database(**FILEPATH).get_version()
+        self.assertEqual(18, version)
+
+
+if __name__ == "__main__":
+    unittest.main()

things.py-0.0.1/things/__init__.py

@@ -0,0 +1,23 @@
+"""A simple Python 3 library to read your Things app data."""
+
+from things.api import (  # noqa
+    anytime,
+    areas,
+    canceled,
+    completed,
+    due,
+    get,
+    inbox,
+    link,
+    logbook,
+    projects,
+    search,
+    show,
+    someday,
+    tags,
+    tasks,
+    today,
+    todos,
+    upcoming,
+)
+from things.database import Database  # noqa