All Projects → ns1 → ns1-python

ns1 / ns1-python

Licence: MIT license
NS1 Python SDK

Programming Languages

python
139335 projects - #7 most used programming language

Projects that are alternatives of or similar to ns1-python

AvaTax-REST-V2-Python-SDK
Sales Tax API SDK for Python and AvaTax REST
Stars: ✭ 17 (-29.17%)
Mutual labels:  python-sdk
faxplus-python
Python SDK to use FAX.PLUS API
Stars: ✭ 54 (+125%)
Mutual labels:  python-sdk
meican
MeiCan Python SDK. 美餐点餐库 + 命令行工具。
Stars: ✭ 65 (+170.83%)
Mutual labels:  python-sdk
wxpusher-sdk-python
微信消息实时推送服务[WxPusher]的Python版本sdk,可以通过API实时给个人微信推送消息。wechat pusher.
Stars: ✭ 156 (+550%)
Mutual labels:  python-sdk
python-alerta-client
Unified command-line tool and python SDK for alerta
Stars: ✭ 26 (+8.33%)
Mutual labels:  python-sdk
googlecloud-storage-tutorial
💾 ☁️ Tutorial for interacting with Google Cloud Storage via the Python SDK.
Stars: ✭ 20 (-16.67%)
Mutual labels:  python-sdk
square-python-sdk
Python client library for the Square API
Stars: ✭ 72 (+200%)
Mutual labels:  python-sdk

Build Status Docs

NS1 Python SDK

This project is in active development.

A Python SDK for accessing NS1, the Data Driven DNS platform.

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, 3.7, 3.8, 3.9 and 3.10.

Installation

$ pip install ns1-python

Dependencies

None, but supports different transport backends. Currently supported:

  • requests (synchronous, the default if available)
  • urllib (synchronous, the default if requests isn't available)
  • twisted (asynchronous, requires 2.7 or 3.5+)

Other transports are easy to add, see transport

Examples

See the examples directory

Documentation

If you don't yet have an NS1 account, signup here (free)

You'll need an API Key. To create one, login to the portal and click on the Account button in the top right. Select Settings & Users, then add a new API Key at the bottom.

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 for more information.

Editing the docs

You can create or edit NS1-python documentation by downloading the repo onto your machine and using an editor such as VSCode.

Creating Pull Requests

  1. When you're ready to submit your changes, add a descriptive title and comments to summarize the changes made.
  2. Select Create a new branch for this commit and start a pull request.
  3. Check the Propose file change button.
  4. Scroll down to compare changes with the original document.
  5. Select Create pull request.

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
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].