Skip to content

Commit b285ac2

Browse files
committed
update readme
2 parents f4eb1fc + c242702 commit b285ac2

File tree

4 files changed

+48
-15
lines changed

4 files changed

+48
-15
lines changed

.github/workflows/python-publish.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# This workflow will upload a Python Package using Twine when a release is created
2+
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
3+
4+
# This workflow uses actions that are not certified by GitHub.
5+
# They are provided by a third-party and are governed by
6+
# separate terms of service, privacy policy, and support
7+
# documentation.
8+
9+
name: Upload Python Package
10+
11+
on:
12+
release:
13+
types: [published]
14+
15+
jobs:
16+
deploy:
17+
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- uses: actions/checkout@v2
22+
- name: Set up Python
23+
uses: actions/setup-python@v2
24+
with:
25+
python-version: '3.x'
26+
- name: Install dependencies
27+
run: |
28+
python -m pip install --upgrade pip
29+
pip install build
30+
- name: Build package
31+
run: python -m build
32+
- name: Publish package
33+
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
34+
with:
35+
user: __token__
36+
password: ${{ secrets.PYPI_API_TOKEN }}

.vscode/settings.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,7 @@
88

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

11-
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.
12-
13-
IMPORTANT - If you are creating an application for other's to use, it is highly recommended that you use the OAuth2 flow.
14-
15-
Documentation: Full documentation and examples can be found here: [clickupython documentation](https://clickupython.readthedocs.io/en/latest/)
11+
Documentation (WIP) and examples can be found here: [clickupython documentation](https://clickupython.readthedocs.io/en/latest/)
1612

1713
## Instructions
1814

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

2925
```python
3026

31-
from clickupython import ClickUpClient
27+
from clickupython import client
3228

3329
API_KEY = 'YOUR API KEY'
3430

35-
client = ClickUpClient(API_KEY)
31+
c = client.ClickUpClient(API_KEY)
3632

3733
# Example request
34+
<<<<<<< HEAD
3835
c = client.ClickUpClient(API_KEY)
36+
=======
37+
>>>>>>> c242702ce58f983c0fa42b1f24e7dcb772fe97ea
3938
t = c.create_task("list_id", name="Test task", due_date="march 2 2021")
4039

4140
print(t.name)

setup.cfg

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
11
[metadata]
2+
<<<<<<< HEAD
23
version = 1.0.3
3-
license_files = LICENSE
4+
license_files = LICENSE
5+
=======
6+
version = '1.0.2'
7+
license_files = LICENSE
8+
>>>>>>> c242702ce58f983c0fa42b1f24e7dcb772fe97ea

0 commit comments

Comments
 (0)