Metadata-Version: 1.1
Name: ns1-python
Version: 0.15.0
Summary: Python SDK for the NS1 DNS platform
Home-page: https://github.com/ns1/ns1-python
Author: NS1 Developers
Author-email: devteam@ns1.com
License: MIT
Description: ==============
        NS1 Python SDK
        ==============
        
        > This project is in [active development](https://github.com/ns1/community/blob/master/project_status/ACTIVE_DEVELOPMENT.md).
        
        :Info: A Python SDK for accessing NS1, the Data Driven DNS platform.
        
        .. image:: https://travis-ci.org/ns1/ns1-python.svg?branch=master
                :target: https://travis-ci.org/ns1/ns1-python
        
        .. image:: https://readthedocs.org/projects/ns1-python/badge/?version=latest
                :target: https://ns1-python.readthedocs.io/en/latest/
        
        About
        =====
        
        This package provides a python SDK for accessing the NS1 DNS platform
        and includes both a simple NS1 REST API wrapper as well as a higher level
        interface for managing zones, records, data feeds, and more.
        It supports synchronous and asynchronous transports.
        
        Both python 2.7 and 3.3+ are supported. Automated tests are currently run
        against 2.7 and 3.6.
        
        Installation
        ============
        
          $ pip install ns1-python
        
        Dependencies
        ============
        
        None, but supports different transport backends. Currently supported:
        
         * `requests <http://docs.python-requests.org/en/latest/>`_ (synchronous, the default if available)
         * urllib (synchronous, the default if requests isn't available)
         * `twisted <https://twistedmatrix.com/>`_ (asynchronous, requires 2.7 or 3.5+)
        
        Other transports are easy to add, see `transport <https://github.com/ns1/ns1-python/tree/master/ns1/rest/transport>`_
        
        Examples
        ========
        
        See the `examples directory <https://github.com/ns1/ns1-python/tree/master/examples>`_
        
        Documentation
        =============
        
        If you don't yet have an NS1 account, `signup here (free) <https://ns1.com/signup/>`_
        
        You'll need an API Key. To create one, login to `the portal <https://my.nsone.net/>`_ and
        click on the Account button in the top right. Select Settings & Users, then add a new
        API Key at the bottom.
        
        * `Documentation at ReadTheDocs <https://ns1-python.readthedocs.org/en/latest/>`_
        * `NS1 REST API Documentation <https://ns1.com/api/>`_
        
        Tests
        =====
        
        Unit tests use `pytest` (`pip install pytest`). 2.7 also requires `mock` to be
        installed (`pip install mock`).
        
        Tests should, of course, run and pass under python 2 and 3. We use tox to
        automate test runs and virtualenv setup, see `tox.ini` for config.
        
        Contributions
        =============
        Pull Requests and issues are welcome. See the [NS1 Contribution Guidelines](https://github.com/ns1/community) for more information.
        
        Our CI process will lint and check for formatting issues with `flake8` and
        `black`.
        It is suggested to run these checks prior to submitting a pull request and fix
        any issues:
        ```
        pip install flake8 black
        flake8 . --count --show-source --statistics --extend-ignore=E501
        black . --check -l 79 --diff
        ```
        
Keywords: dns development rest sdk ns1 nsone
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: Name Service (DNS)
