paddle-python 0.6.0

Description:

paddlepython 0.6.0

This project has changeed name to paddle-client
Github - paddle-client
PyPi - paddle-client
If you have installed the old paddle-python please remove the old paddle-python and install paddle-client to ensure you get the latest changes, paddle-python will no longer be updated
pip uninstall paddle-python
pip install paddle-client

The README below have been updated to reflect the above. If you want to see the old version please see release 0.5.1 - the last release as paddle-python


A python (3.5+) wrapper around the Paddle.com API
If you are looking at intergrating Paddle with Django check out dj-paddle
Note: This is a work in progress, not all of the Paddle endpoints have been implemented yet
Quick start
Installation
pip install paddle-client

Usage
To use the Paddle API you will need a Paddle Vendor ID and API key which can be found on Paddle's authentication page
from paddle import PaddleClient


paddle = PaddleClient(vendor_id=12345, api_key='myapikey')
paddle.list_products()

If vendor_id and api_key are not passed through when initalising Paddle will fall back and try and use environmental variables called PADDLE_VENDOR_ID and PADDLE_API_KEY
export PADDLE_VENDOR_ID=12345
export PADDLE_API_KEY="myapikey"

from paddle import PaddleClient


paddle = PaddleClient()
paddle.list_products()

Documentation
Coming soon. Please see Working endpoints below for basic usage.
Contributing
All contributions are welcome and appreciated. Please see CONTRIBUTING.md for more details including details on how to run tests etc.
Working endpoints

Get Order Details
Get User History
Get Prices
List Coupons
Create Coupon
Delete Coupon
Update Coupon
List Products
List Transactions
Refund Payment
List Plans
Create Plan
List Subscription Users
Cancel Subscription
Update Subscription
Preview Subscription Update
Get Webhook History

paddle.get_order_details(checkout_id=checkout_id)
paddle.get_user_history(email=email)
paddle.get_prices(product_ids=[product_id])
paddle.list_coupons(product_id=product_id)
paddle.create_coupon(
coupon_type='product',
discount_type='percentage',
discount_amount=50,
allowed_uses=1,
recurring=False,
currency='USD',
product_ids=product_ids,
coupon_code='50%OFF',
description='50% off coupon over $10',
expires=expires,
minimum_threshold=10,
group='paddle-python',
)
paddle.delete_coupon(coupon_code=new_coupon_code, product_id=product_id)
paddle.update_coupon(
coupon_code=coupon_code,
new_coupon_code='40%OFF',
new_group='paddle-python-test',
product_ids=[product_id],
expires=expires,
allowed_uses=1,
currency='USD',
minimum_threshold=10,
discount_amount=40,
recurring=True
)
paddle.list_products()
paddle.list_transactions(entity='subscription', entity_id=subscription_id)
paddle.refund_payment(order_id=order_id, amount=amount, reason=reason)
paddle.list_plans()
paddle.create_plan(
plan_name='plan_name',
plan_trial_days=14,
plan_length=1,
plan_type='month',
main_currency_code='USD',
initial_price_usd=50,
recurring_price_usd=50,
)
paddle.list_subscription_users()
paddle.cancel_subscription(subscription_id=1234)
paddle.update_subscription(subscription_id=1234, pause=True)
paddle.preview_update_subscription(
subscription_id=123,
bill_immediately=True,
quantity=101,
)
paddle.get_webhook_history()

Failing Endpoints
The below endpoints have been implimented but are not working correctly according to the tests. They have been commented out in paddle/paddle.py and the tests will skip is the methods do not exist

Generate License - Paddle error 108 - Unable to find requested product
Create pay link - Paddle error 108 - Unable to find requested product

ToDo

Fix generate license and create pay link endpoints
Paddle API endpoints

Add Modifier
Delete Modifier
List Modifiers
List Payments
Reschedule Payment
Create One-off Charge


Work out if we want to include 'alias' methods like pause_subscription
Get test coverage to 100%
Docs (auto docs?)
Use pytest-mock Spy to check params, json, urls etc for test requests

Needed to any tests which skip due to missing data


How to deal with the manual cleanup?
Pull request template
TravisCI?
Dependabot
Remove double call for exception error message checking - How to get the exception str from pytest.raises()? pytest-mock Spy?
Add pytest warnings to provide direct links to Paddle for bits that need to be cleaned up