pyixapi 0.2.1__tar.gz → 0.2.3__tar.gz

{pyixapi-0.2.1/pyixapi.egg-info → pyixapi-0.2.3}/PKG-INFO

@@ -1,21 +1,22 @@
 Metadata-Version: 2.1
 Name: pyixapi
-Version: 0.2.1
-Summary: IX-API client library
-Home-page: https://github.com/peering-manager/pyixapi
+Version: 0.2.3
+Summary: Python API client library for IX-API
+License: Apache-2.0
 Author: Guillaume Mazoyer
 Author-email: oss@mazoyer.eu
-License: Apache2
-Keywords: ix-api,internet-exchange,peering
+Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers
-Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: PyJWT (>=2.4.0,<2.9)
+Requires-Dist: requests (>=2.20.0,<3.0)
 Description-Content-Type: text/markdown
-License-File: LICENSE
 
 # pyixapi
 
@@ -30,8 +31,6 @@ Supported versions are:
 
 To install run `pip install pyixapi`.
 
-Alternatively, you can clone the repo and run `python setup.py install`.
-
 ## Quick Start
 
 To begin, import pyixapi and instantiate the API.
@@ -77,3 +76,4 @@ DXDB:PAS:00008
 ```
 
 Write queries are not implemented yet.
+

{pyixapi-0.2.1 → pyixapi-0.2.3}/README.md

@@ -11,8 +11,6 @@ Supported versions are:
 
 To install run `pip install pyixapi`.
 
-Alternatively, you can clone the repo and run `python setup.py install`.
-
 ## Quick Start
 
 To begin, import pyixapi and instantiate the API.

pyixapi-0.2.3/pyixapi/__init__.py

@@ -0,0 +1,5 @@
+from .core.api import API as api
+from .core.api import __version__  # noqa: F401
+from .core.query import ContentError, RequestError
+
+__all__ = ("api", "ContentError", "RequestError")

{pyixapi-0.2.1 → pyixapi-0.2.3}/pyixapi/core/api.py

@@ -29,7 +29,7 @@ from pyixapi.models import (
     RoleAssignment,
 )
 
-__version__ = "0.2.1"
+__version__ = "0.2.2"
 
 
 class API(object):

{pyixapi-0.2.1 → pyixapi-0.2.3}/pyixapi/core/endpoint.py

@@ -62,7 +62,9 @@ class Endpoint(object):
             try:
                 next(response)
                 raise ValueError(
-                    "get() returned more than one result. Check that the kwarg(s) passed are valid for this endpoint or use filter() or all() instead."
+                    "get() returned more than one result. Check that the kwarg(s) "
+                    "passed are valid for this endpoint or use filter() or all() "
+                    "instead."
                 )
             except StopIteration:
                 return value

{pyixapi-0.2.1 → pyixapi-0.2.3}/pyixapi/core/query.py

@@ -19,9 +19,15 @@ class RequestError(Exception):
             )
         else:
             try:
-                self.message = f"The request failed with code {r.status_code} {r.reason}: {r.json()}"
+                self.message = (
+                    f"The request failed with code {r.status_code} "
+                    f"{r.reason}: {r.json()}"
+                )
             except ValueError:
-                self.message = f"The request failed with code {r.status_code} {r.reason} but details were not found as JSON."
+                self.message = (
+                    f"The request failed with code {r.status_code} "
+                    f"{r.reason} but details were not found as JSON."
+                )
 
         super(RequestError, self).__init__(r)
         self.req = r

{pyixapi-0.2.1 → pyixapi-0.2.3}/pyixapi/core/token.py

@@ -1,4 +1,5 @@
-from datetime import datetime
+import warnings
+from datetime import datetime, timezone
 
 import jwt
 
@@ -11,7 +12,7 @@ class InvalidTokenException(Exception):
     pass
 
 
-class Token(object):
+class Token:
     """
     A token is at the core of the authentication mechanism of IX-API.
 
@@ -24,37 +25,43 @@ class Token(object):
     continue using the API.
     """
 
-    def __init__(self, token, issued_at, expires_at):
-        self.encoded = token  # Cache signed token data
-        self.issued_at = issued_at
-        self.expires_at = expires_at
+    def __init__(self, token: str, expires_at: datetime) -> None:
+        self.encoded: str = token  # Cache signed token data
+        self.expires_at: datetime = expires_at
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.encoded
 
-    def __repr__(self):
-        return f"<Token issued_at={self.issued_at} ttl={self.ttl}s>"
+    def __repr__(self) -> str:
+        return f"<Token ttl={self.ttl}s>"
 
     @property
-    def ttl(self):
+    def issued_at(self) -> datetime:
+        warnings.warn(
+            "Property 'issued_at' is deprecated and value will always be set to now.",
+            DeprecationWarning,
+        )
+        return datetime.now(tz=timezone.utc)
+
+    @property
+    def ttl(self) -> int:
         """
         TTL is the number of seconds, from now, before the token expires.
         """
-        seconds = (self.expires_at - datetime.now()).total_seconds()
+        seconds = (self.expires_at - datetime.now(timezone.utc)).total_seconds()
         return max(0, seconds)
 
     @property
-    def is_expired(self):
+    def is_expired(self) -> bool:
         """
         Tell if a token is expired or not (TTL equals to 0).
         """
         return self.ttl == 0
 
     @classmethod
-    def from_jwt(cls, token):
+    def from_jwt(cls, token: str) -> "Token":
         """
-        Create a new token from a JWT, decoding it and caching it issued and
-        expiration times.
+        Create a new token from a JWT, decoding it and caching its expiration time.
 
         :param token: (str) String containing the original encoded token which is the
             result of a POST request to the authentication endpoint.
@@ -65,8 +72,9 @@ class Token(object):
             raise TokenException(e)
 
         try:
-            issued_at = datetime.fromtimestamp(payload["iat"])
-            expires_at = datetime.fromtimestamp(payload["exp"])
-            return cls(token, issued_at, expires_at)
+            return cls(
+                token=token,
+                expires_at=datetime.fromtimestamp(payload["exp"], tz=timezone.utc),
+            )
         except Exception as e:
             raise InvalidTokenException(e)

pyixapi-0.2.3/pyproject.toml

@@ -0,0 +1,78 @@
+[tool.poetry]
+name = "pyixapi"
+version = "0.2.3"
+description = "Python API client library for IX-API"
+authors = ["Guillaume Mazoyer <oss@mazoyer.eu>"]
+readme = "README.md"
+license = "Apache-2.0"
+packages = [{ include = "pyixapi" }]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+PyJWT = ">=2.4.0,<2.9"
+requests = ">=2.20.0,<3.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "*"
+ruff = "~0.2"
+
+[tool.ruff]
+line-length = 88
+
+exclude = [
+    ".git",
+    ".tox",
+    ".venv",
+    "env",
+    "_build",
+    "build",
+    "dist",
+    "examples",
+    "__main__.py",
+]
+
+[tool.ruff.lint]
+preview = true
+
+select = [
+    "C90", # mccabe complexity
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort-like checks
+    "DTZ", # flake8-datetimez
+    "ICN", # flake8-import-conventions
+    "TCH", # flake8-type-checking
+    "T10", # flake8-debugger
+    "Q",   # flake8-quotes
+    "YTT", # flake8-2020
+]
+
+task-tags = ["FIXME", "TODO", "XXX"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.ruff.lint.isort]
+known-first-party = ["pyixapi"]
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 88
+
+[tool.ruff.lint.mccabe]
+max-complexity = 31
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

pyixapi-0.2.1/.github/FUNDING.yml

@@ -1,4 +0,0 @@
----
-github: gmazoyer
-ko_fi: gmazoyer
-custom: https://paypal.me/GuillaumeMazoyer

pyixapi-0.2.1/.github/dependabot.yml

@@ -1,19 +0,0 @@
----
-version: 2
-updates:
-- package-ecosystem: "pip"
-  directory: "/"
-  schedule:
-    interval: "weekly"
-  assignees:
-  - "gmazoyer"
-  labels:
-  - "type: housekeeping"
-- package-ecosystem: "github-actions"
-  directory: "/"
-  schedule:
-    interval: "weekly"
-  assignees:
-  - "gmazoyer"
-  labels:
-  - "type: housekeeping"

pyixapi-0.2.1/.github/workflows/publish.yml

@@ -1,29 +0,0 @@
-# This workflows will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
-
-name: Upload Python Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
-    - name: Build package
-      run: python -m build
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@b7f401de30cb6434a1e19f805ff006643653240e
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}

pyixapi-0.2.1/.github/workflows/tests.yml

@@ -1,26 +0,0 @@
-name: Run Tests
-
-on:
-  pull_request: {}
-  push:
-    branches:
-    - main
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python: ["3.8", "3.9", "3.10", "3.11"]
-    steps:
-    - uses: actions/checkout@v3
-    - name: Setup Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python }}
-    - name: Install dev requirements
-      run: pip install -r requirements-dev.txt .
-    - name: Run Linter
-      run: black --diff --check pyixapi tests
-    - name: Run Tests
-      run: pytest

pyixapi-0.2.1/.gitignore

@@ -1,102 +0,0 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib64/
-lib/
-parts/
-sdist/
-var/
-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-.hypothesis/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# pyenv
-.python-version
-
-# celery beat schedule file
-celerybeat-schedule
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-
-# Visual Studio Code settings
-.vscode/

pyixapi-0.2.1/PKG-INFO

@@ -1,79 +0,0 @@
-Metadata-Version: 2.1
-Name: pyixapi
-Version: 0.2.1
-Summary: IX-API client library
-Home-page: https://github.com/peering-manager/pyixapi
-Author: Guillaume Mazoyer
-Author-email: oss@mazoyer.eu
-License: Apache2
-Keywords: ix-api,internet-exchange,peering
-Classifier: Intended Audience :: Developers
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# pyixapi
-
-Python API client library for [IX-API](https://ix-api.net/).
-
-Supported versions are:
-
-* [version 1](https://docs.ix-api.net/v1/)
-* [version 2](https://docs.ix-api.net/v2/)
-
-## Installation
-
-To install run `pip install pyixapi`.
-
-Alternatively, you can clone the repo and run `python setup.py install`.
-
-## Quick Start
-
-To begin, import pyixapi and instantiate the API.
-
-```python
-import pyixapi
-ixapi = pyixapi.api(
-    "https://api.de-cix.net/api/v1/",
-    "3LH3G72VH7H1SGogEsFeQOPsGjOQotMUZQRt2pK7YbH",
-    "cEtrt8s0vR0CsG0vpAmcaxtnolzZj7DEG0B7izvwPlV",
-)
-ixapi.authenticate()
-```
-
-The first argument the `.api()` method takes is the IX-API URL. The second and
-third arguments are the API key and secret used for authentication.
-
-Authenticating will generate a pair of access and refresh tokens that can be
-passed as argument to the `.api()` method.
-
-
-## Queries
-
-The pyixapi API is setup so that IX-API's endpoints are attributes of the
-`.api()` object. Each endpoint has a handful of methods available to carry out
-actions on the endpoint. For example, in order to query all the objects in the
-`network-service-configs` endpoint you would do the following:
-
-```python
->>> nsc = ixapi.network_service_configs.all()
->>> for i in nsc:
-...     print(i)
-...
-DXDB:PAS:00001
-DXDB:PAS:00002
-DXDB:PAS:00003
-DXDB:PAS:00004
-DXDB:PAS:00005
-DXDB:PAS:00006
-DXDB:PAS:00007
-DXDB:PAS:00008
->>>
-```
-
-Write queries are not implemented yet.

pyixapi-0.2.1/docs/Makefile

@@ -1,17 +0,0 @@
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = pyixapi
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pyixapi-0.2.1/docs/advanced.rst

@@ -1,74 +0,0 @@
-Custom Sessions
-===============
-
-Custom sessions can be used to modify the default HTTP behavior. Below are a few examples, most of them from `here <https://hodovi.ch/blog/advanced-usage-python-requests-timeouts-retries-hooks/>`_.
-
-Headers
-*******
-
-To set a custom header on all requests. These headers are automatically merged with headers pyixapi sets itself.
-
-:Example:
-
->>> import pyixapi
->>> import requests
->>> session = requests.Session()
->>> session.headers = {"mycustomheader": "test"}
->>> ixapi = pyixapi.api(
-...     "https://api.de-cix.net/api/v1/",
-...     "3LH3G72VH7H1SGogEsFeQOPsGjOQotMUZQRt2pK7YbH",
-...     "cEtrt8s0vR0CsG0vpAmcaxtnolzZj7DEG0B7izvwPlV",
-... )
->>> ixapi.http_session = session
-
-
-SSL Verification
-****************
-
-To disable SSL verification. See `the docs <https://requests.readthedocs.io/en/stable/user/advanced/#ssl-cert-verification>`_.
-
-:Example:
-
->>> import pyixapi
->>> import requests
->>> session = requests.Session()
->>> session.verify = False
->>> ixapi = pyixapi.api(
-...     "https://api.de-cix.net/api/v1/",
-...     "3LH3G72VH7H1SGogEsFeQOPsGjOQotMUZQRt2pK7YbH",
-...     "cEtrt8s0vR0CsG0vpAmcaxtnolzZj7DEG0B7izvwPlV",
-... )
->>> ixapi.http_session = session
-
-
-Timeouts
-********
-
-Setting timeouts requires the use of Adapters.
-
-:Example:
-
-.. code-block:: python
-
-    from requests.adapters import HTTPAdapter
-
-    class TimeoutHTTPAdapter(HTTPAdapter):
-        def __init__(self, *args, **kwargs):
-            self.timeout = kwargs.get("timeout", 5)
-            super().__init__(*args, **kwargs)
-
-        def send(self, request, **kwargs):
-            kwargs['timeout'] = self.timeout
-            return super().send(request, **kwargs)
-
-    adapter = TimeoutHTTPAdapter()
-    session = requests.Session()
-    session.mount("http://", adapter)
-    session.mount("https://", adapter)
-
-    ixapi = pyixapi.api(
-        "https://api.de-cix.net/api/v1/",
-        "3LH3G72VH7H1SGogEsFeQOPsGjOQotMUZQRt2pK7YbH",
-        "cEtrt8s0vR0CsG0vpAmcaxtnolzZj7DEG0B7izvwPlV",
-    )
-    ixapi.http_session = session

