Skip to main content

quare is a CLI client for Quip.

Project description

quare

pipeline status coverage report PyPI - License PyPI PyPI - Python Version PyPI - Status

Interact with Quip from the command line.

quare streaming messages

Introduction

quare allows interaction with Quip via the command line. While quare is in alpha, there are some features you may find useful:

  • Pipe the output of a command to a chat or document and format it as monospace.
  • Archive messages by piping them into a local file
  • Securely store authentication tokens for multiple Quip instances.

This tool is in its early stages of development, and is subject to change (or abandonment) at any time. Use at your own risk.

Installation

$ pipx install quare

Usage

Authentication

Store a Quip API token (See: https://quip.com/dev/token):

$ quare auth
Token: long_token_string
Token stored.

If you have multiple Quip instances (like multiple Slack Workspaces), you can specify an alias for them. You can also pass your token directly to auth:

$ quare msg auth --alias test_server --token 't1DJBQWBXHCYgh1=|2983928392|nYtRFIhV7nl4...'

Whoami

To see information about the logged in user:

$ quare msg whoami
┌Default───────┬───────────────┐
│ Name         │ Tests Testeri │
├──────────────┼───────────────┤
│ Email(s)     │ t@testz.dev   │
├──────────────┼───────────────┤
│ Quip User ID │ mRLA6Zdn3PO   │
└──────────────┴───────────────┘

Sending messages

The destination may be a document or chat:

$ quare msg send --room room_id --content 'Hello everyone!'

Pipe content from stdin

Message content can be piped from stdin:

$ uname -a | quare msg send --room room_id --content '-'

While Quip allows formatting messages using some markdown markup, it doesn't recognize markdown code blocks ("```"). To define a code block, use the --monospace option:

$ dmesg | tail -n 5 | quare msg send --room room_id --content '-' --monospace

Receiving messages

Stream to stdout

To stream every message appearing in the Updates tab:

$ quare msg stream
Streaming updates... press Ctrl-C to exit.
[Sun Jun 30 17:23:09 2019 | (Test Log) | @Tests Testeri] ok ok

Dump the content of a chat room

To get the last 5 messages in a chat room or document:

$ quare msg get --room room_id --last 5
[Sat Jun 29 03:19:09 2019 | @Tester Testeri] This is a monologue!
[Sat Jun 29 16:00:12 2019 | @Tester Testeri] ok
[Sat Jun 29 16:34:51 2019 | @Tester Testeri] I'm done!
[Sun Jun 30 17:30:14 2019 | @Tester Testeri] 🌮
[Sun Jun 30 17:30:27 2019 | @Tester Testeri] 🥃

To get the last 2 messages as JSON:

$ quare msg get  -r "IcTAAAtVxXb" --last 2 --json
[{"author_id": "mRLA6Zdn3PO", "visible": true, "id": "IcderpEe8wG", "created_usec": 1561849212672040, "updated_usec": 1561849212696571, "text": "ok", "author_name": "Tester Testeri"}, {"author_id": "mRLA6Zdn3PO", "visible": true, "id": "IcNodg7n2Tx", "created_usec": 1561851291612434, "updated_usec": 1561851291620308, "text": "chat", "author_name": "Tester Testeri"}]

To dump the last 200 messages in a chat room into a text file:

$ quare msg get --room room_id --last 200 > interesting_conversation.log

To get all messages since a datetime:

$ quare msg get --room room_id --since 2019-01-01T00:32:00Z > greppable_archive.log

The --since option recognizes any date recognized by dateparser:

$ quare msg get --room room_id --since 'Monday' > this_week.log
$ quare msg get --room room_id --since '2 months ago' > this_quarter.log

Editing documents

To append a markdown file to an existing document

$ quare doc append --id xxxDoc_IDxxx --file /tmp/foo.md
$ cat /tmp/foo.md | quare doc append --id xxxDoc_IDxxx --file -

To append a markdown-format string to an existing document

$ quare doc append --id xxxDoc_IDxxx --content '## Headline\n\n'

Development

This work is licensed under the terms of the LGPL-3.0.

Contributions

See CONTRIBUTING.rst

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for quare, version 0.2.3
Filename, size File type Python version Upload date Hashes
Filename, size quare-0.2.3-py3-none-any.whl (22.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size quare-0.2.3.tar.gz (22.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page