cloudflare


Namecloudflare JSON
Version 3.1.1 PyPI version JSON
download
home_pageNone
SummaryThe official Python library for the cloudflare API
upload_time2024-12-03 22:47:13
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Cloudflare Python API library

[![PyPI version](https://img.shields.io/pypi/v/cloudflare.svg)](https://pypi.org/project/cloudflare/)

The Cloudflare Python library provides convenient access to the Cloudflare REST API from any Python 3.7+
application. The library includes type definitions for all request params and response fields,
and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).

## Documentation

The REST API documentation can be found on [developers.cloudflare.com](https://developers.cloudflare.com/api). The full API of this library can be found in [api.md](https://github.com/cloudflare/cloudflare-python/tree/main/api.md).

## Installation

```sh
# install from PyPI
pip install cloudflare
```

## Usage

The full API of this library can be found in [api.md](https://github.com/cloudflare/cloudflare-python/tree/main/api.md).

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    # This is the default and can be omitted
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),
    # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),
)

zone = client.zones.create(
    account={"id": "023e105f4ecef8ad9ca31a8372d0c353"},
    name="example.com",
    type="full",
)
print(zone.id)
```

While you can provide a `api_email` keyword argument,
we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
to add `CLOUDFLARE_EMAIL="user@example.com"` to your `.env` file
so that your API Email is not stored in source control.

## Async usage

Simply import `AsyncCloudflare` instead of `Cloudflare` and use `await` with each API call:

```python
import os
import asyncio
from cloudflare import AsyncCloudflare

client = AsyncCloudflare(
    # This is the default and can be omitted
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),
    # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),
)


async def main() -> None:
    zone = await client.zones.create(
        account={"id": "023e105f4ecef8ad9ca31a8372d0c353"},
        name="example.com",
        type="full",
    )
    print(zone.id)


asyncio.run(main())
```

Functionality between the synchronous and asynchronous clients is otherwise identical.

## Using types

Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:

- Serializing back into JSON, `model.to_json()`
- Converting to a dictionary, `model.to_dict()`

Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.

## Pagination

List methods in the Cloudflare API are paginated.

This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:

```python
import cloudflare

client = Cloudflare()

all_accounts = []
# Automatically fetches more pages as needed.
for account in client.accounts.list():
    # Do something with account here
    all_accounts.append(account)
print(all_accounts)
```

Or, asynchronously:

```python
import asyncio
import cloudflare

client = AsyncCloudflare()


async def main() -> None:
    all_accounts = []
    # Iterate through items across all pages, issuing requests as needed.
    async for account in client.accounts.list():
        all_accounts.append(account)
    print(all_accounts)


asyncio.run(main())
```

Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:

```python
first_page = await client.accounts.list()
if first_page.has_next_page():
    print(f"will fetch next page using these details: {first_page.next_page_info()}")
    next_page = await first_page.get_next_page()
    print(f"number of items we just fetched: {len(next_page.result)}")

# Remove `await` for non-async usage.
```

Or just work directly with the returned data:

```python
first_page = await client.accounts.list()
for account in first_page.result:
    print(account)

# Remove `await` for non-async usage.
```

## Handling errors

When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `cloudflare.APIConnectionError` is raised.

When the API returns a non-success status code (that is, 4xx or 5xx
response), a subclass of `cloudflare.APIStatusError` is raised, containing `status_code` and `response` properties.

All errors inherit from `cloudflare.APIError`.

```python
import cloudflare
from cloudflare import Cloudflare

client = Cloudflare()

try:
    client.zones.get(
        zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    )
except cloudflare.APIConnectionError as e:
    print("The server could not be reached")
    print(e.__cause__)  # an underlying Exception, likely raised within httpx.
except cloudflare.RateLimitError as e:
    print("A 429 status code was received; we should back off a bit.")
except cloudflare.APIStatusError as e:
    print("Another non-200-range status code was received")
    print(e.status_code)
    print(e.response)
```

Error codes are as followed:

| Status Code | Error Type                 |
| ----------- | -------------------------- |
| 400         | `BadRequestError`          |
| 401         | `AuthenticationError`      |
| 403         | `PermissionDeniedError`    |
| 404         | `NotFoundError`            |
| 422         | `UnprocessableEntityError` |
| 429         | `RateLimitError`           |
| >=500       | `InternalServerError`      |
| N/A         | `APIConnectionError`       |

### Retries

Certain errors are automatically retried 2 times by default, with a short exponential backoff.
Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
429 Rate Limit, and >=500 Internal errors are all retried by default.

You can use the `max_retries` option to configure or disable retry settings:

```python
from cloudflare import Cloudflare