pyixapi-0.2.1/docs/conf.py

@@ -1,158 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# pyixapi documentation build configuration file, created by
-# sphinx-quickstart on Sun Sep 18 18:31:27 2022.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-import os
-import sys
-
-from pkg_resources import get_distribution
-
-sys.path.insert(0, os.path.abspath("../"))
-
-
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = ["sphinx.ext.autodoc"]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
-source_suffix = ".rst"
-
-# The master toctree document.
-master_doc = "index"
-
-# General information about the project.
-project = "pyixapi"
-copyright = "2012, Guillaume Mazoyer"
-author = "Guillaume Mazoyer"
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-# The full version, including alpha/beta/rc tags.
-release = get_distribution("pyixapi").version
-#
-# The short X.Y version.
-version = ".".join(release.split(".")[:2])
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = None
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-# html_theme = 'classic'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
-
-html_sidebars = {
-    "**": ["globaltoc.html", "relations.html", "sourcelink.html", "searchbox.html"]
-}
-
-# -- Options for HTMLHelp output ------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "pyixapidoc"
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, "pyixapi.tex", "pyixapi Documentation", "Guillaume Mazoyer", "manual"),
-]
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "pyixapi", "pyixapi Documentation", [author], 1)]
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (
-        master_doc,
-        "pyixapi",
-        "pyixapi Documentation",
-        author,
-        "pyixapi",
-        "A python library for IX-API.",
-        "Miscellaneous",
-    ),
-]

