Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Imzachjohnson committed Oct 4, 2021
2 parents f4eb1fc + c242702 commit b285ac2
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 15 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# This workflow will upload a Python Package using Twine when a release is created
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

name: Upload Python Package

on:
release:
types: [published]

jobs:
deploy:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build
- name: Build package
run: python -m build
- name: Publish package
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
with:
user: __token__
password: ${{ secrets.PYPI_API_TOKEN }}
7 changes: 0 additions & 7 deletions .vscode/settings.json

This file was deleted.

13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@

A client for working with the ClickUp API V2. It can be used to interact with the ClickUp API in your projects.

There are two ways to authenticate with ClickUp API 2.0, with a personal token or creating an application and authenticating with an OAuth2 flow.

IMPORTANT - If you are creating an application for other's to use, it is highly recommended that you use the OAuth2 flow.

Documentation: Full documentation and examples can be found here: [clickupython documentation](https://clickupython.readthedocs.io/en/latest/)
Documentation (WIP) and examples can be found here: [clickupython documentation](https://clickupython.readthedocs.io/en/latest/)

## Instructions

Expand All @@ -28,14 +24,17 @@ To use the client for a personal account context (no actions on behalf of anothe

```python

from clickupython import ClickUpClient
from clickupython import client

API_KEY = 'YOUR API KEY'

client = ClickUpClient(API_KEY)
c = client.ClickUpClient(API_KEY)

# Example request
<<<<<<< HEAD
c = client.ClickUpClient(API_KEY)
=======
>>>>>>> c242702ce58f983c0fa42b1f24e7dcb772fe97ea
t = c.create_task("list_id", name="Test task", due_date="march 2 2021")

print(t.name)
Expand Down
7 changes: 6 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
[metadata]
<<<<<<< HEAD
version = 1.0.3
license_files = LICENSE
license_files = LICENSE
=======
version = '1.0.2'
license_files = LICENSE
>>>>>>> c242702ce58f983c0fa42b1f24e7dcb772fe97ea

0 comments on commit b285ac2

Please sign in to comment.