Features¶

• TODO

Credits¶

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Stable release¶

To install TwinDB CloudFlare Library, run this command in your terminal:

$ pip install twindb_cloudflare

This is the preferred method to install TwinDB CloudFlare Library, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for TwinDB CloudFlare Library can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/twindb/twindb_cloudflare

Or download the tarball:

$ curl  -OL https://github.com/twindb/twindb_cloudflare/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Submodules¶

twindb_cloudflare.twindb_cloudflare module¶

class twindb_cloudflare.twindb_cloudflare.CloudFlare(email, auth_key, api_endpoint='https://api.cloudflare.com/client/v4')[source]¶

Bases: object

Class to work with CloudFlare API https://api.cloudflare.com/

auth_key¶

See “API Key” on https://www.cloudflare.com/a/account/my-account

Returns:	CloudFlare email

create_dns_record(name, zone, content, data=None, record_type='A', ttl=1)[source]¶

Create a new DNS record for a zone.

Parameters:

name – DNS record name - “example.com” zone – zone name content – DNS record content - “127.0.0.1” data – Optional parameters for DNS record. For example, an SRV record for etcd server needs this: { "name": "twindb.com", "port": 2380, "priority": 0, "proto": "_tcp", "service": "_etcd-server", "target": "node0.twindb.com", "weight": 0 } record_type – DNS record type - “A”. ttl – Time to live for DNS record. Value of 1 is ‘automatic’

Raise:

CloudFlareException if error

delete_dns_record(name, zone)[source]¶

Delete DNS record

Parameters:	name – DNS record name zone – zone name
Raise:	CloudFlareException if error

email¶

See “API Key” on https://www.cloudflare.com/a/account/my-account

Returns:	CloudFlare authentication key

get_record_id(domain_name, zone_id)[source]¶

Get record id by its name

Parameters:	domain_name – DNS record name “example.com” zone_id – zone identified (returned by get_zone_id())
Returns:	id of the record
Raise:	CloudFlareException if record is not found or other error

get_zone_id(name)[source]¶

Get zone id of a given zone

Parameters:	name – zone name
Returns:	id of the zone
Raise:	CloudFlareException if zone is not found or other error

update_dns_record(name, zone, content, record_type='A', ttl=1)[source]¶

Update DNS record

Parameters:	name – domain name zone – zone identifier content – content of DNS record. For A records that would be IP address record_type – DNS record type. “A” by default ttl – TTL of DNS record. 1 by default
Raise:	CloudFlareException if record is not found or other error

exception twindb_cloudflare.twindb_cloudflare.CloudFlareException[source]¶

Bases: exceptions.Exception

Exception for CloudFlare errors

Module contents¶

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up twindb_cloudflare for local development.

1. Fork the twindb_cloudflare repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/twindb_cloudflare.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv twindb_cloudflare
   $ cd twindb_cloudflare/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 twindb_cloudflare tests
   $ python setup.py test or py.test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/twindb/twindb_cloudflare/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ py.test tests.test_twindb_cloudflare

Development Lead¶

• TwinDB Development Team <dev@twindb.com>

Contributors¶

• Aleksandr Kuzminsky <aleks@twindb.com>
• Ovais Tariq <ovaistariq@twindb.com>

0.1.0 (2016-07-17)¶

• First release on PyPI.