pyixapi-0.2.1/docs/endpoint.rst

@@ -1,5 +0,0 @@
-Endpoint
-========
-
-.. autoclass:: pyixapi.core.endpoint.Endpoint
-  :members:

pyixapi-0.2.1/docs/index.rst

@@ -1,29 +0,0 @@
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-   endpoint
-   response
-   request
-   IPAM
-
-TL;DR
-=====
-Instantiate the :py:class:`.Api`. Use the methods available on :py:class:`.Endpoint` to return :py:class:`.Record` objects. 
-
-API
-===
-
-.. autoclass:: pyixapi.core.api.Api
-  :members:
-
-App
-===
-
-.. autoclass:: pyixapi.core.app.App
-  :members:
-
-Indices and tables
-==================
-
-* :ref:`genindex`

pyixapi-0.2.1/docs/request.rst

@@ -1,8 +0,0 @@
-Request
-========
-
-.. autoclass:: pyixapi.core.query.RequestError
-  :members:
-
-.. autoclass:: pyixapi.core.query.ContentError
-  :members:

pyixapi-0.2.1/docs/response.rst

@@ -1,8 +0,0 @@
-Response
-========
-
-.. autoclass:: pyixapi.core.response.Record
-  :members:
-
-.. autoclass:: pyixapi.core.response.RecordSet
-  :members:

