sparclclient 1.2.0b3.dev6__tar.gz → 1.2.1__tar.gz

sparclclient-1.2.1/.github/workflows/django.yml

@@ -0,0 +1,30 @@
+name: Django CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Run Tests
+      run: |
+        python manage.py test

sparclclient-1.2.1/.gitignore

@@ -0,0 +1,131 @@
+OBSOLETE_*/
+
+# 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/
+pip-wheel-metadata/
+share/python-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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

sparclclient-1.2.1/.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+# See: https://pre-commit.com/
+# Run:
+#   pre-commit run --all-files
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+    -   id: flake8
+        exclude: ^source|^tests/expected.py

sparclclient-1.2.1/.readthedocs.yaml

@@ -0,0 +1,46 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+####### How to test Readthedocs documentation locally?
+###
+### Install Sphinx.
+# pip install sphinx
+#
+### Build your docs: (with venv active)
+#
+# cd ~/sandbox/sparclclient
+# make html
+#
+## Open the html file in your browser, for example:
+# file:///home/myusername/sandbox/sparclclient/build/html/index.html
+
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+formats:
+   - pdf
+   - epub
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: requirements.txt
+
+#   - requirements: docs/requirements.txt

sparclclient-1.2.1/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+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)

sparclclient-1.2.1/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.1
+Name: sparclclient
+Version: 1.2.1
+Summary: A client for getting spectra and meta-data from NOIRLab.
+Author-email: "S. Pothier" <datalab-spectro@noirlab.edu>
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Project-URL: Bug Tracker, https://github.com/pypa/sparclclient/issues
+Project-URL: Documentation, https://sparclclient.readthedocs.io/en/latest/
+Project-URL: Homepage, https://github.com/pypa/sparclclient
+
+# sparclclient
+Python Client for SPARCL (SPectra Analysis and Retrievable Catalog Lab)
+

sparclclient-1.2.1/README.md

@@ -0,0 +1,2 @@
+# sparclclient
+Python Client for SPARCL (SPectra Analysis and Retrievable Catalog Lab)

sparclclient-1.2.1/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

sparclclient-1.2.1/pyproject.toml

@@ -0,0 +1,48 @@
+# See:
+#   FLIT: https://flit.pypa.io/en/latest/pyproject_toml.html
+#   TOML format: https://toml.io/en/
+
+#
+# Updating PyPi:
+#   source venv/bin/activate
+#   flit build
+#   flit publish
+
+
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+
+[project]
+name = "sparclclient"
+authors = [
+  { name="S. Pothier", email="datalab-spectro@noirlab.edu" },
+]
+readme = "README.md"
+license = {file = "LICENSE"}
+classifiers = ["License :: OSI Approved :: MIT License"]
+dynamic = ["version", "description"]
+
+[project.urls]
+"Homepage" = "https://github.com/pypa/sparclclient"
+"Bug Tracker" = "https://github.com/pypa/sparclclient/issues"
+"Documentation" = "https://sparclclient.readthedocs.io/en/latest/"
+
+[tool.flit.module]
+name = "sparcl"
+
+[tool.black]
+# https://black.readthedocs.io/en/stable/usage_and_configuration/index.html
+line-length = 79
+target-version = ['py37']
+include = '\.pyi?$'
+# 'extend-exclude' excludes files or directories in addition to the defaults
+extend-exclude = '''
+# A regex preceded with ^/ will apply only to files and directories
+# in the root of the project.
+(
+  ^/foo.py    # exclude a file named foo.py in the root of the project
+  | .*_pb2.py  # exclude autogenerated Protocol Buffer files anywhere in the project
+)
+'''

sparclclient-1.2.1/requirements-client.txt

@@ -0,0 +1,3 @@
+requests==2.31.0 # 2.26.0
+numpy
+spectres

sparclclient-1.2.1/requirements-internal.txt

@@ -0,0 +1,22 @@
+#
+#psutil==5.8.0  # for benchmarks
+#! speedtest # for benchmarks
+# packaging   # for noaodatalab
+#specutils==1.3.1
+# jupyter-lab --ip=0.0.0.0
+# jupyterlab # =3.1.17
+#matplotlib==3.4.3
+#!sparclclient==0.3.9
+
+Sphinx # ==4.1.2
+sphinx-rtd-theme # ==0.5.2
+pre-commit
+pip
+flit
+sphinx_mdinclude
+
+#
+pandas
+matplotlib
+ipympl
+astropy

sparclclient-1.2.1/requirements.txt

@@ -0,0 +1,2 @@
+-r requirements-client.txt
+-r requirements-internal.txt

sparclclient-1.2.1/source/conf.py

@@ -0,0 +1,91 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+
+# 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 re
+import sys
+from sparcl import __version__
+
+sys.path.insert(0, os.path.abspath(".."))
+
+# -- Project information -----------------------------------------------------
+
+project = "SPARCL"
+copyright = "2022, S.Pothier, A.Jacques"
+author = "S.Pothier, A.Jacques"
+
+#!version = client_version
+sver = __version__
+mo = re.match(
+    "^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$",
+    sver,
+)
+release = sver
+version = mo.group("major") + "." + mo.group("minor")
+# The full version, including alpha/beta/rc tags
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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",
+    "sphinx.ext.doctest",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx_mdinclude",
+]
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# 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 = "y"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["../sparcl/benchmarks/"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+autosummary_generate = True
+
+# -- 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 = 'alabaster'
+html_theme = "sphinx_rtd_theme"
+
+# 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"]
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

sparclclient-1.2.1/source/index.rst

@@ -0,0 +1,27 @@
+Welcome to SPARCL's documentation!
+==================================
+
+This documents the Python Client for SPARCL
+(*SPectra Analysis and Retrievable Catalog Lab*)
+
+| Last change: |today|
+| Version: |version|
+| Release: |release|
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Contents:
+
+   sparcl
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+
+License
+=======
+
+.. mdinclude:: ../LICENSE

sparclclient-1.2.1/source/sparcl.rst

@@ -0,0 +1,26 @@
+sparcl package
+==============
+
+
+sparcl.client module
+--------------------
+
+.. automodule:: sparcl.client
+   :members:
+   :show-inheritance:
+
+
+sparcl.exceptions module
+------------------------
+
+.. automodule:: sparcl.exceptions
+   :members:
+   :show-inheritance:
+
+sparcl.Results module
+---------------------
+
+.. automodule:: sparcl.Results
+   :members:
+   :inherited-members:
+   :show-inheritance: