Skip to content

Repository files navigation

PeerdomClient

PeerdomClient is a Python client for interacting with the Peerdom API, which allows organizations to manage their data within Peerdom. This client provides a convenient way to access and perform CRUD operations on peers, roles, and circles through a simple interface.

Installation

You can install the PeerdomClient using pip:

pip install peerdomclient

Usage

To use the PeerdomClient, you need to obtain an API key from Peerdom. Once you have the API key, you can instantiate the client and start making API calls.

Here's an example of how to use the PeerdomClient:

frompeerdomclientimportPeerdomClient# Initialize the clientapi_key="your-api-key"client=PeerdomClient(api_key)
# Get a list of peerspeers=client.get_peers(limit=10)
forpeerinpeers:
print(peer)
# Get details of a specific peerpeer_id="123"#replace with a peer idpeer=client.get_peer(peer_id)
print(peer)
# Create a new peernew_peer=client.create_peer(first_name="John", last_name="Doe", birthdate="1990-01-01")
print(new_peer)
# Update an existing peerpeer_id=new_peer["id"]
updated_peer=client.update_peer(peer_id=peer_id, first_name="Jane", last_name="Doe", birthdate="1990-01-01")
print(updated_peer)
# Delete a peerclient.delete_peer(peer_id)
print("Peer deleted.")

Replace "your-api-key" with your actual API key and "peer-id" with the ID of the peer you want to retrieve, update, or delete.

Documentation

For more details on the available methods and parameters, please refer to the API documentation.

Contributing

Contributions to the PeerdomClient are welcome! If you find a bug, have a suggestion, or want to contribute code improvements, please open an issue or submit a pull request on the GitHub repository.

License

This project is licensed under the MIT License.

About

Python client for the Peerdom API: Easily manage organization data with CRUD operations on peers, roles, and circles.

Topics

Resources

Stars

1 star

Watchers

2 watching

Forks

Releases

Used by

Contributors

Languages