https://github.com/agility/agilitycms-python-sdk
https://github.com/agility/agilitycms-python-sdk
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/agility/agilitycms-python-sdk
- Owner: agility
- License: mit
- Created: 2021-05-18T13:40:48.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-30T18:25:24.000Z (over 4 years ago)
- Last Synced: 2025-02-14T04:51:14.038Z (over 1 year ago)
- Language: Python
- Size: 14.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Agility CMS Python SDK
This package is a Python library for calling the [Agility CMS Rest API.](https://api-dev.aglty.io/swagger/index.html)
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install agility-cms.
```bash
pip install agility-cms
```
## Initialization
```python
import Client from agility_cms
client = Client(
'',
'',
locale="en-us",
preview=True,
url="api.aglty.io"
)
```
### Required Arguments
* guid (str)
* api_key (str)
### Optional Arguments
* locale (str)
* preview (bool)
* url (str)
## Gallery
```python
client.gallery('')
```
### Required Arguments
* gallery_id (int)
## Item
```python
client.item(
'',
content_link_depth=1,
expand_all_content_links=False
)
```
### Required Arguments
* item_id (int)
### Optional Arguments
* content_link_depth (int)
* expand_all_content_links (bool)
## List
```python
client.list(
'',
fields="",
take=10,
skip=0,
filter_="",
sort="",
direction='asc',
content_link_depth=1,
expand_all_content_links=False
)
```
### Required Arguments
* reference_name (str)
### Optional Arguments
* fields (str)
* take (int)
* skip (int)
* filter (str)
* sort (str)
* direction (str)
* content_link_depth (int)
* expand_all_content_links (bool)
## Page
```python
client.page(
'',
content_link_depth=2,
expand_all_content_links=False
)
```
### Required Arguments
* page_id (int)
### Optional Arguments
* content_link_depth (int)
* expand_all_content_links (bool)
## Sitemap
```python
client.sitemap('', nested=False)
```
### Required Arguments
* channel_name (str)
### Optional Arguments
* nested (bool)
## Sync Items
```python
client.sync_items(sync_token=0, page_size=500)
```
### Optional Arguments
* sync_token (int)
* page_size (int)
## Sync Pages
```python
client.sync_pages(sync_token=0, page_size=500)
```
### Optional Arguments
* sync_token (int)
* page_size (int)
## Url Redirections
```python
client.url_redirections(last_access_date="")
```
### Optional Arguments
* last_access_date (str)