https://github.com/erikboesen/yaleorgdirectory

Python wrapper for the Yale OrgDirectory API
https://github.com/erikboesen/yaleorgdirectory

Last synced: about 1 month ago
JSON representation

Python wrapper for the Yale OrgDirectory API

• Host: GitHub
• URL: https://github.com/erikboesen/yaleorgdirectory
• Owner: ErikBoesen
• License: gpl-3.0
• Created: 2019-06-27T14:04:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-06-29T02:42:12.000Z (over 5 years ago)
• Last Synced: 2024-10-06T12:06:32.761Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 19.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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

> Python library for interfacing with the Yale OrgDirectory API.

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

## Setup

First, install the module:

```sh

pip3 install yaleorgdirectory

```

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

```py

import yaleorgdirectory

```

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

```py

orgdirectory = yaleorgdirectory.YaleOrgDirectory('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)