Metadata-Version: 2.1
Name: winterapi
Version: 1.4.1
Author-email: Robert Stein <rdstein@caltech.edu>
License: MIT
Project-URL: Homepage, https://github.com/winter-telescope/winterapi
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: packaging
Requires-Dist: keyring
Requires-Dist: cryptography
Requires-Dist: pre-commit
Requires-Dist: jupyter
Requires-Dist: backoff
Requires-Dist: pydantic
Requires-Dist: wintertoo >=1.6.2
Provides-Extra: dev
Requires-Dist: black ==24.4.2 ; extra == 'dev'
Requires-Dist: isort ==5.13.2 ; extra == 'dev'
Requires-Dist: pylint ==3.2.2 ; extra == 'dev'
Requires-Dist: coveralls ; extra == 'dev'

# winterapi
API interactions for WINTER

[![Coverage Status](https://coveralls.io/repos/github/winter-telescope/winterapi/badge.svg?branch=tests)](https://coveralls.io/github/winter-telescope/winterapi?branch=tests)
[![CI](https://github.com/winter-telescope/winterapi/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/winter-telescope/winterapi/actions/workflows/continuous_integration.yml) 
[![PyPI version](https://badge.fury.io/py/winterapi.svg)](https://badge.fury.io/py/winterapi)

## Installation

We advise you to install the package in a virtual environment or conda environment.
You will need python 3.10 or later to use this package.

### Install from pypi
```bash
pip install winterapi
```

### Install from source
```bash
git clone git@github.com:winter-telescope/winterapi.git
cd winterapi
pip install --editable ".[dev]"
pre-commit install
```

## Updating the package

You will need to occasionally update the package to get the latest features and bug fixes. 
Sometimes the server will require a newer version of the package to interact with it, 
and you will receive a warning when using winterapi.
You can update by running the following command:

### Updating for pypi
```bash
pip install --upgrade winterapi
```

or 

### Updating from source
```bash
cd winterapi
git pull
pip install --editable ".[dev]"
pre-commit install
```

## Using winterapi

You can find example usage under `notebooks/` directory in this repository.
The notebooks are numbered, and walk you through setting up credentials,
triggering a ToO, checking on the status of a ToO, and downloading images after
observations are complete.

## Problems?

The first port of call if you have any problems is to download the latest
version of the package. You might even get a warning when using the package that your
version is out of date. If you are still having problems after updating, 
you could also try re-entering your credentials. 

If you are still having problems, please open a Github Issue and we will
try to help you as soon as possible.
