yalies

Python library for interfacing with the Yalies API.

API documentation

Setup

First, install the module:

pip3 install yalies

Then, to use the module, you must import it in your code:

import yalies

Then initialize the API, using a token that you may obtain from the API documentation page:

api = yalies.API('your token')
# Never hardcode tokens. Use a config file or environment variable instead.
# The name 'api' can be whatever is most appropriate for your program.

Retrieval Functions

There is only one public-facing function in the API class:

API.people([query, filters, page, page_size]) allows your program to request a list of people matching certain parameters. You may pass the query parameter, a string, specifying a textual query to search by. Alternatively, or in addition, you may pass filters a dictionary specifying lists of acceptable properties of the people you wish to retrieve data on. page and page_size can be optionally passed to paginate results as one would expect. See example.py for a complete usage example, and the API documentation for more information about request format.

Author

Erik Boesen

License

MIT