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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: things.py
3
- Version: 0.0.3
3
+ Version: 0.0.4
4
4
  Summary: A simple Python 3 library to read your Things app data.
5
5
  Home-page: https://github.com/thingsapi/things.py
6
6
  Author: Alexander Willner, Michael B.
@@ -8,16 +8,16 @@ Author-email: alex@willner.ws
8
8
  License: UNKNOWN
9
9
  Description: # Things Python API
10
10
 
11
- A simple Python 3 library to read your [Things app](https://culturedcode.com/things) data.
11
+ 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).
12
12
 
13
13
  [![Build Status](https://github.com/thingsapi/things.py/workflows/Build-Test/badge.svg)](https://github.com/thingsapi/things.py/actions)
14
+ [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/thingsapi/things.py)](https://scrutinizer-ci.com/g/thingsapi/things.py/?branch=master)
14
15
  [![Coverage Status](https://codecov.io/gh/thingsapi/things.py/branch/main/graph/badge.svg?token=DBWGKAEYAP)](https://codecov.io/gh/thingsapi/things.py)
15
- [![GitHub Release](https://img.shields.io/github/v/release/thingsapi/things.py?sort=semver)](https://github.com/thingsapi/things.py/releases)
16
+ [![GitHub Issues](https://img.shields.io/github/issues/thingsapi/things.py)](https://github.com/thingsapi/things.py/issues)
16
17
  [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
18
+ [![GitHub Release](https://img.shields.io/github/v/release/thingsapi/things.py?sort=semver)](https://github.com/thingsapi/things.py/releases)
17
19
  [![PyPI - Downloads](https://img.shields.io/pypi/dm/things.py?label=pypi%20downloads)](https://pypi.org/project/things.py/)
18
20
  [![GitHub Download Count](https://img.shields.io/github/downloads/thingsapi/things.py/total.svg)](https://github.com/thingsapi/things.py/releases)
19
- [![GitHub Issues](https://img.shields.io/github/issues/thingsapi/things.py)](https://github.com/thingsapi/things.py/issues)
20
- [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/thingsapi/things.py)](https://scrutinizer-ci.com/g/thingsapi/things.py/?branch=master)
21
21
 
22
22
  ## Table of Contents
23
23
 
@@ -1,15 +1,15 @@
1
1
  # Things Python API
2
2
 
3
- A simple Python 3 library to read your [Things app](https://culturedcode.com/things) data.
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).
4
4
 
5
5
  [![Build Status](https://github.com/thingsapi/things.py/workflows/Build-Test/badge.svg)](https://github.com/thingsapi/things.py/actions)
6
+ [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/thingsapi/things.py)](https://scrutinizer-ci.com/g/thingsapi/things.py/?branch=master)
6
7
  [![Coverage Status](https://codecov.io/gh/thingsapi/things.py/branch/main/graph/badge.svg?token=DBWGKAEYAP)](https://codecov.io/gh/thingsapi/things.py)
7
- [![GitHub Release](https://img.shields.io/github/v/release/thingsapi/things.py?sort=semver)](https://github.com/thingsapi/things.py/releases)
8
+ [![GitHub Issues](https://img.shields.io/github/issues/thingsapi/things.py)](https://github.com/thingsapi/things.py/issues)
8
9
  [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
10
+ [![GitHub Release](https://img.shields.io/github/v/release/thingsapi/things.py?sort=semver)](https://github.com/thingsapi/things.py/releases)
9
11
  [![PyPI - Downloads](https://img.shields.io/pypi/dm/things.py?label=pypi%20downloads)](https://pypi.org/project/things.py/)
10
12
  [![GitHub Download Count](https://img.shields.io/github/downloads/thingsapi/things.py/total.svg)](https://github.com/thingsapi/things.py/releases)
11
- [![GitHub Issues](https://img.shields.io/github/issues/thingsapi/things.py)](https://github.com/thingsapi/things.py/issues)
12
- [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/thingsapi/things.py)](https://scrutinizer-ci.com/g/thingsapi/things.py/?branch=master)
13
13
 
14
14
  ## Table of Contents
15
15
 
@@ -20,7 +20,7 @@ AUTHOR = "Alexander Willner, Michael B."
20
20
  AUTHOR_MAIL = "alex@willner.ws"
21
21
  DESCRIPTON = "A simple Python 3 library to read your Things app data."
22
22
  URL = "https://github.com/thingsapi/things.py"
23
- VERSION = "0.0.3"
23
+ VERSION = "0.0.4"
24
24
  DATA_FILES = package_files("")
25
25
  OPTIONS = {
26
26
  "argv_emulation": False,
@@ -386,10 +386,20 @@ def get(uuid, default=None, **kwargs):
386
386
 
387
387
 
388
388
  def todos(uuid=None, **kwargs):
389
+ """
390
+ Read to-dos into dicts.
391
+
392
+ See `things.tasks` for details.
393
+ """
389
394
  return tasks(uuid=uuid, type="to-do", **kwargs)
390
395
 
391
396
 
392
397
  def projects(uuid=None, **kwargs):
398
+ """
399
+ Read projects into dicts.
400
+
401
+ See `things.tasks` for details.
402
+ """
393
403
  return tasks(uuid=uuid, type="project", **kwargs)
394
404
 
395
405
 
@@ -397,6 +407,11 @@ def projects(uuid=None, **kwargs):
397
407
 
398
408
 
399
409
  def inbox(**kwargs):
410
+ """
411
+ Read inbox into dicts.
412
+
413
+ See `things.tasks` for details.
414
+ """
400
415
  return tasks(start="Inbox", **kwargs)
401
416
 
402
417
 
@@ -434,14 +449,29 @@ def upcoming(**kwargs):
434
449
 
435
450
 
436
451
  def anytime(**kwargs):
452
+ """
453
+ Read anytime tasks into dicts.
454
+
455
+ See `things.tasks` for details.
456
+ """
437
457
  return tasks(start="Anytime", **kwargs)
438
458
 
439
459
 
440
460
  def someday(**kwargs):
461
+ """
462
+ Read someday tasks into dicts.
463
+
464
+ See `things.tasks` for details.
465
+ """
441
466
  return tasks(start_date=False, start="Someday", **kwargs)
442
467
 
443
468
 
444
469
  def logbook(**kwargs):
470
+ """
471
+ Read logbook tasks into dicts.
472
+
473
+ See `things.tasks` for details.
474
+ """
445
475
  result = [*canceled(**kwargs), *completed(**kwargs)]
446
476
  result.sort(key=lambda task: task["stop_date"], reverse=True)
447
477
  return result
@@ -451,6 +481,11 @@ def logbook(**kwargs):
451
481
 
452
482
 
453
483
  def canceled(**kwargs):
484
+ """
485
+ Read canceled tasks into dicts.
486
+
487
+ See `things.tasks` for details.
488
+ """
454
489
  return tasks(status="canceled", **kwargs)
455
490
 
456
491
 
@@ -467,6 +502,11 @@ def completed(**kwargs):
467
502
 
468
503
 
469
504
  def deadlines(**kwargs):
505
+ """
506
+ Read tasks with deadlines into dicts.
507
+
508
+ See `things.tasks` for details.
509
+ """
470
510
  result = tasks(deadline=True, **kwargs)
471
511
  result.sort(key=lambda task: task["deadline"])
472
512
  return result
@@ -476,6 +516,10 @@ def deadlines(**kwargs):
476
516
 
477
517
 
478
518
  def link(uuid):
519
+ """
520
+ Returns a things:///show?id=uuid link.
521
+ """
522
+
479
523
  return f"things:///show?id={uuid}"
480
524
 
481
525
 
@@ -530,7 +530,7 @@ class Database:
530
530
  "+" || x || " days") as date,
531
531
  CREATED.TasksCreated as created,
532
532
  CLOSED.TasksClosed as completed,
533
- CANCELLED.TasksCanceled as canceled,
533
+ CANCELED.TasksCanceled as canceled,
534
534
  TRASHED.TasksTrashed as trashed
535
535
  FROM timeseries
536
536
  LEFT JOIN
@@ -548,7 +548,7 @@ class Database:
548
548
  WHERE DAY NOT NULL
549
549
  AND TASK.{self.IS_CANCELED} AND TASK.{self.IS_TODO}
550
550
  GROUP BY DAY)
551
- AS CANCELLED ON CANCELLED.DAY = date
551
+ AS CANCELED ON CANCELED.DAY = date
552
552
  LEFT JOIN
553
553
  (SELECT COUNT(uuid) AS TasksTrashed,
554
554
  date({self.DATE_MOD},"unixepoch") AS DAY
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: things.py
3
- Version: 0.0.3
3
+ Version: 0.0.4
4
4
  Summary: A simple Python 3 library to read your Things app data.
5
5
  Home-page: https://github.com/thingsapi/things.py
6
6
  Author: Alexander Willner, Michael B.
@@ -8,16 +8,16 @@ Author-email: alex@willner.ws
8
8
  License: UNKNOWN
9
9
  Description: # Things Python API
10
10
 
11
- A simple Python 3 library to read your [Things app](https://culturedcode.com/things) data.
11
+ 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).
12
12
 
13
13
  [![Build Status](https://github.com/thingsapi/things.py/workflows/Build-Test/badge.svg)](https://github.com/thingsapi/things.py/actions)
14
+ [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/thingsapi/things.py)](https://scrutinizer-ci.com/g/thingsapi/things.py/?branch=master)
14
15
  [![Coverage Status](https://codecov.io/gh/thingsapi/things.py/branch/main/graph/badge.svg?token=DBWGKAEYAP)](https://codecov.io/gh/thingsapi/things.py)
15
- [![GitHub Release](https://img.shields.io/github/v/release/thingsapi/things.py?sort=semver)](https://github.com/thingsapi/things.py/releases)
16
+ [![GitHub Issues](https://img.shields.io/github/issues/thingsapi/things.py)](https://github.com/thingsapi/things.py/issues)
16
17
  [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
18
+ [![GitHub Release](https://img.shields.io/github/v/release/thingsapi/things.py?sort=semver)](https://github.com/thingsapi/things.py/releases)
17
19
  [![PyPI - Downloads](https://img.shields.io/pypi/dm/things.py?label=pypi%20downloads)](https://pypi.org/project/things.py/)
18
20
  [![GitHub Download Count](https://img.shields.io/github/downloads/thingsapi/things.py/total.svg)](https://github.com/thingsapi/things.py/releases)
19
- [![GitHub Issues](https://img.shields.io/github/issues/thingsapi/things.py)](https://github.com/thingsapi/things.py/issues)
20
- [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/thingsapi/things.py)](https://scrutinizer-ci.com/g/thingsapi/things.py/?branch=master)
21
21
 
22
22
  ## Table of Contents
23
23
 
File without changes
File without changes
File without changes