This library implements a convenient wrapper for Swell's Backend API and is authorized with a private key making it ideal for server-side use.
All Swell API endpoints and available actions are made available. In general, you can expect get(), list(), update(), create() and delete() methods for each resource. Additional methods (orders.convert_cart_to_order) will be documented while unavailable ones will throw an exception (events.delete).
Authentication only needs to be passed once, during initialization. Errors returned from Swell are surfaced as log warnings while missing arguments will throw an exception.
In terms of implementation, each resoure extends from a base model, and overwrites, adds or disables methods as needed.
Otherwise, a non-opinionated approach is taken, allowing you to call the Swell API as needed. For example, it's oftena a good idea to generate subscriptions from orders with a product containing that purchase option. However, subscription plans can also be generated directly using the /subscriptions endpoint, which is also available.
Rate limiting and caching (LRU) are also included for better performance.
Currently, all responses are python dictionaries generated from requests.json(). This may evolve to return individual classes with advanced processing and methods.
- Clone SwellPy and build locally
git clone [email protected]:swellstores/swellpy.git
python -m build
- Install and Import
pip install [relative path to swellpy]
from swellpy import Swell- Instantiate a new Swell instance
swell = Swell({
store_id: "SWELL_STORE_ID",
api_key: "SWELL_API_KEY"
)}- Request resource
response = swell.products.create({'name': 'my-product-slug'})
print(response) # or setup logging (see below)About Swell
Swell is a customizable, API-first platform for powering modern B2C/B2B shopping experiences and marketplaces. Build and connect anything using your favorite technologies, and provide admins with an easy to use dashboard.
When creating a Swell instance, you can pass initialization options for the desired amount of rate limiting (by # of calls and period)
swell = Swell({
"store_id": "SWELL_STORE_ID",
"api_key": "SWELL_API_KEY"
"options": {
"rate_limit_calls": 2,
"rate_limit_period": 1
}
})📖 View Swell Backend API Documentation
SwellPy uses the standard Logging library to log HTTP requests (DEBUG level). To capture these logs, a handler can be configured as shown:
import logging
import sys
logger = logging.getLogger()
logger.setLevel(logging.DEBUG)
handler = logging.StreamHandler(sys.stdout)
handler.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)