Skip to content

Commit

Permalink
Project now available at https://pypi.python.org/pypi/cloudflare
Browse files Browse the repository at this point in the history
  • Loading branch information
mahtin committed May 13, 2016
1 parent 6d8479d commit 680962c
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 16 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,34 @@
# cloudflare-python

## CloudFlare API version 4
## Installation

The CloudFlare API can be found [here](https://api.cloudflare.com/). Each API call is provided via a similarly named function within the _CloudFlare_ class. A full list is provided below.
Two methods are provided to install this software. Use PyPi (see [package](https://pypi.python.org/pypi/cloudflare) details) or GitHub (see [package](https://github.com/cloudflare/python-cloudflare) details).

## Installation
### Via PyPI

```bash
./setup.py build
sudo ./setup.py install
$ sudo pip install cloudflare
$
```

Yes - that simple! (the sudo may not be needed in some cases).

### Via github

```bash
$ git clone https://github.com/cloudflare/python-cloudflare
$ cd python-cloudflare
$ ./setup.py build
$ sudo ./setup.py install
$
```

Or whatever variance of that you want to use.

## CloudFlare API version 4

The CloudFlare API can be found [here](https://api.cloudflare.com/). Each API call is provided via a similarly named function within the _CloudFlare_ class. A full list is provided below.

## Getting Started

A very simple listing of zones within your account; including the IPv6 status of the zone.
Expand Down
39 changes: 30 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,44 @@
cloudflare-python
=================

CloudFlare API version 4
------------------------

The CloudFlare API can be found `here <https://api.cloudflare.com/>`__.
Each API call is provided via a similarly named function within the
*CloudFlare* class. A full list is provided below.

Installation
------------

Two methods are provided to install this software. Use PyPi (see
`package <https://pypi.python.org/pypi/cloudflare>`__ details) or GitHub
(see `package <https://github.com/cloudflare/python-cloudflare>`__
details).

Via PyPI
~~~~~~~~

.. code:: bash
./setup.py build
sudo ./setup.py install
$ sudo pip install cloudflare
$
Yes - that simple! (the sudo may not be needed in some cases).

Via github
~~~~~~~~~~

.. code:: bash
$ git clone https://github.com/cloudflare/python-cloudflare
$ cd python-cloudflare
$ ./setup.py build
$ sudo ./setup.py install
$
Or whatever variance of that you want to use.

CloudFlare API version 4
------------------------

The CloudFlare API can be found `here <https://api.cloudflare.com/>`__.
Each API call is provided via a similarly named function within the
*CloudFlare* class. A full list is provided below.

Getting Started
---------------

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
long_description = f.read()

setup(
name='python-cloudflare-test',
version='1.1.9',
name='cloudflare',
version='1.0.1',
description='Python wrapper for the CloudFlare v4 API',
long_description=long_description,
author='Martin J. Levy',
Expand Down

0 comments on commit 680962c

Please sign in to comment.