Skip to main content

Checkvist REST API wrapper

Project description

MIT license PyPI pyversions

Checkvist

Checkvist is an online list making app with minimalist UI and amazing keyboard and Markdown support. This package is an unofficial Python wrapper library over its REST API.

Setup

$ pip install checkvist

Example

In [1]: from checkvist import Client
   ...:
   ...: client = Client(username=<username>, secret=<secret>) # [1]

In [2]: client.create_list(name='next trip')
   ...: # a new list to organize my next trip
Checklist(archived=False,
          id=700700,
          item_count=0,
          markdown=True,
          name='next trip',
          options=2,
          percent_completed=0.0,
          public=False,
          read_only=False,
          tags={},
          tags_as_text='',
          task_completed=0,
          task_count=0,
          updated_at=datetime.datetime(2020, 11, 28, 10, 0, 0, tzinfo=datetime.timezone.utc),
          user_count=1,
          user_updated_at=None)

In [3]: client.create_task(list_id=700700, content='Search for air tickets', due_date='next friday')
   ...: # on Friday next week, I should have purchased the tickets
Task(assignee_ids=[],
     checklist_id=700700,
     collapsed=False,
     comments_count=0,
     content='Search for air tickets',
     details={},
     due=datetime.date(2020, 12, 11),
     due_user_ids=[170000],
     id=45004500,
     parent_id=0,
     position=1,
     status=0,
     tags={},
     tags_as_text='',
     tasks=[],
     update_line='created by <My Name>',
     updated_at=datetime.datetime(2020, 11, 28, 10, 1, 0, tzinfo=datetime.timezone.utc))

[1]: params only required if CHECKVIST_USERNAME and CHECKVIST_SECRET environment variables aren't set.

Links


Copyright © 2020 Nuno André

Project details


Download files

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

Source Distribution

checkvist-0.0.1.dev3.tar.gz (10.2 kB view hashes)

Uploaded Source

Built Distribution

checkvist-0.0.1.dev3-py3-none-any.whl (10.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page