pyixapi-0.2.1/pyixapi/__init__.py

@@ -1,11 +0,0 @@
-from pkg_resources import DistributionNotFound, get_distribution
-
-from pyixapi.core.api import API as api
-from pyixapi.core.query import ContentError, RequestError
-
-try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
-    pass
-
-__all__ = ("api", "ContentError", "RequestError")

pyixapi-0.2.1/pyixapi.egg-info/SOURCES.txt

@@ -1,38 +0,0 @@
-.gitignore
-LICENSE
-README.md
-pyproject.toml
-requirements-dev.txt
-requirements.txt
-setup.py
-.github/FUNDING.yml
-.github/dependabot.yml
-.github/workflows/publish.yml
-.github/workflows/tests.yml
-docs/Makefile
-docs/advanced.rst
-docs/conf.py
-docs/endpoint.rst
-docs/index.rst
-docs/request.rst
-docs/response.rst
-pyixapi/__init__.py
-pyixapi/models.py
-pyixapi.egg-info/PKG-INFO
-pyixapi.egg-info/SOURCES.txt
-pyixapi.egg-info/dependency_links.txt
-pyixapi.egg-info/not-zip-safe
-pyixapi.egg-info/requires.txt
-pyixapi.egg-info/top_level.txt
-pyixapi/core/__init__.py
-pyixapi/core/api.py
-pyixapi/core/endpoint.py
-pyixapi/core/query.py
-pyixapi/core/response.py
-pyixapi/core/token.py
-pyixapi/core/util.py
-tests/__init__.py
-tests/test_api.py
-tests/util.py
-tests/fixtures/api/authenticate.json
-tests/fixtures/api/refresh_authentication.json

