Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/erikboesen/yalebuildings

Python wrapper for the Yale Buildings API
https://github.com/erikboesen/yalebuildings

Last synced: about 1 month ago
JSON representation

Python wrapper for the Yale Buildings API

Awesome Lists containing this project

README

        

# yalebuildings [![PyPI version](https://badge.fury.io/py/yalebuildings.svg)](https://badge.fury.io/py/yalebuildings)

> Python library for interfacing with the Yale Buildings API.

[API documentation](https://developers.yale.edu/buildings)

## Setup
First, install the module:

```sh
pip3 install yalebuildings
```

Then, to use these functions, you must import the module:

```py
import yalebuildings
```

Before using the library, you must instantiate its class, for example:

```py
buildings = yalebuildings.YaleBuildings('your API key here')
```

You can obtain your API key as described [here](https://developers.yale.edu/how-info/how-do-i-get-access-apis).

## Retrieval Functions
- TODO

See `example.py` for several usage examples.

## Author
[Erik Boesen](https://github.com/ErikBoesen)

## License
[GPL](LICENSE)