Skip to content

Commit 197e011

Browse files
Merge pull request #83 from mikez/main
Update documentation and SQL date filters in `database`.
2 parents ab39c9a + c81f935 commit 197e011

File tree

5 files changed

+332
-208
lines changed

5 files changed

+332
-208
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Things Python API
22

3-
A simple Python 3 library to read your [Things app](https://culturedcode.com/things) data. You can test the API [via our CLI](https://github.com/thingsapi/things-cli).
3+
_things.py_ is a simple Python 3 library to read data from your [Things app](https://culturedcode.com/things).
44

55
[![Build Status](https://github.com/thingsapi/things.py/workflows/Build-Test/badge.svg)](https://github.com/thingsapi/things.py/actions)
66
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/thingsapi/things.py)](https://scrutinizer-ci.com/g/thingsapi/things.py/?branch=master)
@@ -18,6 +18,7 @@ A simple Python 3 library to read your [Things app](https://culturedcode.com/thi
1818
- [Documentation](#documentation)
1919
- [Background](#background)
2020
- [Things URLs](#things-urls)
21+
- [Used By](#used-by)
2122

2223
## Install
2324

@@ -100,9 +101,13 @@ $ git clone https://github.com/thingsapi/things.py && cd things.py && make insta
100101

101102
## Background
102103

103-
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.
104+
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 intended to be 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.
104105

105-
Here's the terminology used involving the database:
106+
If any aspect of the API seems overly complex or doesn't meet your needs, please don't hesitate to add a new issue [here](https://github.com/thingsapi/things.py/issues).
107+
108+
### Terminology
109+
110+
Here's the technical terminology used involving the database:
106111

107112
- area
108113
- tag
@@ -116,11 +121,18 @@ Here's the terminology used involving the database:
116121
- start: `"Inbox"`, `"Anytime"`, or `"Someday"`
117122
- checklist item (contained within a to-do)
118123

119-
120124
## Documentation
121125

122126
The full documentation can be found here: https://thingsapi.github.io/things.py/things/api.html
123127

124128
## Things URLs
125129

126130
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/).
131+
132+
## Used By
133+
134+
The following open-source projects make use of this library:
135+
136+
- [KanbanView](https://github.com/AlexanderWillner/KanbanView)
137+
- [Things CLI](https://github.com/thingsapi/things-cli)
138+
- [ThingsStats](https://github.com/lmgibson/ThingsStats)

0 commit comments

Comments
 (0)