pyixapi-0.2.1/pyixapi.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

pyixapi-0.2.1/pyixapi.egg-info/not-zip-safe

@@ -1 +0,0 @@
-

pyixapi-0.2.1/pyixapi.egg-info/requires.txt

@@ -1,2 +0,0 @@
-requests<3.0,>=2.20.0
-PyJWT<2.9,>=2.4.0

pyixapi-0.2.1/pyixapi.egg-info/top_level.txt

@@ -1 +0,0 @@
-pyixapi

pyixapi-0.2.1/pyproject.toml

@@ -1,8 +0,0 @@
-# See PEP 518 for the spec of this file
-# https://www.python.org/dev/peps/pep-0518/
-
-[tool.black]
-target_version = ["py38", "py39", "py310", "py311"]
-
-[tool.isort]
-profile = "black"

pyixapi-0.2.1/requirements-dev.txt

@@ -1,2 +0,0 @@
-black~=23.7
-pytest==7.4.*

pyixapi-0.2.1/requirements.txt

@@ -1,2 +0,0 @@
-PyJWT>=2.4.0,<2.9
-requests>=2.20.0,<3.0

pyixapi-0.2.1/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

pyixapi-0.2.1/setup.py

@@ -1,33 +0,0 @@
-from pathlib import Path
-
-from setuptools import find_packages, setup
-
-d = Path(__file__).parent
-long_description = (d / "README.md").read_text()
-
-setup(
-    name="pyixapi",
-    description="IX-API client library",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/peering-manager/pyixapi",
-    author="Guillaume Mazoyer",
-    author_email="oss@mazoyer.eu",
-    license="Apache2",
-    include_package_data=True,
-    use_scm_version=True,
-    setup_requires=["setuptools_scm"],
-    packages=find_packages(exclude=["tests", "tests.*"]),
-    install_requires=["requests>=2.20.0,<3.0", "PyJWT>=2.4.0,<2.9"],
-    zip_safe=False,
-    keywords=["ix-api", "internet-exchange", "peering"],
-    classifiers=[
-        "Intended Audience :: Developers",
-        "Development Status :: 5 - Production/Stable",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-    ],
-)

pyixapi-0.2.1/tests/fixtures/api/authenticate.json

@@ -1,4 +0,0 @@
-{
-    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE2NjM5NjE0MDAsImV4cCI6MTY2Mzk2MjMwMCwiYXVkIjoid3d3LmV4YW1wbGUuY29tIiwic3ViIjoidGVzdEBleGFtcGxlLmNvbSJ9.jPZ4TMh9mFGu2Ebgz-UO3bd5wrAJDyOjJaul1tq0AoI",
-    "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE2NjM5NjE0MDAsImV4cCI6MTY2NDU2NjIwMCwiYXVkIjoid3d3LmV4YW1wbGUuY29tIiwic3ViIjoidGVzdEBleGFtcGxlLmNvbSJ9.NCIzCxKjceLGfHb7ozJ5KsLw0WSlWHXx3dPGx8n8P0Q"
-}

