[](https://travis-ci.org/ns1/ns1-python) [](https://ns1-python.readthedocs.io/en/latest/)
NS1 Python SDK
==============
> This project is in [active development](https://github.com/ns1/community/blob/master/project_status/ACTIVE_DEVELOPMENT.md).
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](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.
### 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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ns1/ns1-python",
"name": "ns1-python",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "dns development rest sdk ns1 nsone",
"author": "NS1 Developers",
"author_email": "devteam@ns1.com",
"download_url": "https://files.pythonhosted.org/packages/a0/e1/0b34ffbfc36eb35530bad7dbce739a479cc5fb763042d6185e6a6865c947/ns1-python-0.19.0.tar.gz",
"platform": null,
"description": "[](https://travis-ci.org/ns1/ns1-python) [](https://ns1-python.readthedocs.io/en/latest/)\n\nNS1 Python SDK\n==============\n\n> This project is in [active development](https://github.com/ns1/community/blob/master/project_status/ACTIVE_DEVELOPMENT.md).\n\nA Python SDK for accessing NS1, the Data Driven DNS platform.\n\nAbout\n=====\n\nThis package provides a python SDK for accessing the NS1 DNS platform\nand includes both a simple NS1 REST API wrapper as well as a higher level\ninterface for managing zones, records, data feeds, and more.\nIt supports synchronous and asynchronous transports.\n\nBoth python 2.7 and 3.3+ are supported. Automated tests are currently run\nagainst 2.7, 3.7, 3.8, 3.9 and 3.10.\n\nInstallation\n============\n\n $ pip install ns1-python\n\nDependencies\n============\n\nNone, but supports different transport backends. Currently supported:\n\n* [requests](http://docs.python-requests.org/en/latest/) (synchronous, the\n default if available)\n* urllib (synchronous, the default if requests isn't available)\n* [twisted](https://twistedmatrix.com/) (asynchronous, requires 2.7 or 3.5+)\n\nOther transports are easy to add, see\n[transport](https://github.com/ns1/ns1-python/tree/master/ns1/rest/transport)\n\nExamples\n========\n\nSee the [examples directory](https://github.com/ns1/ns1-python/tree/master/examples)\n\nDocumentation\n=============\n\nIf you don't yet have an NS1 account, [signup here (free)](https://ns1.com/signup/)\n\nYou'll need an API Key. To create one, login to [the portal](https://my.nsone.net/)\nand click on the Account button in the top right. Select Settings & Users, then\nadd a new API Key at the bottom.\n\n* [Documentation at ReadTheDocs](https://ns1-python.readthedocs.org/en/latest/)\n* [NS1 REST API Documentation](https://ns1.com/api/)\n\nTests\n=====\n\nUnit tests use `pytest` (`pip install pytest`). 2.7 also requires `mock` to be\ninstalled (`pip install mock`).\n\nTests should, of course, run and pass under python 2 and 3. We use tox to\nautomate test runs and virtualenv setup, see `tox.ini` for config.\n\nContributions\n=============\nPull Requests and issues are welcome. See the\n[NS1 Contribution Guidelines](https://github.com/ns1/community) for more\ninformation.\n\n### Editing the docs\n\nYou can create or edit NS1-python documentation by downloading the repo onto your machine and using an editor such as VSCode.\n\n### Creating Pull Requests\n\n1. When you're ready to submit your changes, add a descriptive title and comments to summarize the changes made.\n2. Select **Create a new branch for this commit and start a pull request**.\n3. Check the **Propose file change** button.\n4. Scroll down to compare changes with the original document.\n5. Select **Create pull request**.\n\nOur CI process will lint and check for formatting issues with `flake8` and\n`black`.\nIt is suggested to run these checks prior to submitting a pull request and fix\nany issues:\n```\npip install flake8 black\nflake8 . --count --show-source --statistics --extend-ignore=E501\nblack . --check -l 79 --diff\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python SDK for the NS1 DNS platform",
"version": "0.19.0",
"project_urls": {
"Homepage": "https://github.com/ns1/ns1-python"
},
"split_keywords": [
"dns",
"development",
"rest",
"sdk",
"ns1",
"nsone"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2dc3e46bffad5e53b11c81c2b34931ed44ddce8f1e7dab2df9c7ade4ed5bd784",
"md5": "70440d8953c5cfc3b7cbaa359466adfb",
"sha256": "b7043a2347b89ddf50fa30e52fa0a7d13810b028033d531111f39b9907702a8d"
},
"downloads": -1,
"filename": "ns1_python-0.19.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "70440d8953c5cfc3b7cbaa359466adfb",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 49984,
"upload_time": "2024-02-14T18:50:43",
"upload_time_iso_8601": "2024-02-14T18:50:43.950708Z",
"url": "https://files.pythonhosted.org/packages/2d/c3/e46bffad5e53b11c81c2b34931ed44ddce8f1e7dab2df9c7ade4ed5bd784/ns1_python-0.19.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0e10b34ffbfc36eb35530bad7dbce739a479cc5fb763042d6185e6a6865c947",
"md5": "8c92b8757d72bad5ee7d0ba0a5046030",
"sha256": "bbd6a7d5d6f6324dfb882d883c94a313573193d5783fb373dda8244e82a40153"
},
"downloads": -1,
"filename": "ns1-python-0.19.0.tar.gz",
"has_sig": false,
"md5_digest": "8c92b8757d72bad5ee7d0ba0a5046030",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 35250,
"upload_time": "2024-02-14T18:50:45",
"upload_time_iso_8601": "2024-02-14T18:50:45.440366Z",
"url": "https://files.pythonhosted.org/packages/a0/e1/0b34ffbfc36eb35530bad7dbce739a479cc5fb763042d6185e6a6865c947/ns1-python-0.19.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-14 18:50:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ns1",
"github_project": "ns1-python",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "ns1-python"
}
JSON
