diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a3bae14 --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +__pycache__/ +*.py[cod] + +bin/ +build/ +develop-eggs/ +dist/ +eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg +.eggs/ + +venv/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3e693fc --- /dev/null +++ b/LICENSE @@ -0,0 +1,178 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS +Copyright 2020 Tucows Inc. diff --git a/README b/README new file mode 100644 index 0000000..9ca4518 --- /dev/null +++ b/README @@ -0,0 +1,4 @@ +This client library for Peering-Manager is based off of `pynetbox` (https://github.com/digitalocean/pynetbox) +and can be used in a similar manner. + +Peering-Manager's models can be reached through the `peering` attribute of the API object. diff --git a/pypeeringmanager/__init__.py b/pypeeringmanager/__init__.py new file mode 100644 index 0000000..d334509 --- /dev/null +++ b/pypeeringmanager/__init__.py @@ -0,0 +1,9 @@ +from pkg_resources import get_distribution, DistributionNotFound + +from pynetbox.core.query import RequestError, AllocationError, ContentError +from pypeeringmanager.core.api import Api as api + +try: + __version__ = get_distribution(__name__).version +except DistributionNotFound: + pass diff --git a/pypeeringmanager/core/__init__.py b/pypeeringmanager/core/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/pypeeringmanager/core/api.py b/pypeeringmanager/core/api.py new file mode 100644 index 0000000..cd8f413 --- /dev/null +++ b/pypeeringmanager/core/api.py @@ -0,0 +1,57 @@ +import requests + +from pynetbox.core.api import Api as PyNetboxApi +from pypeeringmanager.core.app import App + +class Api(PyNetboxApi): + """The API object is the point of entry to pypeeringmanager. + After instantiating the Api() with the appropriate named arguments + you can specify which app and endpoint you wish to interact with. + There is only one app available, peering. + Calling any of these attributes will return + :py:class:`.App` which exposes endpoints as attributes. + **Additional Attributes**: + * **http_session(requests.Session)**: + Override the default session with your own. This is used to control + a number of HTTP behaviors such as SSL verification, custom headers, + retires, and timeouts. + See `custom sessions `__ for more info. + :param str url: The base URL to the instance of Peering-Manager you + wish to connect to. + :param str token: Your Peering-Manager token. + :param bool,optional threading: Set to True to use threading in ``.all()`` + and ``.filter()`` requests. + :raises AttributeError: If app doesn't exist. + :Examples: + >>> import pypeeringmanager + >>> pm = pypeeringmanager.api( + ... 'http://localhost:8000', + ... token='d6f4e314a5b5fefd164995169f28ae32d987704f' + ... ) + >>> pm.peering.internet_exchange_peering_sessions.all() + """ + + def __init__( + self, url, token=None, threading=False, + ): + base_url = "{}/api".format(url if url[-1] != "/" else url[:-1]) + self.token = token + self.private_key = None + self.private_key_file = None + self.base_url = base_url + self.session_key = None + self.http_session = requests.Session() + if threading and sys.version_info.major == 2: + raise NotImplementedError( + "Threaded pypeeringmanager calls not supported in Python 2" + ) + self.threading = threading + + self.peering = App(self, "peering") + + @property + def version(self): + raise NotImplementedError + + def openapi(self): + raise NotImplementedError diff --git a/pypeeringmanager/core/app.py b/pypeeringmanager/core/app.py new file mode 100644 index 0000000..c71e672 --- /dev/null +++ b/pypeeringmanager/core/app.py @@ -0,0 +1,14 @@ +from pynetbox.core.app import App as PyNetboxApp +from pypeeringmanager.models import peering + +class App(PyNetboxApp): + """ Represents apps in Peering-Manager. + Calls to attributes are returned as Endpoint objects. + :returns: :py:class:`.Endpoint` matching requested attribute. + :raises: :py:class:`.RequestError` + if requested endpoint doesn't exist. + """ + + models = { + "peering": peering, + } diff --git a/pypeeringmanager/models/__init__.py b/pypeeringmanager/models/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/pypeeringmanager/models/peering.py b/pypeeringmanager/models/peering.py new file mode 100644 index 0000000..1b1a96f --- /dev/null +++ b/pypeeringmanager/models/peering.py @@ -0,0 +1,49 @@ +from pynetbox.core.response import Record + + +class Routers(Record): + pass + + +class RoutingPolicies(Record): + pass + + +class Communities(Record): + pass + + +class AutonomousSystems(Record): + import_routing_policies = RoutingPolicies + export_routing_policies = RoutingPolicies + + +class BGPGroups(Record): + import_routing_policies = RoutingPolicies + export_routing_policies = RoutingPolicies + communities = Communities + + +class InternetExchanges(Record): + import_routing_policies = RoutingPolicies + export_routing_policies = RoutingPolicies + communities = Communities + + +class DirectPeeringSessions(Record): + autonomous_system = AutonomousSystems + bgp_group = BGPGroups + import_routing_policies = RoutingPolicies + export_routing_policies = RoutingPolicies + router = Routers + + def __str__(self): + return self.ip_address + + +class InternetExchangePeeringSessions(Record): + autonomous_system = AutonomousSystems + internet_exchange = InternetExchanges + + def __str__(self): + return self.ip_address diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..59e7b95 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +pynetbox==6.1.3 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..d0e90e0 --- /dev/null +++ b/setup.py @@ -0,0 +1,25 @@ +from setuptools import setup, find_packages + +setup( + name="pypeeringmanager", + description="Peering-Manager API client library", + url="https://github.com/vista-/pypeeringmanager", + author="vista", + author_email="vista@birb.network", + license="Apache2", + include_package_data=True, + use_scm_version=True, + setup_requires=["setuptools_scm"], + packages=find_packages(), + install_requires=["pynetbox==6.1.3", "requests>=2.20.0,<3.0"], + zip_safe=False, + keywords=["peering-manager", "peeringmanager"], + classifiers=[ + "Intended Audience :: Developers", + "Development Status :: 3 - Alpha", + "Programming Language :: Python :: 2", + "Programming Language :: Python :: 2.7", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.6", + ], +)