Agile CRM Python library
Python library for Agile CRM based on the rest-api documentation.
Status
We use this in production for Screenly, and it works fine. Still a bit rough around the corners, but it does indeed work.
Installation
Clone the repo as a sub-module inside your project.
Install the Python requirements.
$ pip install agilecrm
Configuration
In order to use the module, you need to set the following environment variables:
AGILECRM_APIKEY
AGILECRM_EMAIL
AGILECRM_DOMAIN
Usage
First, you need to import the module. This may vary depending on your paths etc, but something like:
import agilecrm
Creating a user
Simply create a new user. Despite what is claimed in the documentation, all variables appear to be optional.
agilecrm.create_contact(
first_name='John',
last_name='Doe',
email='john@doe.com',
tags=['signed_up'],
company='Foobar Inc')
You can also use custom fields (must be created in Agile CRM first):
agilecrm.create_contact(
first_name='John',
custom = {
'SomeField': 'Foobar'
}
Update a contact
Update a user object.
agilecrm.update_contact(
first_name='Steve',
last_name='Smith',
email='john@doe.com',
tags=['name_updated'],
company='Foobar2 Inc')
Get a user (by email)
This will get the user by email and return the user object as JSON.
agilecrm.get_contact_by_email('john@doe.com')
Get a user (by UUID)
This will get the user by UUID and return the user object as JSON.
agilecrm.get_contact_by_uuid(1234)
Add a tag
This will add the tag ‘awesome_user’ to the user ‘john@doe.com’. Both variables are required.
agilecrm.add_tag('john@doe.com', 'awesome_user')
1 maintainer
Metadata
1 maintainer
Release files for agilecrm 0.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| agilecrm-0.0.3.tar.gz | 4.9 kB | Without provenance | Details for agilecrm-0.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| agilecrm-0.0.3-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for agilecrm-0.0.3-py2.py3-none-any.whl |
Total release size: 10.8 kB
Release files / agilecrm-0.0.3.tar.gz
| Download URL | agilecrm-0.0.3.tar.gz |
|---|---|
| Size | 4.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
51c519d30aca52f4abfc899cad6570e77eaddb129c24d36b043d5a95e53535b1
|
|
BLAKE2b-256 checksum How to use checksums |
cc585b9ecbc52da702ccc74b0d08a208e227dfe658b40d257223ab8ae3c0e0b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / agilecrm-0.0.3-py2.py3-none-any.whl
| Download URL | agilecrm-0.0.3-py2.py3-none-any.whl |
|---|---|
| Size | 5.9 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
69192be85be995da73d3d48355b03f30e72d552e92b5851c0bf03dd7a0cd8beb
|
|
BLAKE2b-256 checksum How to use checksums |
c5cab4e0f532784ba470e9c4daef33975edbcbea522aa8f628967682e9ed7f7b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for agilecrm 0.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
