You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-4Lines changed: 16 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Things Python API
2
2
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).
@@ -18,6 +18,7 @@ A simple Python 3 library to read your [Things app](https://culturedcode.com/thi
18
18
-[Documentation](#documentation)
19
19
-[Background](#background)
20
20
-[Things URLs](#things-urls)
21
+
-[Used By](#used-by)
21
22
22
23
## Install
23
24
@@ -100,9 +101,13 @@ $ git clone https://github.com/thingsapi/things.py && cd things.py && make insta
100
101
101
102
## Background
102
103
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.
104
105
105
-
Here's the terminology used involving the database:
106
+
If any aspect of the API seems overly complexor 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:
106
111
107
112
- area
108
113
- tag
@@ -116,11 +121,18 @@ Here's the terminology used involving the database:
116
121
- start: `"Inbox"`, `"Anytime"`, or`"Someday"`
117
122
- checklist item (contained within a to-do)
118
123
119
-
120
124
## Documentation
121
125
122
126
The full documentation can be found here: https://thingsapi.github.io/things.py/things/api.html
123
127
124
128
## Things URLs
125
129
126
130
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:
0 commit comments