Skip to content

Latest commit

 

History

History
94 lines (59 loc) · 2.24 KB

README.rst

File metadata and controls

94 lines (59 loc) · 2.24 KB

Python API for Angellist

http://img.shields.io/pypi/v/angel.svg?style=flat http://jenkins.jarenglover.com/job/angel-list/badge/icon http://img.shields.io/pypi/dm/angel.svg?style=flat

Angel is an MIT Licensed Python library to access API of Angellist. It currently supports Python 2.7 and in development. It does not use any external libraries and has extensive test coverage.

Example

from angel import angel

al = angel.AngelList(CLIENT_ID, CLIENT_SECRET, ACCESS_TOKEN)

first_page_jobs = al.get_jobs(page=1)

Some capabilities of module are here.

Features

  1. No external dependencies
  2. Consistent Api for different features of Angellist - NOTE: All requests will need to be authenticated with access token
  3. Test coverage

Installation

To install angel, simply use pip:

$ pip install angel

Documentation

Contribute

  1. Fork the repository on GitHub from the master branch.
  2. Create a branch in the following format username-feature.
  3. Write the test for the bug fix or feature.
  4. Send a pull request.

Known Issues

  1. put and delete methods are not implemented.
  2. scope of investing is not implemented
  3. It does not support Python 3.
  4. Your personal access token needs to be approved for the jobs endpoint - i.e. added to the "approved list"
  5. My token hasn't been approved for the job endpoint yet, thus I don't run those test in my jenkins build.

Test

  1. Create a config.py file under the angel directory.
  2. Put your credentials in the following way.
  3. Run the test.py under the test directory.
  4. Make sure that all tests are green.

CLIENT_ID =

CLIENT_SECRET =

ACCESS_TOKEN =

MY_NAME =

TWITTER_URL =

ONLINE_BIO_URL =

LINKEDIN_URL =

GITHUB_URL =

EMAIL =

ANGELLIST_URL =

ID =