adc-streaming 0.0.0__tar.gz

adc-streaming-0.0.0/.github/workflows/build.yml

@@ -0,0 +1,31 @@
+name: build
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - name: Check out the code
+      uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Check that the package is pip-installable
+      run: |
+        python -m pip install --upgrade pip
+        pip install --upgrade setuptools setuptools_scm wheel
+        pip install .[dev]
+
+    - name: Lint
+      run: make lint
+
+    - name: Test
+      run: make test

adc-streaming-0.0.0/.gitignore

@@ -0,0 +1,107 @@
+DEADJOE
+*~
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# 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/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

adc-streaming-0.0.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Mario Juric
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

adc-streaming-0.0.0/Makefile

@@ -0,0 +1,70 @@
+.PHONY: help
+help :
+	@echo
+	@echo 'Commands:'
+	@echo
+	@echo '  make test                  run tests'
+	@echo '  make test-quick            run tests, but not integration tests'
+	@echo '  make lint                  run linter'
+	@echo '  make format                run code formatter'
+	@echo '  make doc                   make documentation'
+	@echo '  make changelog             update changelog based on version'
+	@echo '  make pypi-dist             make binary and source packages for PyPI'
+	@echo '  make pypi-dist-check       verify binary and source packages for PyPI'
+	@echo '  make pypi-upload           upload to PyPI'
+	@echo '  make conda-build           make binary and source packages for conda-forge'
+	@echo '  make conda-upload          upload to conda-forge'
+	@echo
+
+VERSION ?= $(shell python setup.py --version)
+REPO_URL = https://github.com/astronomy-commons/adc-streaming
+
+.PHONY: test
+test :
+	python -m pytest -v
+
+.PHONY: test-quick
+test-quick :
+	python -m pytest -v --without-integration
+
+.PHONY: lint
+lint :
+# stop the build if there are Python syntax errors or undefined names
+	flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+# exit-zero treats all errors as warnings
+	flake8 . --count --exit-zero --max-complexity=10 --max-line-length=100 --statistics
+
+.PHONY: format
+format :
+	autopep8 --recursive --in-place .
+	isort
+
+.PHONY: doc
+doc :
+	cd doc && make html
+
+.PHONY: changelog
+changelog :
+	sed -i 's@## \[Unreleased]@## \[Unreleased]\n\n## \[$(VERSION)] - $(shell date +'%Y-%m-%d')@' CHANGELOG.md
+	sed -i 's@.*\[Unreleased]:.*@\[Unreleased]: $(REPO_URL)/compare/v$(VERSION)...HEAD\n[$(VERSION)]: $(REPO_URL)/releases/tag/v$(VERSION)@' CHANGELOG.md
+
+
+.PHONY: pypi-dist
+pypi-dist :
+	python setup.py sdist bdist_wheel
+
+.PHONY: pypi-dist-check
+pypi-dist-check:
+	twine check dist/*
+
+.PHONY: pypi-upload
+pypi-upload:
+	twine upload dist/*
+
+.PHONY: conda-build
+conda-build:
+	conda build -c defaults -c conda-forge ./recipe
+
+.PHONY: conda-upload
+conda-upload:
+	anaconda upload $(shell conda build ./recipe --output)

adc-streaming-0.0.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.1
+Name: adc-streaming
+Version: 0.0.0
+Summary: Astronomy Data Commons streaming client libraries
+Home-page: https://github.com/astronomy-commons/adc-streaming
+Author: Astronomy Data Commons Team
+Author-email: swnelson@uw.edu
+License: BSD
+Description: # Astronomy Data Commons Streaming Client Libraries
+        
+        Libraries making it easy to access astronomy data commons resources.
+        
+        ## Developer notes
+        
+        ### Setup
+        
+        To prepare for development, run `pip install --editable ".[dev]"` from within
+        the repo directory. This will install all dependencies, including those using
+        during development workflows.
+        
+        This project expects you to use a `pip`-centric workflow for development on the
+        project itself. If you're using conda, then use the conda environment's `pip` to
+        install development dependencies, as described above.
+        
+        Integration tests require Docker to run a Kafka broker. The broker might have
+        network problems on OSX if you use Docker Desktop; run the tests in a Linux
+        virtual machine (like with VirtualBox) to get around this.
+        
+        ### Code Workflow
+        
+        Write code, making changes.
+        
+        Use `make format` to reformat your code to comply with PEP8.
+        
+        Use `make lint` to catch common mistakes.
+        
+        Use `make test-quick` to run fast unit tests.
+        
+        Use `make test` to run the full slow test suite, including integration tests.
+        
+        Once satisfied with all four of those, push your changes and open a PR.
+        
+        ### Tag, build, and upload to PyPI and Conda
+        
+        Tag a new version:
+        ```
+        git tag -s -a v0.x.x
+        ```
+        
+        Build and release:
+        
+        ```
+        make pypi-dist
+        make pypi-dist-check
+        make pypi-upload
+        make conda-build
+        make conda-upload
+        ```
+        
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Description-Content-Type: text/markdown
+Provides-Extra: dev

adc-streaming-0.0.0/README.md

@@ -0,0 +1,50 @@
+# Astronomy Data Commons Streaming Client Libraries
+
+Libraries making it easy to access astronomy data commons resources.
+
+## Developer notes
+
+### Setup
+
+To prepare for development, run `pip install --editable ".[dev]"` from within
+the repo directory. This will install all dependencies, including those using
+during development workflows.
+
+This project expects you to use a `pip`-centric workflow for development on the
+project itself. If you're using conda, then use the conda environment's `pip` to
+install development dependencies, as described above.
+
+Integration tests require Docker to run a Kafka broker. The broker might have
+network problems on OSX if you use Docker Desktop; run the tests in a Linux
+virtual machine (like with VirtualBox) to get around this.
+
+### Code Workflow
+
+Write code, making changes.
+
+Use `make format` to reformat your code to comply with PEP8.
+
+Use `make lint` to catch common mistakes.
+
+Use `make test-quick` to run fast unit tests.
+
+Use `make test` to run the full slow test suite, including integration tests.
+
+Once satisfied with all four of those, push your changes and open a PR.
+
+### Tag, build, and upload to PyPI and Conda
+
+Tag a new version:
+```
+git tag -s -a v0.x.x
+```
+
+Build and release:
+
+```
+make pypi-dist
+make pypi-dist-check
+make pypi-upload
+make conda-build
+make conda-upload
+```

adc-streaming-0.0.0/adc/__init__.py

@@ -0,0 +1,11 @@
+try:
+    from importlib.metadata import PackageNotFoundError, version
+except ImportError:
+    # NOTE: remove after dropping support for Python < 3.8
+    from importlib_metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("adc-streaming")
+except PackageNotFoundError:
+    # package is not installed
+    pass

adc-streaming-0.0.0/adc/auth.py

@@ -0,0 +1,87 @@
+#!/usr/bin/env python
+
+from enum import Enum
+
+import certifi
+
+
+class SASLMethod(Enum):
+    """SASL method to use for authentication.
+    """
+
+    PLAIN = 1
+    SCRAM_SHA_256 = 2
+    SCRAM_SHA_512 = 3
+    OAUTHBEARER = 4
+
+    def __str__(self):
+        return self.name.replace("_", "-")
+
+
+class SASLAuth(object):
+    """Attach SASL-based authentication to a client.
+
+    Returns client-based auth options when called.
+
+    Parameters
+    ----------
+    user : `str`
+        Username to authenticate with.
+    password : `str`
+        Password to authenticate with.
+    ssl : `bool`, optional
+        Whether to enable SSL (enabled by default).
+    method : `SASLMethod`, optional
+        The SASL method to authenticate. The default is SASLMethod.OAUTHBEARER
+        if token_endpoint is provided, or SASLMethod.PLAIN otherwise.
+        See valid SASL methods in SASLMethod.
+    ssl_ca_location : `str`, optional
+        If using SSL via a self-signed cert, a path/location
+        to the certificate.
+    ssl_endpoint_identification_algorithm : `str`, optional
+        If using SSL, the algorithm used to verify that certificate is valid for the endpoint.
+    token_endpoint : `str`, optional
+        The OpenID Connect token endpoint URL.
+        Required for OAUTHBEARER / OpenID Connect, otherwise ignored.
+
+    """
+
+    def __init__(self, user, password, ssl=True, method=None, token_endpoint=None, **kwargs):
+        if method is None:
+            if token_endpoint is None:
+                method = SASLMethod.PLAIN
+            else:
+                method = SASLMethod.OAUTHBEARER
+        self._method = method
+
+        # set up SSL options
+        if ssl:
+            if "ssl_ca_location" in kwargs:
+                ssl_cert = kwargs["ssl_ca_location"]
+            else:
+                ssl_cert = certifi.where()
+
+            self._config = {
+                "security.protocol": "SASL_SSL",
+                "ssl.ca.location": ssl_cert,
+                "https.ca.location": ssl_cert,
+            }
+            if "ssl_endpoint_identification_algorithm" in kwargs:
+                self._config["ssl.endpoint.identification.algorithm"] = \
+                    kwargs["ssl_endpoint_identification_algorithm"]
+        else:
+            self._config = {"security.protocol": "SASL_PLAINTEXT"}
+
+        # set up SASL options
+        self._config["sasl.mechanism"] = str(self._method)
+        if token_endpoint:
+            self._config["sasl.oauthbearer.client.id"] = user
+            self._config["sasl.oauthbearer.client.secret"] = password
+            self._config["sasl.oauthbearer.method"] = "oidc"
+            self._config["sasl.oauthbearer.token.endpoint.url"] = token_endpoint
+        else:
+            self._config["sasl.username"] = user
+            self._config["sasl.password"] = password
+
+    def __call__(self):
+        return self._config