useshortcut

A python REST API Client for the v3 of the Shortcut API.

Installation

You can install useshortcut using pip:

pip install useshortcut

Or if you're using pipenv:

pipenv install useshortcut

Quick Start

import os
from useshortcut.client import APIClient
import useshortcut.models as models

client = APIClient(api_token=os.environ.get("SHORTCUT_API_TOKEN"))

# Get the current user
current_member = client.get_current_member()

# Find all the stories that I own
search_params = models.SearchInputs(
    query=f"owner:{current_member.mention_name}",
)
# Print all the story ids that I own.
stories = client.search_stories(search_params)
for story in stories.data:
    print(story.id)

Development

Setting up the development environment

Clone the repository:

git clone https://github.com/your-username/useshortcut-py.git
cd useshortcut-py

Install pipenv if you haven't already:

pip install pipenv

Install development dependencies:

pipenv install --dev

Activate the virtual environment:

pipenv shell

Running Tests

There are several ways to run the tests:

Using invoke:

pipenv run invoke test

Using pipenv directly:

pipenv run pytest

To run tests with coverage:

pipenv run pytest --cov=useshortcut

Environment Variables

You'll need to set up the following environment variable for development:

SHORTCUT_API_TOKEN: Your Shortcut API token

You can create a .env file in the project root (it will be ignored by git):

SHORTCUT_API_TOKEN=your_api_token_here

License

This project is licensed under the MIT License - see the LICENSE file for details.

iwillig/useshortcut-py