Metadata-Version: 1.1
Name: cloudflare-ddns
Version: 1.3.0
Summary: DDNS script to sync public IP address to CloudFlare dns records
Home-page: https://github.com/ailionx/cloudflare-ddns
Author: Shawn Lin
Author-email: ailionxy@gmail.com
License: MIT
Description: ===============
        cloudflare-ddns
        ===============
        .. image:: https://img.shields.io/pypi/v/cloudflare-ddns.svg
            :target: https://pypi.python.org/pypi/cloudflare-ddns
        
        .. image:: https://img.shields.io/pypi/l/cloudflare-ddns.svg
            :target: https://pypi.python.org/pypi/cloudflare-ddns
        
        .. image:: https://img.shields.io/pypi/wheel/cloudflare-ddns.svg
            :target: https://pypi.python.org/pypi/cloudflare-ddns
        
        .. image:: https://img.shields.io/pypi/pyversions/cloudflare-ddns.svg
            :target: https://pypi.python.org/pypi/cloudflare-ddns
        
        The Python DDNS(Dynamic DNS) script for CloudFlare. It can sync your public IP address to DNS records on CloudFlare. It also provide the RESTful API to operate CloudFlare API v4.
        
        Installation
        ------------
        
        .. code:: shell
        
            pip install cloudflare-ddns
        
        Examples
        --------
        
        #. Sync your public ip address to dns record on CloudFlare
        
            - Use command in command line
        
            .. code:: shell
        
                cloudflare-ddns email api_key domain
        
            - Print command line help
        
            .. code:: shell
        
                cloudflare-ddns --help
        
            - Execute python package in command line
        
            .. code:: shell
        
                python -m cloudflare_ddns email api_key domain --proxied
        
        
            - Python code
        
            .. code:: python
        
                from cloudflare_ddns import CloudFlare
                cf = CloudFlare(email, api_key, domain)
                cf.sync_dns_from_my_ip() # Successfully updated IP address from xx.xx.xx.xx to xx.xx.xx.xx
        
        #. RESTful dns record operation
        
        .. code:: python
        
            cf.get_record('A', 'example.com')
        
        .. code:: python
        
            cf.create_record('A', 'sub.example.com', '202.202.202.202')
        
        .. code:: python
        
            cf.update_record('A', 'another.example.com', '202.202.202.202')
        
        .. code:: python
        
            cf.delete_record('A', 'another.example.com')
        
        *Please note: The class will cache dns records information it gets from CloudFlare. To refresh cache, call 'refresh' method:*
        
        .. code:: python
        
            cf.refresh()
        
Keywords: cloudflare ddns
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
