Python client for CloudFlare.
Project description
A Python client for CloudFlare API v4 and Host API.
It provides two levels of integration against the CloudFlare API:
A low level API, with one method per API endpoint (pycloudflare.services).
A high level ORM API (pycloudflare.models).
Only a subset of the CloudFlare API is currently supported:
Users
Zones
Zone Settings
DNS Records
Page Rules
User creation & authentication through CloudFlare’s partner-facing Host API.
Usage
Get all our zones at CloudFlare
>>> cf = CloudFlareService(api_key, email)
>>> for domain in cf.get_zones():
>>> print domain['name'], domain['id']Configuration
The Host (Partner) API service client is configured when it is instantiated and reads its configuration from configuration.json.
The configuration file should be in the format:
{
"common": {
"cloudflare": {
"api_key": "HOST API KEY HERE",
}
}
}Testing
Install development requirements:
pip install -r requirements.txt
Tests can then be run by doing:
nosetests
The integration tests require a host API key. They can be run with:
nosetests tests/test_integration.py
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
File details
Details for the file pycloudflare-3.0.0.tar.gz.
File metadata
- Download URL: pycloudflare-3.0.0.tar.gz
- Upload date:
- Size: 15.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8de07e7b6d20bee6fb6bd839b5e97d66cb6f37624acfc44db077a98e4455ead5 |
|
| MD5 | 72c0c467a15137e539b95903050cd52a |
|
| BLAKE2b-256 | 07524077a224e7be923415b6e157affe6ec083dfa8ffeb160d3972e299483d25 |
