Python bindings to CrunchBase
Project description
Python bindings to CrunchBase
Examples
# initialize the API using your API Key, will throw ValueError if missing cb = CrunchBase(API_KEY) # look up an organization by name github = cb.organization('github') # the response contains snippets of data regarding relationships # that the organization has, an example is the funding_rounds funding_rounds_summary = github.funding_rounds # all relationships are paged, and only 8 is returned initially # to get more data do this, it handles paging for you # and returns a False-y value if there are no more pages more_funding_rounds = cb.more(funding_rounds_summary) # data in relations are just summaries, and you probably want more details # For example funding_rounds returns 5 values: type, name, path # created_at, updated_at. # If you actually want to know who invested, you have to get to make # more API calls # first get the uuid of the round round_uuid = funding_rounds_summary[0].uuid # then use the CrunchBase API to make that call round = cb.funding_round(round_uuid) # again, investments is a relationship on a FundingRound, # so we can get the first item in that relationship an_investor = round.investments[0] # a InvestorInvestmentPageItem # and printing that gives us the name of the investor, and the amount # invested in USD print(str(an_investor)) # prints: Investor Name $100000
Installation
pip install pycrunchbase
Documentation
Development
To run the all tests run:
tox
Contributions are always welcome!
Use GitHub issues to report a bug or send feedback.
The best way to send feedback is to file an issue at https://github.com/ngzhian/pycrunchbase/issues.
Goals
Support all (or almost all) of CrunchBase’s API functionalities
Speedy updates when CrunchBase’s API changes
‘Pythonic’ bindings, user doesn’t feel like we’re requesting URLs
TODO
Support other nodes (IPO, FundRaise)
Coerce values in relationships page item to python types (datetime)
helper methods to grab node details from a list of PageItem that are nodes
License
MIT
Changelog
0.2.1 (2015-02-21)
Fix __version__
0.2.0 (2015-02-15)
The API is now considered relatively stabled. Updated the classifier to reflect so
Change to how CrunchBase.more reacts to a Relationship, we no longer optimize when the Relationship has all items, just call first_page_url
0.1.9 (2015-02-15)
Add series to the FundingRound node.
0.1.8 (2015-02-15)
Update __str__ for nodes and relationships
0.1.7 (2015-02-15)
Relationship is now a subclass of Page, although this strictly isn’t true. The benefit is that this allows us to reuse a lot of logic. Relationship can be thought of as Page 0, which is a summary of potentially multiple pages of PageItem. The only time we get a relationship is when we query for a particular Node, e.g. organiation, and we grab the relationships returned by the API. After this, to get more details we call Crunchbase.more, and this returns us a Page.
Added __repr__ methods to all the Node, Relationship, PageItem. Previously we only defined __str__, but these didn’t show up in places like the REPL. This fixes that. We try to make it obvious what object it is based on what is printed, but also don’t want to be too verbose.
0.1.6 (2015-02-15)
InvestorInvestmentPageItem now has the possibility of being either a investor, or a invested_in relationship
Propogates any exception when making the actual HTTP call to CrunchBase
0.1.5 (2015-02-13)
Add a cb_url attribute for all PageItem, this url is a CrunchBase page (not the API) that holds more information for a particular PageItem Allows you to make calls like:
company.funding_rounds[0].cb_url
to get the url of the page for the first funding round of company.
A new page item, InvestorInvestmentPageItem, that is useful for FundingRound info:
round = cb.funding_round('round_uuid') an_investor = round.investments[0] # a InvestorInvestmentPageItem print(str(an_investor)) # prints: Investor Name $100000
Add simplified Contribution guidelines in README
0.1.4 (2015-02-13)
Relationship retrieval is 0-based now, 1-based just doesn’t fit well with array
Better __str__ for Node and Relationship
Relationship.get(i) if i is too large or small will return a NonePageItem singleton
0.1.3 (2015-02-12)
Fix Relationship: wasn’t using the right build method of PageItem
Add test to checkk for the above
remove unused reference to CrunchBase in Relationship
0.1.2 (2015-02-12)
PageItem and it’s subclasses to represent an item within a relationship of a Node
Cleanup of where utility methods live (parse_date)
More tests as always, overall 98.21% coverage
0.1.0 (2015-02-21)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pycrunchbase-0.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a29d16223d404bdfaa24b1c0e8a8c00b00a775c427a00c5ef6d2b5b107471c5 |
|
MD5 | 7036ef60d107793f2c762e27854282fd |
|
BLAKE2b-256 | a903da9b968687bdfa7a33f2ba5eb2d891f3e5aea1f5599dd17fa742870d7998 |