https://github.com/ngzhian/pycrunchbase

python bindings to crunchbase
https://github.com/ngzhian/pycrunchbase

Last synced: 2 days ago
JSON representation

python bindings to crunchbase

• Host: GitHub
• URL: https://github.com/ngzhian/pycrunchbase
• Owner: ngzhian
• License: mit
• Created: 2015-02-11T03:39:14.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-07-03T13:27:06.000Z (over 1 year ago)
• Last Synced: 2024-12-26T03:07:20.025Z (10 days ago)
• Language: Python
• Size: 191 KB
• Stars: 65
• Watchers: 8
• Forks: 36
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

        
===============================

pycrunchbase

===============================

| |docs| |travis| |coveralls| |version|

.. |docs| image:: https://readthedocs.org/projects/pycrunchbase/badge/?style=flat

    :target: https://readthedocs.org/projects/pycrunchbase/

    :alt: Documentation Status

.. |travis| image:: http://img.shields.io/travis/ngzhian/pycrunchbase/master.png?style=flat

    :alt: Travis-CI Build Status

    :target: https://travis-ci.org/ngzhian/pycrunchbase

.. |coveralls| image:: https://coveralls.io/repos/github/ngzhian/pycrunchbase/badge.svg?branch=master

    :alt: Coveralls coverage

    :target: https://coveralls.io/github/ngzhian/pycrunchbase?branch=master

.. |version| image:: http://img.shields.io/pypi/v/pycrunchbase.png?style=flat

    :alt: PyPI Package latest release

    :target: https://pypi.python.org/pypi/pycrunchbase

Python bindings to CrunchBase

Starting from v0.3.0, pycrunchbase has support for CrunchBase API version 3,

but things are still flaky,

so any kind of bug reports is greatly appreciated,

for detail see notes below.

Note: I currently do not need to use this library, so it's feature-complete for me.

Bug reports are welcome, and pull requests for features are still accepted.

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 Investment

And printing that gives us the name of the investor, and the amount

invested in USD

::

    print(str(an_investor))  # prints: Investment: [Organization: Name]

Installation

============

::

    pip install pycrunchbase

Documentation

=============

https://readthedocs.org/projects/pycrunchbase/

Development

===========

To run the all tests run::

    tox

Contributions are always welcome! Visit pycrunchbase's `Homepage `

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.

Upgrading versions

==================

Change the version number in:

- setup.py

- src/pycrunchbase/__init__.py

Add an entry to CHANGELOG.rst.

::

  # build dist

  # https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives

  python3 setup.py sdist bdist_wheel

  # upload

  # https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives

  python3 -m twine upload --repository pycrunchbase dist/*

Contributors

============

Thanks to these contributors:

* `dustinfarris `_

Goals

=====

1. Support all (or almost all) of CrunchBase's API functionalities

2. Speedy updates when CrunchBase's API changes

3. 'Pythonic' bindings, user doesn't feel like we're requesting URLs

Notes on CrunchBase version 3 changes

=====================================

In version 3, CrunchBase changed the names of some endpoints, e.g person -> people, and they

have gone with the plural form of all entities. pycrunchbase does not adhere strictly to that.

For example, there is still a `person` method, but a `people` method is also provided

so that it remains backwards compatible and also supports methods that matches the name

of the entity.

License

=======

MIT