Python client for the Ploomes API
Project description
Ploomes API Python Client
This package provides a simple Python client for interacting with the Ploomes API, designed with rate-limiting and exponential backoff strategies for improved resilience.
Installation
You can install the package from PyPI:
pip install ploomes-api-client
Basic Usage
Contact Management
To manage contacts, first import the necessary classes and initialize them:
from ploomes_client import PloomesClient as Ploomes
from ploomes_client.collections.contacts import Contacts
Initialize PloomesClient and Contacts Class
ploomes = Ploomes(api_key='your_api_key_here')
contacts = Contacts(ploomes)
Creating a New Contact with Expanded Fields
Here is a synthetic example to demonstrate how to create a new contact with expanded Phones
and OtherProperties
:
# Define the payload for the new contact
payload = {
"Name": "Jane Doe",
"Email": "janedoe@example.com",
"Phones": [
{"PhoneNumber": "1234567890", "Type": "Mobile"}
],
"OtherProperties": {"FavoriteColor": "Blue", "Occupation": "Engineer"}
}
# Create the contact
response_json = contacts.post_contact(payload, expand="Phones,OtherProperties")
In this example, the post_contact
method sends a POST request to create a new contact in Ploomes. The payload
dictionary contains the data for the new contact, including fields like Name
, Email
, Phones
, and OtherProperties
. We also use the expand
parameter to expand the Phones
and OtherProperties
fields.
By default, the post_contact
method will return a JSON-formatted string as the response.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Uploading to PyPI with Two-Factor Authentication
-
Generate an API token for your PyPI account:
- Go to the PyPI account settings page and log in.
- Scroll down to the "API Tokens" section and click "Add API Token."
- Provide a description for the token and click "Generate."
- Copy the generated token.
-
Upload your package using the API token:
-
Open your terminal.
-
Navigate to your package directory.
-
Build the distribution files:
python setup.py sdist bdist_wheel
-
Upload the distribution files using the
twine
tool and the generated API token:twine upload --verbose dist/* -u __token__ -p <API_TOKEN>
Replace
<API_TOKEN>
with the copied API token. -
-
Verify the upload:
- Check the PyPI project page to ensure your new version is listed.
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 ploomes-api-client-0.2.87.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae7fd245c66a146bbc26f9c6874dcfd1ae5897768c72e36f7438201f30907b3e |
|
MD5 | 6f997d1c526a04d03500becd8d3dd884 |
|
BLAKE2b-256 | aca38f23e4794889e7dc6ac082fc2753938ba91c6faebf378856e25918d264dd |
Hashes for ploomes_api_client-0.2.87-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a986282ff3db9262a9bb4545d186b6de4f044b10453d281f1b6547aeff1893de |
|
MD5 | 0cd1aa7add316e85867946e53d5044a2 |
|
BLAKE2b-256 | a6ba0a316b10f6044a10ceaf0e05fb48ebe878ec615c7e82f350920649862fd1 |