Payload Python Library
Project description
Payload Python Library
A Python library for integrating Payload.
Installation
Install using pip
pip install payload-api
Get Started
Once you've installed the Payload Python library to your environment,
import the payload
module to get started. Note: We recommend
using the shorthand name of pl
when importing.
import payload as pl
API Authentication
To authenticate with the Payload API, you'll need a live or test API key. API keys are accessible from within the Payload dashboard.
import payload as pl
pl.api_key = 'secret_key_3bW9JMZtPVDOfFNzwRdfE'
Session based:
import payload
pl = payload.Session('secret_key_3bW9JMZtPVDOfFNzwRdfE')
Creating an Object
Interfacing with the Payload API is done primarily through Payload Objects. Below is an example of
creating a customer using the pl.Customer
object.
# Create a Customer
customer = pl.Customer.create(
email='matt.perez@example.com',
name='Matt Perez'
)
# Create a Payment
payment = pl.Payment.create(
amount=100.0,
payment_method=pl.Card(
card_number='4242 4242 4242 4242'
)
)
Accessing Object Attributes
Object attributes are accessible through dot notation.
customer.name
Updating an Object
Updating an object is a simple call to the update
object method.
# Updating a customer's email
customer.update( email='matt.perez@newwork.com' )
Selecting Objects
Objects can be selected using any of their attributes.
# Select a customer by email
customers = pl.Customer.filter_by(
email='matt.perez@example.com'
)
Use the pl.attr
attribute helper
interface to write powerful queries with a little extra syntax sugar.
payments = pl.Payment.filter_by(
pl.attr.amount > 100,
pl.attr.amount < 200,
pl.attr.description.contains("Test"),
pl.attr.created_at > datetime(2021,2,1)
).all()
Testing the Payload Python Library
Tests are contained within the tests/ directory. To run a test file, once within the pipenv shell, enter the command in terminal
TEST_SECRET_KEY=test_api_key pytest tests/{__FILENAME__}.py
Documentation
To get further information on Payload's Python library and API capabilities, visit the unabridged Payload Documentation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for payload_api-0.4.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f00c0399d02a1f295a337877282befa3dad4ab285d7850420471e7167a5237c2 |
|
MD5 | a983d329bad194d84ffaac26c475c449 |
|
BLAKE2b-256 | 94f4085e25fc3556074e69ffaf292e05c729eabadd8e0e7702bdf9a6c18eb7fc |