pyixapi-0.2.1/tests/fixtures/api/refresh_authentication.json

@@ -1,4 +0,0 @@
-{
-    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE2NjQwNDc4MDAsImV4cCI6MTY2NDA0ODcwMCwiYXVkIjoid3d3LmV4YW1wbGUuY29tIiwic3ViIjoidGVzdEBleGFtcGxlLmNvbSJ9._PeLD8F8SlVJKZcBAQ7a5ONsFYXWl9Q_UjKJLGS-uAI",
-    "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE2NjQwNDc4MDAsImV4cCI6MTY2NDY1MjYwMCwiYXVkIjoid3d3LmV4YW1wbGUuY29tIiwic3ViIjoidGVzdEBleGFtcGxlLmNvbSJ9.xHKO5CyRQbbLEAvuiuk4srb7px8G-2JScjBy-bVTqsg"
-}

pyixapi-0.2.1/tests/test_api.py

@@ -1,86 +0,0 @@
-import unittest
-from unittest.mock import patch
-
-import pyixapi
-
-from .util import Response
-
-host = "https://api.example.net/v1/"
-
-def_args = (
-    "-GnNlMD8hBuxSSUJmpbfUkss9dyOKfTV1SnZibNyyr4",
-    "XKq8M6NVh5lCbPJ2Ml1h7V93QNIMsGVBfM6g2nRZF-E",
-)
-
-
-class ApiTestCase(unittest.TestCase):
-    @patch(
-        "requests.sessions.Session.post",
-        return_value=Response(fixture="api/authenticate.json"),
-    )
-    def test_authenticate(self, *_):
-        api = pyixapi.api(host, *def_args)
-        r = api.authenticate()
-
-        self.assertIsNotNone(r)
-        self.assertIsNotNone(api.access_token)
-        self.assertIsNotNone(api.refresh_token)
-
-    @patch(
-        "requests.sessions.Session.post",
-        return_value=Response(fixture="api/refresh_authentication.json"),
-    )
-    def test_refresh_authentication(self, *_):
-        api = pyixapi.api(host, *def_args)
-        api.authenticate()
-        r = api.refresh_authentication()
-
-        self.assertIsNotNone(r)
-        self.assertIsNotNone(api.access_token)
-        self.assertIsNotNone(api.refresh_token)
-
-
-class ApiVersionTestCase(unittest.TestCase):
-    class ResponseWithFailure:
-        ok = False
-        status_code = 404
-        url = host
-        text = "Not found"
-
-    class ResponseWithSuccess:
-        ok = True
-
-        def json(self):
-            return {"status": "pass", "version": 2}
-
-    @patch(
-        "requests.sessions.Session.get",
-        return_value=ResponseWithFailure(),
-    )
-    def test_api_version_1(self, *_):
-        api = pyixapi.api(host, *def_args)
-        self.assertEqual(api.version, 1)
-
-    @patch(
-        "requests.sessions.Session.get",
-        return_value=ResponseWithSuccess(),
-    )
-    def test_api_version(self, *_):
-        api = pyixapi.api(host, *def_args)
-        self.assertEqual(api.version, 2)
-
-
-class ApiHealthTestCase(unittest.TestCase):
-    class ResponseWithHealth:
-        ok = True
-
-        def json(self):
-            return {"status": "pass", "version": "2"}
-
-    @patch(
-        "requests.sessions.Session.get",
-        return_value=ResponseWithHealth(),
-    )
-    def test_api_status(self, *_):
-        api = pyixapi.api(host, *def_args)
-        self.assertEqual(api.health()["status"], "pass")

pyixapi-0.2.1/tests/util.py

@@ -1,15 +0,0 @@
-import json
-
-
-class Response(object):
-    def __init__(self, fixture=None, status_code=200, ok=True, content=None):
-        self.status_code = status_code
-        self.content = json.dumps(content) if content else self.load_fixture(fixture)
-        self.ok = ok
-
-    def load_fixture(self, path):
-        with open(f"tests/fixtures/{path}", "r") as f:
-            return f.read()
-
-    def json(self):
-        return json.loads(self.content)