From 1d8fb9633fbeb88cc22ce8ba38573897e53327b2 Mon Sep 17 00:00:00 2001 From: Shane Kerr Date: Wed, 20 Dec 2023 11:29:50 +0100 Subject: [PATCH 1/5] Correct versions in the setup.py file --- README.md | 31 ++++++++++++++++--------------- setup.py | 8 +++++--- 2 files changed, 21 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 3b6a52e..c161154 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,20 @@ NS1 Python SDK ============== -> This project is in [active development](https://github.com/ns1/community/blob/master/project_status/ACTIVE_DEVELOPMENT.md). +> This project is in [maintenance development](https://github.com/ns1/community/blob/master/project_status/MAINTENANCE.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 +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. +Python 3.8+ are supported. Automated tests are currently run against +3.8, 3.9, 3.10, 3.11, and 3.12. Installation ============ @@ -31,7 +31,7 @@ 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+) +* [twisted](https://twistedmatrix.com/) (asynchronous) Other transports are easy to add, see [transport](https://github.com/ns1/ns1-python/tree/master/ns1/rest/transport) @@ -56,11 +56,10 @@ 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`). +Unit tests use `pytest` (`pip install pytest`). -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. +Tests should, of course, run and pass. We use tox to automate test +runs and virtualenv setup, see `tox.ini` for config. Contributions ============= @@ -70,20 +69,22 @@ 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. +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. +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: +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 diff --git a/setup.py b/setup.py index 6693063..b4dd714 100644 --- a/setup.py +++ b/setup.py @@ -40,10 +40,12 @@ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", - "Programming Language :: Python :: 2", - "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Internet :: Name Service (DNS)", ], From 6079fd8351c4a1c3cb3fa4b523664694eee6f817 Mon Sep 17 00:00:00 2001 From: Shane Kerr Date: Wed, 20 Dec 2023 11:33:30 +0100 Subject: [PATCH 2/5] Fix versions in the API documentation --- doc/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index 0eb4a87..90addbc 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -13,7 +13,7 @@ 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. +Python 3.8 to 3.12 are supported. Install with:: From 8c768a498d4f9b66fe35e85675e3346b10fc0481 Mon Sep 17 00:00:00 2001 From: Shane Kerr Date: Wed, 20 Dec 2023 11:51:26 +0100 Subject: [PATCH 3/5] Minor text fix --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c161154..7f94e1f 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ 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. -Python 3.8+ are supported. Automated tests are currently run against -3.8, 3.9, 3.10, 3.11, and 3.12. +Python version 3.8+ are supported. Automated tests are currently run +against 3.8, 3.9, 3.10, 3.11, and 3.12. Installation ============ From 3cd9fb31c53c8186ef61172a109d73480633ee2f Mon Sep 17 00:00:00 2001 From: Shane Kerr Date: Wed, 20 Dec 2023 11:52:02 +0100 Subject: [PATCH 4/5] Fix pluralization --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f94e1f..958d9aa 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ 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. -Python version 3.8+ are supported. Automated tests are currently run +Python versions 3.8+ are supported. Automated tests are currently run against 3.8, 3.9, 3.10, 3.11, and 3.12. Installation From 14059292a5bb77d474eec951049f75b0d6df01de Mon Sep 17 00:00:00 2001 From: Shane Kerr Date: Wed, 20 Dec 2023 12:05:27 +0100 Subject: [PATCH 5/5] Text tweak in documentation --- doc/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index 90addbc..68214f1 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -13,7 +13,7 @@ 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. -Python 3.8 to 3.12 are supported. +Python versions 3.8 to 3.12 are supported. Install with::