Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gearplug/podio-python
podio-python is an API wrapper for Podio, written in Python.
https://github.com/gearplug/podio-python
api oauth2 podio project-management python webhooks wrapper
Last synced: 3 days ago
JSON representation
podio-python is an API wrapper for Podio, written in Python.
- Host: GitHub
- URL: https://github.com/gearplug/podio-python
- Owner: GearPlug
- License: mit
- Created: 2023-09-14T15:44:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-29T15:18:22.000Z (about 1 year ago)
- Last Synced: 2024-11-03T12:34:54.644Z (11 days ago)
- Topics: api, oauth2, podio, project-management, python, webhooks, wrapper
- Language: Python
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# podio-python
 
*podio-python* is an API wrapper for Podio, written in Python.
This library uses Oauth2 for authentication.
## Installing
```
pip install podio-python
```
## Usage
```python
# if you have an access token:
from podio.client import Client
client = Client(access_token=access_token)
```
```python
# if you are using Oauth2 to get an access_token:
from podio.client import Client
client = Client(client_id=client_id, client_secret=client_secret, redirect_uri=redirect_uri)
```
To obtain and set an access token:
1. **Get authorization URL**
```python
url = client.authorization_url(state=None)
```
2. **Get access token using code**
```python
response = client.get_access_token(code)
```
3. **Set access token**
```python
client.set_token(access_token)
```
Check more information about Podio Oauth: https://developers.podio.com/authentication/server_side
#### Refresh token
If your access token expired you can use your refresh token to obtain a new one:
```python
token = client.refresh_token(refresh_token)
# And then set your token again:
client.set_token(token["access_token"])
```
#### Get user status
```python
user = client.get_user_status()
```
### Organizations
#### List organizations
```python
orgs = client.list_organizations()
```
#### List organization spaces
```python
spaces = client.get_organization_spaces(org_id)
```
#### Get space
```python
spaces = client.get_space(space_id)
```
#### List space members
```python
members = client.get_space_members(space_id)
```
### Applications
#### List applications
```python
apps = client.list_applications()
```
#### Get application
```python
app = client.get_application(app_id)
```
#### Get item
```python
item = client.get_item(item_id)
```
#### Create item
```python
body = {"fields": {"title": "Juan Assignment", "status": 1}}
item = client.create_item(app_id, body)
```
#### Get task
```python
task = client.get_task(task_id)
```
#### Create task
```python
body = {"text": "Text of the task", "description": "desc"}
task = client.create_task(body)
```
#### Get task labels
```python
labels = client.get_task_labels()
```
### Webhooks
#### List webhooks
```python
hooks = client.list_webhooks(ref_type, ref_id)
```
#### Create webhook
```python
hook = client.create_webhook(ref_type, ref_id, url, hook_type)
```
#### Validate hook verification
```python
client.validate_hook_verification(webhook_id, code)
```
#### Delete webhook
```python
client.delete_webhook(webhook_id)
```