https://github.com/tizz98/persistiq

Python Wrapper for PersistIQ
https://github.com/tizz98/persistiq

api persistiq

Last synced: 9 days ago
JSON representation

Python Wrapper for PersistIQ

• Host: GitHub
• URL: https://github.com/tizz98/persistiq
• Owner: tizz98
• License: mit
• Created: 2017-02-25T18:01:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-10-01T18:14:29.000Z (about 5 years ago)
• Last Synced: 2024-10-10T09:27:35.183Z (about 1 month ago)
• Topics: api, persistiq
• Language: Python
• Size: 13.7 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# PersistIQ Python API Wrapper

[API docs](http://apidocs.persistiq.com/)

## Installation

### PyPi (recommended)

`pip install persistiq`

### Git

`pip install git+git://github.com/tizz98/persistiq.git@master`

## Usage

### Setup

- Add `PERSIST_IQ_API_KEY='xxxxxxxx'` to your environment variables

    - bash: `echo export PERSIST_IQ_API_KEY='xxxxxxxx' >> ~/.bashrc`

    - zsh: `echo export PERSIST_IQ_API_KEY='xxxxxxxx' >> ~/.zshrc`

    - windows: ???

- Open up a new terminal or:

    - bash: `. ~/.bashrc`

    - zsh: `. ~/.zshrc`

    - windows: ???

### Resources

#### User

```python

from persistiq import User

for user in User.list():

    print user.id, user.name

```

#### Lead

```python

from persistiq import Lead

# NOTE:

# Leads will automatically be paginated

# to only get the first 100 without pagination set:

# >>> Lead.paginate = False

for lead in Lead.list():

    print lead.id, lead.data

```

#### Campaign

```python

from persistiq import Campaign

# NOTE:

# Campaigns will automatically be paginated

# to only get the first 100 without pagination set:

# >>> Campaign.paginate = False

for campaign in Campaign.list():

    print campaign.id, campaign.name

```