astro-otter 0.0.1__tar.gz → 0.1.0__tar.gz

astro_otter-0.1.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.1
+Name: astro-otter
+Version: 0.1.0
+Author-email: Noah Franz <nfranz@arizona.edu>
+License: MIT License
+        
+        Copyright (c) 2023 Noah Franz
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Home, https://github.com/astro-otter
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Topic :: Scientific/Engineering
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Development Status :: 2 - Pre-Alpha
+Requires-Python: <3.12,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2,>=1.20
+Requires-Dist: astropy>=6
+Requires-Dist: pandas
+Requires-Dist: synphot
+Requires-Dist: typing-extensions
+Requires-Dist: matplotlib
+Requires-Dist: plotly
+Requires-Dist: astroquery
+Requires-Dist: ads
+Requires-Dist: skypatrol
+Requires-Dist: fundamentals
+Requires-Dist: astro-datalab
+Requires-Dist: sparclclient
+Requires-Dist: astro-ghost
+Requires-Dist: pyreadline3; platform_system == "Windows"
+Provides-Extra: docs
+Requires-Dist: Sphinx>=3.0.0; extra == "docs"
+Requires-Dist: myst-parser>=0.13; extra == "docs"
+Requires-Dist: nbsphinx>=0.9.1; extra == "docs"
+Requires-Dist: sphinx-book-theme>=0.0.33; extra == "docs"
+Requires-Dist: sphinx_copybutton; extra == "docs"
+Requires-Dist: autodoc; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+
+# OTTER API
+### **O**pen mul**T**iwavelength **T**ransient **E**vent **R**epository
+
+A Python API for the OTTER.
+
+[actions-badge]:            https://github.com/astro-otter/otter/workflows/CI/badge.svg
+[actions-link]:             https://github.com/astro-otter/otter/actions
+[black-badge]:              https://img.shields.io/badge/code%20style-black-000000.svg
+[black-link]:               https://github.com/psf/black
+[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/hepfile
+[conda-link]:               https://github.com/conda-forge/hepfile-feedstock
+[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
+[github-discussions-link]:  https://github.com/mattbellis/hepfile/discussions
+[gitter-badge]:             https://badges.gitter.im/https://github.com/mattbellis/hepfile/community.svg
+[gitter-link]:              https://gitter.im/https://github.com/mattbellis/hepfile/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
+[pypi-link]:                https://pypi.org/project/astro-otter/
+[pypi-platforms]:           https://img.shields.io/pypi/pyversions/astro-otter
+[pypi-version]:             https://badge.fury.io/py/astro-otter.svg
+[rtd-badge]:                https://readthedocs.org/projects/otter/badge/?version=latest
+[rtd-link]:                 https://otter.readthedocs.io/en/latest/?badge=latest
+[sk-badge]:                 https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
+[ruff-badge]:               https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json
+[ruff-link]:                https://github.com/astral-sh/ruff
+[codecov-badge]:            https://codecov.io/gh/astro-otter/otter/graph/badge.svg?token=BtCerOdTc0
+[codecov-link]:             https://codecov.io/gh/astro-otter/otter
+
+[![Documentation Status](https://readthedocs.org/projects/astro-otter/badge/?version=latest)](https://astro-otter.readthedocs.io/en/latest/?badge=latest)
+[![Actions Status][actions-badge]][actions-link]
+[![PyPI version][pypi-version]][pypi-link]
+[![Linting: Ruff][ruff-badge]][ruff-link]
+[![codecov][codecov-badge]][codecov-link]
+
+## Installation
+To install the OTTER API use
+```
+python3 -m pip install astro-otter
+```
+
+## Installation from Source
+To install the OTTER API from the source code use
+```
+git clone https://github.com/astro-otter/otter.git
+cd otter
+python -m pip install .
+```
+This will be changed into the more convenient `python -m pip install astro-otter` at a later date!
+
+For developers, please also enable the pre-commit hooks using
+```
+pre-commit install
+```
+
+## Repo Organization
+| Directory | Contents |
+|------------|------------|
+| `src/otter` | A pip installable API for interfacing with the OTTER database|
+| `scripts` | The pipeline scripts for converting unprocessed data into the OTTER JSON format|
+| `docs` | Documentation for the OTTER API |
+| `test` | Some Unit tests for the source code |

astro_otter-0.1.0/README.md

@@ -0,0 +1,59 @@
+# OTTER API
+### **O**pen mul**T**iwavelength **T**ransient **E**vent **R**epository
+
+A Python API for the OTTER.
+
+[actions-badge]:            https://github.com/astro-otter/otter/workflows/CI/badge.svg
+[actions-link]:             https://github.com/astro-otter/otter/actions
+[black-badge]:              https://img.shields.io/badge/code%20style-black-000000.svg
+[black-link]:               https://github.com/psf/black
+[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/hepfile
+[conda-link]:               https://github.com/conda-forge/hepfile-feedstock
+[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
+[github-discussions-link]:  https://github.com/mattbellis/hepfile/discussions
+[gitter-badge]:             https://badges.gitter.im/https://github.com/mattbellis/hepfile/community.svg
+[gitter-link]:              https://gitter.im/https://github.com/mattbellis/hepfile/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
+[pypi-link]:                https://pypi.org/project/astro-otter/
+[pypi-platforms]:           https://img.shields.io/pypi/pyversions/astro-otter
+[pypi-version]:             https://badge.fury.io/py/astro-otter.svg
+[rtd-badge]:                https://readthedocs.org/projects/otter/badge/?version=latest
+[rtd-link]:                 https://otter.readthedocs.io/en/latest/?badge=latest
+[sk-badge]:                 https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
+[ruff-badge]:               https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json
+[ruff-link]:                https://github.com/astral-sh/ruff
+[codecov-badge]:            https://codecov.io/gh/astro-otter/otter/graph/badge.svg?token=BtCerOdTc0
+[codecov-link]:             https://codecov.io/gh/astro-otter/otter
+
+[![Documentation Status](https://readthedocs.org/projects/astro-otter/badge/?version=latest)](https://astro-otter.readthedocs.io/en/latest/?badge=latest)
+[![Actions Status][actions-badge]][actions-link]
+[![PyPI version][pypi-version]][pypi-link]
+[![Linting: Ruff][ruff-badge]][ruff-link]
+[![codecov][codecov-badge]][codecov-link]
+
+## Installation
+To install the OTTER API use
+```
+python3 -m pip install astro-otter
+```
+
+## Installation from Source
+To install the OTTER API from the source code use
+```
+git clone https://github.com/astro-otter/otter.git
+cd otter
+python -m pip install .
+```
+This will be changed into the more convenient `python -m pip install astro-otter` at a later date!
+
+For developers, please also enable the pre-commit hooks using
+```
+pre-commit install
+```
+
+## Repo Organization
+| Directory | Contents |
+|------------|------------|
+| `src/otter` | A pip installable API for interfacing with the OTTER database|
+| `scripts` | The pipeline scripts for converting unprocessed data into the OTTER JSON format|
+| `docs` | Documentation for the OTTER API |
+| `test` | Some Unit tests for the source code |

{astro_otter-0.0.1 → astro_otter-0.1.0}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ['setuptools>=42']
+requires = ['setuptools>=64']
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -9,7 +9,7 @@ readme = "README.md"
 license = {file = "LICENSE"}
 dynamic = ["version"]
 
-requires-python = ">=3.9"
+requires-python = ">=3.10,<3.12"
 
 classifiers = [
   "License :: OSI Approved :: BSD License",
@@ -20,7 +20,6 @@ classifiers = [
   "License :: OSI Approved :: BSD License",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Development Status :: 2 - Pre-Alpha"
@@ -28,23 +27,50 @@ classifiers = [
 
 dependencies = [
   # necessary dependencies for the src code
-  "numpy>=1.20",
-  "astropy>=5.2",
+  "numpy>=1.20,<2",
+  "astropy>=6",
   "pandas",
+  "synphot",
+  "typing-extensions",
+
+  # for the plotting
   "matplotlib",
   "plotly",
+
+  # for the DataFinder query tool
   "astroquery",
-  "synphot",
   "ads",
-
-  # useful dev tools
-  "ruff", # linter
-  "pre-commit" # enable pre-commit hooks
-  ]
+  "skypatrol",
+  "fundamentals",
+  "astro-datalab",
+  "sparclclient",
+  "astro-ghost",
+
+  # only for windows OS b/c it doesn't ship with readline by default
+  'pyreadline3; platform_system == "Windows"'
+]
 
 [project.urls]
 Home = "https://github.com/astro-otter"
 
+[project.optional-dependencies]
+# tools for building the readthedocs page
+docs = [
+  "Sphinx>=3.0.0",
+  "myst-parser>=0.13",
+  "nbsphinx>=0.9.1",
+  "sphinx-book-theme>=0.0.33",
+  "sphinx_copybutton",
+  "autodoc",
+  "ipykernel"
+]
+
+# useful tools for developers
+dev = [
+  "ruff", # linter
+  "pre-commit", # enable pre-commit hooks
+]
+
 [tool.setuptools.packages.find]
 where = ['src']
 

astro_otter-0.1.0/src/astro_otter.egg-info/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.1
+Name: astro-otter
+Version: 0.1.0
+Author-email: Noah Franz <nfranz@arizona.edu>
+License: MIT License
+        
+        Copyright (c) 2023 Noah Franz
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Home, https://github.com/astro-otter
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Topic :: Scientific/Engineering
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Development Status :: 2 - Pre-Alpha
+Requires-Python: <3.12,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2,>=1.20
+Requires-Dist: astropy>=6
+Requires-Dist: pandas
+Requires-Dist: synphot
+Requires-Dist: typing-extensions
+Requires-Dist: matplotlib
+Requires-Dist: plotly
+Requires-Dist: astroquery
+Requires-Dist: ads
+Requires-Dist: skypatrol
+Requires-Dist: fundamentals
+Requires-Dist: astro-datalab
+Requires-Dist: sparclclient
+Requires-Dist: astro-ghost
+Requires-Dist: pyreadline3; platform_system == "Windows"
+Provides-Extra: docs
+Requires-Dist: Sphinx>=3.0.0; extra == "docs"
+Requires-Dist: myst-parser>=0.13; extra == "docs"
+Requires-Dist: nbsphinx>=0.9.1; extra == "docs"
+Requires-Dist: sphinx-book-theme>=0.0.33; extra == "docs"
+Requires-Dist: sphinx_copybutton; extra == "docs"
+Requires-Dist: autodoc; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+
+# OTTER API
+### **O**pen mul**T**iwavelength **T**ransient **E**vent **R**epository
+
+A Python API for the OTTER.
+
+[actions-badge]:            https://github.com/astro-otter/otter/workflows/CI/badge.svg
+[actions-link]:             https://github.com/astro-otter/otter/actions
+[black-badge]:              https://img.shields.io/badge/code%20style-black-000000.svg
+[black-link]:               https://github.com/psf/black
+[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/hepfile
+[conda-link]:               https://github.com/conda-forge/hepfile-feedstock
+[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
+[github-discussions-link]:  https://github.com/mattbellis/hepfile/discussions
+[gitter-badge]:             https://badges.gitter.im/https://github.com/mattbellis/hepfile/community.svg
+[gitter-link]:              https://gitter.im/https://github.com/mattbellis/hepfile/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
+[pypi-link]:                https://pypi.org/project/astro-otter/
+[pypi-platforms]:           https://img.shields.io/pypi/pyversions/astro-otter
+[pypi-version]:             https://badge.fury.io/py/astro-otter.svg
+[rtd-badge]:                https://readthedocs.org/projects/otter/badge/?version=latest
+[rtd-link]:                 https://otter.readthedocs.io/en/latest/?badge=latest
+[sk-badge]:                 https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
+[ruff-badge]:               https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json
+[ruff-link]:                https://github.com/astral-sh/ruff
+[codecov-badge]:            https://codecov.io/gh/astro-otter/otter/graph/badge.svg?token=BtCerOdTc0
+[codecov-link]:             https://codecov.io/gh/astro-otter/otter
+
+[![Documentation Status](https://readthedocs.org/projects/astro-otter/badge/?version=latest)](https://astro-otter.readthedocs.io/en/latest/?badge=latest)
+[![Actions Status][actions-badge]][actions-link]
+[![PyPI version][pypi-version]][pypi-link]
+[![Linting: Ruff][ruff-badge]][ruff-link]
+[![codecov][codecov-badge]][codecov-link]
+
+## Installation
+To install the OTTER API use
+```
+python3 -m pip install astro-otter
+```
+
+## Installation from Source
+To install the OTTER API from the source code use
+```
+git clone https://github.com/astro-otter/otter.git
+cd otter
+python -m pip install .
+```
+This will be changed into the more convenient `python -m pip install astro-otter` at a later date!
+
+For developers, please also enable the pre-commit hooks using
+```
+pre-commit install
+```
+
+## Repo Organization
+| Directory | Contents |
+|------------|------------|
+| `src/otter` | A pip installable API for interfacing with the OTTER database|
+| `scripts` | The pipeline scripts for converting unprocessed data into the OTTER JSON format|
+| `docs` | Documentation for the OTTER API |
+| `test` | Some Unit tests for the source code |

{astro_otter-0.0.1 → astro_otter-0.1.0}/src/astro_otter.egg-info/SOURCES.txt

@@ -11,10 +11,17 @@ src/otter/_version.py
 src/otter/exceptions.py
 src/otter/util.py
 src/otter/io/__init__.py
+src/otter/io/data_finder.py
+src/otter/io/host.py
 src/otter/io/otter.py
 src/otter/io/transient.py
 src/otter/plotter/__init__.py
 src/otter/plotter/otter_plotter.py
 src/otter/plotter/plotter.py
+tests/test_data_finder.py
+tests/test_exceptions.py
+tests/test_host.py
+tests/test_otter.py
 tests/test_package.py
-tests/test_transient.py
+tests/test_transient.py
+tests/test_util.py

astro_otter-0.1.0/src/astro_otter.egg-info/requires.txt

@@ -0,0 +1,30 @@
+numpy<2,>=1.20
+astropy>=6
+pandas
+synphot
+typing-extensions
+matplotlib
+plotly
+astroquery
+ads
+skypatrol
+fundamentals
+astro-datalab
+sparclclient
+astro-ghost
+
+[:platform_system == "Windows"]
+pyreadline3
+
+[dev]
+ruff
+pre-commit
+
+[docs]
+Sphinx>=3.0.0
+myst-parser>=0.13
+nbsphinx>=0.9.1
+sphinx-book-theme>=0.0.33
+sphinx_copybutton
+autodoc
+ipykernel

{astro_otter-0.0.1 → astro_otter-0.1.0}/src/otter/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 # get the version
 from ._version import __version__
 
@@ -8,5 +10,7 @@ __package__ = "otter"
 # import important stuff
 from .io.otter import Otter
 from .io.transient import Transient
+from .io.host import Host
+from .io.data_finder import DataFinder
 from .plotter.otter_plotter import OtterPlotter
 from .plotter.plotter import plot_light_curve, plot_sed

{astro_otter-0.0.1 → astro_otter-0.1.0}/src/otter/_version.py

@@ -2,4 +2,4 @@
 Just define the package version in one place
 """
 
-__version__ = "0.0.1"
+__version__ = "0.1.0"

astro_otter-0.1.0/src/otter/exceptions.py

@@ -0,0 +1,74 @@
+"""
+Custom exceptions for otter
+"""
+
+from __future__ import annotations
+
+
+class FailedQueryError(ValueError):
+    """
+    Exception thrown when the users query does not return any results.
+    """
+
+    def __str__(self):
+        txt = "You're query/search did not return any results! "
+        txt += "Try again with different parameters!"
+        return txt
+
+
+class IOError(ValueError):
+    """
+    Exception thrown when the input or output argument/value is not the correct type.
+    """
+
+    pass
+
+
+class OtterLimitationError(Exception):
+    """
+    Exception thrown when the user requests something that is currently not supported
+    by the API.
+    """
+
+    def __init__(self, msg):
+        self.msg = "Current Limitation Found: " + msg
+
+    def __str__(self):
+        return self.msg
+
+
+class TransientMergeError(Exception):
+    """
+    Exception thrown when the Transient objects can not be combined as expected.
+    """
+
+    pass
+
+
+class OtterNotImplementedError(Exception):
+    """
+    Exception thrown by methods that are not yet implemented
+    """
+
+    def __str__(self):
+        return "Not yet implemented! Please consider contributing on our GitHub!"
+
+
+class MissingEnvVarError(Exception):
+    """
+    Thrown when the querying code expects an Environment variable and doesn't get one
+    """
+
+    def __init__(self, v, url=None):
+        self.v = v
+        self.url = url
+
+    def __str__(self):
+        msg = "You are missing the following environment variables:\n"
+        for vv in self.v:
+            msg += f"\t- {vv}\n"
+        msg += "Please make an account and/or set these variables!\n"
+        if self.url is not None:
+            msg += f"See: {self.url}"
+
+        return msg