# Configure the default for all requests:
client = Cloudflare(
    # default is 2
    max_retries=0,
)

# Or, configure per-request:
client.with_options(max_retries=5).zones.get(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
```

### Timeouts

By default requests time out after 1 minute. You can configure this with a `timeout` option,
which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:

```python
from cloudflare import Cloudflare

# Configure the default for all requests:
client = Cloudflare(
    # 20 seconds (default is 1 minute)
    timeout=20.0,
)

# More granular control:
client = Cloudflare(
    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)

# Override per-request:
client.with_options(timeout=5.0).zones.edit(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
```

On timeout, an `APITimeoutError` is thrown.

Note that requests that time out are [retried twice by default](https://github.com/cloudflare/cloudflare-python/tree/main/#retries).

## Advanced

### Logging

We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.

You can enable logging by setting the environment variable `CLOUDFLARE_LOG` to `debug`.

```shell
$ export CLOUDFLARE_LOG=debug
```

### How to tell whether `None` means `null` or missing

In an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:

```py
if response.my_field is None:
  if 'my_field' not in response.model_fields_set:
    print('Got json like {}, without a "my_field" key present at all.')
  else:
    print('Got json like {"my_field": null}.')
```

### Accessing raw response data (e.g. headers)

The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,

```py
from cloudflare import Cloudflare

client = Cloudflare()
response = client.zones.with_raw_response.create(
    account={
        "id": "023e105f4ecef8ad9ca31a8372d0c353"
    },
    name="example.com",
    type="full",
)
print(response.headers.get('X-My-Header'))

zone = response.parse()  # get the object that `zones.create()` would have returned
print(zone.id)
```

These methods return an [`APIResponse`](https://github.com/cloudflare/cloudflare-python/tree/main/src/cloudflare/_response.py) object.

The async client returns an [`AsyncAPIResponse`](https://github.com/cloudflare/cloudflare-python/tree/main/src/cloudflare/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.

#### `.with_streaming_response`

The above interface eagerly reads the full response body when you make the request, which may not always be what you want.

To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.

```python
with client.zones.with_streaming_response.create(
    account={"id": "023e105f4ecef8ad9ca31a8372d0c353"},
    name="example.com",
    type="full",
) as response:
    print(response.headers.get("X-My-Header"))

    for line in response.iter_lines():
        print(line)
```

The context manager is required so that the response will reliably be closed.

### Making custom/undocumented requests

This library is typed for convenient access to the documented API.

If you need to access undocumented endpoints, params, or response properties, the library can still be used.

#### Undocumented endpoints

To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
http verbs. Options on the client will be respected (such as retries) will be respected when making this
request.

```py
import httpx

response = client.post(
    "/foo",
    cast_to=httpx.Response,
    body={"my_param": True},
)

print(response.headers.get("x-foo"))
```

#### Undocumented request params

If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
options.

#### Undocumented response properties

To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
can also get all the extra fields on the Pydantic model as a dict with
[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).

### Configuring the HTTP client

You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:

- Support for proxies
- Custom transports
- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality

```python
from cloudflare import Cloudflare, DefaultHttpxClient

client = Cloudflare(
    # Or use the `CLOUDFLARE_BASE_URL` env var
    base_url="http://my.test.server.example.com:8083",
    http_client=DefaultHttpxClient(
        proxies="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)
```

### Managing HTTP resources

By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.

## Semantic versioning

This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes that only affect static types, without breaking runtime behavior.
1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
1. Changes that we do not expect to impact the vast majority of users in practice.

> [!WARNING]
> In addition to the above, changes to type names, structure or methods _may_ occur as we stabilise the automated codegen pipeline. This will be removed in the future once we are further along and the service owner OpenAPI schemas have reached a higher maturity level where changes are not as constant.
> If this isn't suitable for your project, we recommend pinning to a known version or using the previous major version.

## Requirements

Python 3.7 or higher.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "cloudflare",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Cloudflare <api@cloudflare.com>",
    "download_url": "https://files.pythonhosted.org/packages/d4/61/ab3f3c1ad6789df41b71a432dbc3bbd957cc58ba07dd676fdad2d76018f6/cloudflare-3.1.1.tar.gz",
    "platform": null,
    "description": "# Cloudflare Python API library\n\n[![PyPI version](https://img.shields.io/pypi/v/cloudflare.svg)](https://pypi.org/project/cloudflare/)\n\nThe Cloudflare Python library provides convenient access to the Cloudflare REST API from any Python 3.7+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n## Documentation\n\nThe REST API documentation can be found on [developers.cloudflare.com](https://developers.cloudflare.com/api). The full API of this library can be found in [api.md](https://github.com/cloudflare/cloudflare-python/tree/main/api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install cloudflare\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](https://github.com/cloudflare/cloudflare-python/tree/main/api.md).\n\n```python\nimport os\nfrom cloudflare import Cloudflare\n\nclient = Cloudflare(\n    # This is the default and can be omitted\n    api_email=os.environ.get(\"CLOUDFLARE_EMAIL\"),\n    # This is the default and can be omitted\n    api_key=os.environ.get(\"CLOUDFLARE_API_KEY\"),\n)\n\nzone = client.zones.create(\n    account={\"id\": \"023e105f4ecef8ad9ca31a8372d0c353\"},\n    name=\"example.com\",\n    type=\"full\",\n)\nprint(zone.id)\n```\n\nWhile you can provide a `api_email` keyword argument,\nwe recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)\nto add `CLOUDFLARE_EMAIL=\"user@example.com\"` to your `.env` file\nso that your API Email is not stored in source control.\n\n## Async usage\n\nSimply import `AsyncCloudflare` instead of `Cloudflare` and use `await` with each API call:\n\n```python\nimport os\nimport asyncio\nfrom cloudflare import AsyncCloudflare\n\nclient = AsyncCloudflare(\n    # This is the default and can be omitted\n    api_email=os.environ.get(\"CLOUDFLARE_EMAIL\"),\n    # This is the default and can be omitted\n    api_key=os.environ.get(\"CLOUDFLARE_API_KEY\"),\n)\n\n\nasync def main() -> None:\n    zone = await client.zones.create(\n        account={\"id\": \"023e105f4ecef8ad9ca31a8372d0c353\"},\n        name=\"example.com\",\n        type=\"full\",\n    )\n    print(zone.id)\n\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Cloudflare API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nimport cloudflare\n\nclient = Cloudflare()\n\nall_accounts = []\n# Automatically fetches more pages as needed.\nfor account in client.accounts.list():\n    # Do something with account here\n    all_accounts.append(account)\nprint(all_accounts)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nimport cloudflare\n\nclient = AsyncCloudflare()\n\n\nasync def main() -> None:\n    all_accounts = []\n    # Iterate through items across all pages, issuing requests as needed.\n    async for account in client.accounts.list():\n        all_accounts.append(account)\n    print(all_accounts)\n\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.accounts.list()\nif first_page.has_next_page():\n    print(f\"will fetch next page using these details: {first_page.next_page_info()}\")\n    next_page = await first_page.get_next_page()\n    print(f\"number of items we just fetched: {len(next_page.result)}\")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.accounts.list()\nfor account in first_page.result:\n    print(account)\n\n# Remove `await` for non-async usage.\n```\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `cloudflare.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `cloudflare.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `cloudflare.APIError`.\n\n```python\nimport cloudflare\nfrom cloudflare import Cloudflare\n\nclient = Cloudflare()\n\ntry:\n    client.zones.get(\n        zone_id=\"023e105f4ecef8ad9ca31a8372d0c353\",\n    )\nexcept cloudflare.APIConnectionError as e:\n    print(\"The server could not be reached\")\n    print(e.__cause__)  # an underlying Exception, likely raised within httpx.\nexcept cloudflare.RateLimitError as e:\n    print(\"A 429 status code was received; we should back off a bit.\")\nexcept cloudflare.APIStatusError as e:\n    print(\"Another non-200-range status code was received\")\n    print(e.status_code)\n    print(e.response)\n```\n\nError codes are as followed:\n\n| Status Code | Error Type                 |\n| ----------- | -------------------------- |\n| 400         | `BadRequestError`          |\n| 401         | `AuthenticationError`      |\n| 403         | `PermissionDeniedError`    |\n| 404         | `NotFoundError`            |\n| 422         | `UnprocessableEntityError` |\n| 429         | `RateLimitError`           |\n| >=500       | `InternalServerError`      |\n| N/A         | `APIConnectionError`       |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom cloudflare import Cloudflare\n\n# Configure the default for all requests:\nclient = Cloudflare(\n    # default is 2\n    max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries=5).zones.get(\n    zone_id=\"023e105f4ecef8ad9ca31a8372d0c353\",\n)\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:\n\n```python\nfrom cloudflare import Cloudflare\n\n# Configure the default for all requests:\nclient = Cloudflare(\n    # 20 seconds (default is 1 minute)\n    timeout=20.0,\n)\n\n# More granular control:\nclient = Cloudflare(\n    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout=5.0).zones.edit(\n    zone_id=\"023e105f4ecef8ad9ca31a8372d0c353\",\n)\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](https://github.com/cloudflare/cloudflare-python/tree/main/#retries).\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `CLOUDFLARE_LOG` to `debug`.\n\n```shell\n$ export CLOUDFLARE_LOG=debug\n```\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n  if 'my_field' not in response.model_fields_set:\n    print('Got json like {}, without a \"my_field\" key present at all.')\n  else:\n    print('Got json like {\"my_field\": null}.')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe \"raw\" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom cloudflare import Cloudflare\n\nclient = Cloudflare()\nresponse = client.zones.with_raw_response.create(\n    account={\n        \"id\": \"023e105f4ecef8ad9ca31a8372d0c353\"\n    },\n    name=\"example.com\",\n    type=\"full\",\n)\nprint(response.headers.get('X-My-Header'))\n\nzone = response.parse()  # get the object that `zones.create()` would have returned\nprint(zone.id)\n```\n\nThese methods return an [`APIResponse`](https://github.com/cloudflare/cloudflare-python/tree/main/src/cloudflare/_response.py) object.\n\nThe async client returns an [`AsyncAPIResponse`](https://github.com/cloudflare/cloudflare-python/tree/main/src/cloudflare/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\n```python\nwith client.zones.with_streaming_response.create(\n    account={\"id\": \"023e105f4ecef8ad9ca31a8372d0c353\"},\n    name=\"example.com\",\n    type=\"full\",\n) as response:\n    print(response.headers.get(\"X-My-Header\"))\n\n    for line in response.iter_lines():\n        print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) will be respected when making this\nrequest.\n\n```py\nimport httpx\n\nresponse = client.post(\n    \"/foo\",\n    cast_to=httpx.Response,\n    body={\"my_param\": True},\n)\n\nprint(response.headers.get(\"x-foo\"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for proxies\n- Custom transports\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nfrom cloudflare import Cloudflare, DefaultHttpxClient\n\nclient = Cloudflare(\n    # Or use the `CLOUDFLARE_BASE_URL` env var\n    base_url=\"http://my.test.server.example.com:8083\",\n    http_client=DefaultHttpxClient(\n        proxies=\"http://my.test.proxy.example.com\",\n        transport=httpx.HTTPTransport(local_address=\"0.0.0.0\"),\n    ),\n)\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.\n1. Changes that we do not expect to impact the vast majority of users in practice.\n\n> [!WARNING]\n> In addition to the above, changes to type names, structure or methods _may_ occur as we stabilise the automated codegen pipeline. This will be removed in the future once we are further along and the service owner OpenAPI schemas have reached a higher maturity level where changes are not as constant.\n> If this isn't suitable for your project, we recommend pinning to a known version or using the previous major version.\n\n## Requirements\n\nPython 3.7 or higher.\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "The official Python library for the cloudflare API",
    "version": "3.1.1",
    "project_urls": {
        "Homepage": "https://github.com/cloudflare/cloudflare-python",
        "Repository": "https://github.com/cloudflare/cloudflare-python"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6353f702c77f917c781e6b1420be938f5582f728c2cc88e934cfffef27c7464b",
                "md5": "1d0f83f7d2d066f706a68a356c9b8850",
                "sha256": "d065c9ef3b48dcd73e08f2b3a27ce851303767a6de2f42d033e3944bdb291da4"
            },
            "downloads": -1,
            "filename": "cloudflare-3.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1d0f83f7d2d066f706a68a356c9b8850",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 2914023,
            "upload_time": "2024-12-03T22:47:12",
            "upload_time_iso_8601": "2024-12-03T22:47:12.150145Z",
            "url": "https://files.pythonhosted.org/packages/63/53/f702c77f917c781e6b1420be938f5582f728c2cc88e934cfffef27c7464b/cloudflare-3.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d461ab3f3c1ad6789df41b71a432dbc3bbd957cc58ba07dd676fdad2d76018f6",
                "md5": "b45b9d28ef2fca33de031334a864f25f",
                "sha256": "874781a9dddbb96bc72ec100a1cfc01c8dc58fce7e8824e47d20a056c490335a"
            },
            "downloads": -1,
            "filename": "cloudflare-3.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b45b9d28ef2fca33de031334a864f25f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 1368707,
            "upload_time": "2024-12-03T22:47:13",
            "upload_time_iso_8601": "2024-12-03T22:47:13.833922Z",
            "url": "https://files.pythonhosted.org/packages/d4/61/ab3f3c1ad6789df41b71a432dbc3bbd957cc58ba07dd676fdad2d76018f6/cloudflare-3.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-03 22:47:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cloudflare",
    "github_project": "cloudflare-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cloudflare"
}
        
Elapsed time: 0.36788s