Metadata-Version: 2.1
Name: things-cli
Version: 0.0.7
Summary: A simple Python 3 CLI to read your Things app data.
Home-page: https://github.com/thingsapi/things-cli
Author: Alexander Willner
Author-email: alex@willner.ws
License: UNKNOWN
Description: # Things Python CLI
        
        A simple Python 3 CLI to read your [Things app](https://culturedcode.com/things) data using the [things.py API](https://github.com/thingsapi/things.py/).
        
        [![Build Status](https://github.com/thingsapi/things-cli/workflows/Build-Test/badge.svg)](https://github.com/thingsapi/things-cli/actions)
        [![Coverage Status](https://codecov.io/gh/thingsapi/things-cli/branch/master/graph/badge.svg?token=dJbdYWeg7d)](https://codecov.io/gh/thingsapi/things-cli)
        [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/thingsapi/things-cli)](https://scrutinizer-ci.com/g/thingsapi/things-cli/?branch=master)
        [![GitHub Issues](https://img.shields.io/github/issues/thingsapi/things-cli)](https://github.com/thingsapi/things-cli/issues)
        [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
        [![GitHub Release](https://img.shields.io/github/v/release/thingsapi/things-cli?sort=semver)](https://github.com/thingsapi/things-cli/releases)
        [![PyPI - Downloads](https://img.shields.io/pypi/dm/things-cli?label=pypi%20downloads)](https://pypi.org/project/things-cli/)
        [![GitHub Download Count](https://img.shields.io/github/downloads/thingsapi/things-cli/total.svg)](https://github.com/thingsapi/things-cli/releases)
        
        ## Table of Contents
        
        - [Install](#install)
        - [Examples](#examples)
        - [Screenshots](#screenshots)
        
        ## Install
        
        ```sh
        $ pip3 install things-cli
        # or
        $ git clone https://github.com/thingsapi/things-cli && cd things-cli && make install
        ```
        
        ## Examples
        
        ```shell
        % things-cli inbox
         -  To-Do in Inbox with Checklist Items  ( Inbox )
         -  To-Do in Inbox  ( Inbox )
        
        % things-cli --recursive areas
        - Area 3 ()
          - Todo in Area 3 (Area 3)
        - Area 2 ()
        - Area 1 ()
          - Project in Area 1 (Area 1)
            - Todo in Area 1 (Project in Area 1)
            - Heading (Project in Area 1)
              - To-Do in Heading (Heading)
          - To-Do in Area 1 (Area 1)
        
        % things-cli --json today|jq
        [
          {
            "uuid": "5pUx6PESj3ctFYbgth1PXY",
            "type": "to-do",
            "title": "To-Do in Today",
            "status": "incomplete",
            "notes": "With\nNotes",
            "start": "Anytime",
            "start_date": "2021-03-28",
            "deadline": null,
            "stop_date": null,
            "created": "2021-03-28 21:11:22",
            "modified": "2021-03-28 21:11:30"
          }
        ]
        
        % things-cli --csv --recursive all > all.csv && open all.csv
        
        % things-cli --opml --recursive all > all.opml && open all.opml
        
        % things-cli -h
        usage: things-cli [-h] [-o] [-j] [-c] [-r] [-d DATABASE] [--version] command ...
        
        Simple read-only Thing 3 CLI.
        
        positional arguments:
          command
            inbox               Shows inbox tasks
            today               Shows todays tasks
            upcoming            Shows upcoming tasks
            anytime             Shows anytime tasks
            completed           Shows completed tasks
            canceled            Shows canceled tasks
            trash               Shows trashed tasks
            all                 Shows all tasks
            areas               Shows all areas
            projects            Shows all projects
            logbook             Shows tasks completed today
            tags                Shows all tags ordered by their usage
            deadlines           Shows tasks with due dates
            feedback            Give feedback
            search              Searches for a specific task
        
        optional arguments:
          -h, --help            show this help message and exit
          -o, --opml            output as OPML
          -j, --json            output as JSON
          -c, --csv             output as CSV
          -r, --recursive       in-depth output
          -d DATABASE, --database DATABASE
                                set path to database
          --version, -v         show program's version number and exit
        ```
        
        ## Screenshots
        
        ### Mindmap
        
        ![opml](https://raw.githubusercontent.com/thingsapi/things-cli/master/resources/opml.png)
        
        ### Excel
        
        ![excel](https://raw.githubusercontent.com/thingsapi/things-cli/master/resources/excel.png)
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
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
