From 680962c8c2741e25cb54492b09ee554dc65713de Mon Sep 17 00:00:00 2001 From: mahtin Date: Thu, 12 May 2016 18:27:38 -0700 Subject: [PATCH] Project now available at https://pypi.python.org/pypi/cloudflare --- README.md | 26 +++++++++++++++++++++----- README.rst | 39 ++++++++++++++++++++++++++++++--------- setup.py | 4 ++-- 3 files changed, 53 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f5d7758..48f1c23 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/README.rst b/README.rst index 7304051..ebab34c 100644 --- a/README.rst +++ b/README.rst @@ -1,23 +1,44 @@ cloudflare-python ================= -CloudFlare API version 4 ------------------------- - -The CloudFlare API can be found `here `__. -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 `__ details) or GitHub +(see `package `__ +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 `__. +Each API call is provided via a similarly named function within the +*CloudFlare* class. A full list is provided below. + Getting Started --------------- diff --git a/setup.py b/setup.py index c1b1d6e..ed43394 100755 --- a/setup.py +++ b/setup.py @@ -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',