# seatsio-python, the official Seats.io Python client library
[](https://travis-ci.org/seatsio/seatsio-python)
This is the official Python client library for the [Seats.io V2 REST API](https://docs.seats.io/docs/api-overview), supporting python 2.7, and python 3.3 - 3.7.
## Installing
```
pip install seatsio
```
## Versioning
seatsio-python only uses major version numbers: v5, v6, v7 etc. Each release - backwards compatible or not - receives a new major version number.
The reason: we want to play safe and assume that each release _might_ break backwards compatibility.
## Examples
### Creating a chart and an event
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key") # can be found on https://app.seats.io/settings
chart = client.charts.create()
event = client.events.create(chart.key)
```
### Booking objects
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key")
client.events.book(event.key, ["A-1", "A-2"])
```
### Releasing objects
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key")
client.events.release(event.key, ["A-1", "A-2"])
```
### Booking objects that have been held
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key")
client.events.book(event.key, ["A-1", "A-2"], hold_token="a-hold-token")
```
### Changing object status
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key")
client.events.change_object_status("<EVENT KEY>", ["A-1", "A-2"], "my-custom-status")
```
### Listing all charts
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key")
charts = client.charts.list()
for chart in charts:
print("Chart: " + chart.key)
```
Note: `list()` returns a `PagedIterator`, which under the hood calls the seats.io API to fetch charts page by page. So multiple API calls may be done underneath to fetch all charts.
### Listing charts page by page
E.g. to show charts in a paginated list on a dashboard.
Each page contains an `items` array of charts, and `next_page_starts_after` and `previous_page_ends_before` properties. Those properties are the chart IDs after which the next page starts or the previous page ends.
```python
# ... user initially opens the screen ...
firstPage = client.charts.list_first_page()
for chart in firstPage.items:
print("Chart: " + chart.key)
```
```python
# ... user clicks on 'next page' button ...
nextPage = client.charts.list_page_after(firstPage.next_page_starts_after)
for chart in nextPage.items:
print("Chart: " + chart.key)
```
```python
# ... user clicks on 'previous page' button ...
previousPage = client.charts.list_page_before(nextPage.previous_page_ends_before)
for chart in previousPage.items:
print("Chart: " + chart.key)
```
## Error handling
When an API call results in a 4xx or 5xx error (e.g. when a chart could not be found), a SeatsioException is raised.
This exception contains a message string describing what went wrong, and also two other properties:
- `Errors`: a list of errors (containing a code and a message) that the server returned. In most cases, this list will contain only one element.
- `RequestId`: the identifier of the request you made. Please mention this to us when you have questions, as it will make debugging easier.
[](https://travis-ci.org/seatsio/seatsio-python)
This is the official Python client library for the [Seats.io V2 REST API](https://docs.seats.io/docs/api-overview), supporting python 2.7, and python 3.3 - 3.7.
## Installing
```
pip install seatsio
```
## Versioning
seatsio-python only uses major version numbers: v5, v6, v7 etc. Each release - backwards compatible or not - receives a new major version number.
The reason: we want to play safe and assume that each release _might_ break backwards compatibility.
## Examples
### Creating a chart and an event
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key") # can be found on https://app.seats.io/settings
chart = client.charts.create()
event = client.events.create(chart.key)
```
### Booking objects
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key")
client.events.book(event.key, ["A-1", "A-2"])
```
### Releasing objects
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key")
client.events.release(event.key, ["A-1", "A-2"])
```
### Booking objects that have been held
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key")
client.events.book(event.key, ["A-1", "A-2"], hold_token="a-hold-token")
```
### Changing object status
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key")
client.events.change_object_status("<EVENT KEY>", ["A-1", "A-2"], "my-custom-status")
```
### Listing all charts
```python
import seatsio
client = seatsio.Client(secret_key="my-secret-key")
charts = client.charts.list()
for chart in charts:
print("Chart: " + chart.key)
```
Note: `list()` returns a `PagedIterator`, which under the hood calls the seats.io API to fetch charts page by page. So multiple API calls may be done underneath to fetch all charts.
### Listing charts page by page
E.g. to show charts in a paginated list on a dashboard.
Each page contains an `items` array of charts, and `next_page_starts_after` and `previous_page_ends_before` properties. Those properties are the chart IDs after which the next page starts or the previous page ends.
```python
# ... user initially opens the screen ...
firstPage = client.charts.list_first_page()
for chart in firstPage.items:
print("Chart: " + chart.key)
```
```python
# ... user clicks on 'next page' button ...
nextPage = client.charts.list_page_after(firstPage.next_page_starts_after)
for chart in nextPage.items:
print("Chart: " + chart.key)
```
```python
# ... user clicks on 'previous page' button ...
previousPage = client.charts.list_page_before(nextPage.previous_page_ends_before)
for chart in previousPage.items:
print("Chart: " + chart.key)
```
## Error handling
When an API call results in a 4xx or 5xx error (e.g. when a chart could not be found), a SeatsioException is raised.
This exception contains a message string describing what went wrong, and also two other properties:
- `Errors`: a list of errors (containing a code and a message) that the server returned. In most cases, this list will contain only one element.
- `RequestId`: the identifier of the request you made. Please mention this to us when you have questions, as it will make debugging easier.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
seatsio-36.tar.gz
(11.7 kB
view details)
File details
Details for the file seatsio-36.tar.gz.
File metadata
- Download URL: seatsio-36.tar.gz
- Upload date:
- Size: 11.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e87038edb3e88db84f8e41b68f56fdfb2dc38ebe745b2e56ef5e87f4a2f7b737
|
|
| MD5 |
19d6e13995cdfe8be250518a863fc429
|
|
| BLAKE2b-256 |
7af6eae390ec67bfd8412063c787f2ff0fed857daee075cd6bf6d31f26592991
|
