Description
Clean and simple bindings to CiviCRM’s API. Both API v3 and API v4 are supported. CiviCRM’s API can be accessed either via REST or the command line tool cv.
Installation
pip install civicrmapi
Getting started
There are four ready to use api classes:
HttpApiV3 - REST API bindings for CiviCRM APIv3
HttpApiV4 - REST API bindings for CiviCRM APIv4
CvApiV3 - Using cv to access CiviCRM APIv3
CvApiV4 - Using cv to access CiviCRM APIv4
All you need to do is to initialize the api of your choice and use it:
from civicrmapi import CvApiV4
api = CvApiV4(cv='/path/to/cv', cwd='/path/to/civicrm/root')
params = {
"contact_type": "Organization",
"organization_name": "pretty org",
}
result = api.Contact.create(params)
Links
1 maintainer
Metadata
1 maintainer
Release files for civicrmapi 0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| civicrmapi-0.5.tar.gz | 12.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| civicrmapi-0.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 28.0 kB
Release files / civicrmapi-0.5.tar.gz
| Download URL | civicrmapi-0.5.tar.gz |
|---|---|
| Size | 12.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
43d8773e4560d0cb55d540c55f26e282a7ab8acad9548a004935b50ee95275eb
|
|
BLAKE2b-256 checksum How to use checksums |
fd2de060d1add73487751206bae20eb965c9f186db0d8d7acd87d7b4124ae787
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 11, 2026.
Transparency logRelease files / civicrmapi-0.5-py3-none-any.whl
| Download URL | civicrmapi-0.5-py3-none-any.whl |
|---|---|
| Size | 15.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fcd6265b9d03272fcc02f2dc525aec4f41d2c6483ca67c61711200a530b11be0
|
|
BLAKE2b-256 checksum How to use checksums |
78a90c47610594683c14b2c8dc15daf2b73cbc6e165ec3dc7113de0d70a91a62
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 11, 2026.
Transparency log
