TheNounProjectAPI 1.0.5

Python The Noun Project API Wrapper.

TheNounProjectAPI

TheNounProjectAPI is a Python wrapper allowing convenient access to the Noun Project API. It supports all endpoints and types of responses. Documentation for this wrapper can be found here, while the official documentation of the API itself may be found here.

---

Installation

TheNounProjectAPI is supported on Python 3.7+. The recommended method of installation is via pip.

pip install TheNounProjectAPI

You can also install TheNounProjectAPI directly from github using:

pip install --upgrade https://github.com/CubieDev/TheNounProjectAPI/archive/master.zip

For help with installing Python and/or pip, see "The Hitchhiker's Guide to Python" Installation Guides

---

Getting started

It's strongly encouraged to use the documentation's Getting started section to get started, as it's tied to the rest of the documentation, allowing you to quickly find exactly what you need.

However, I'll provide a quick sample.

# See the Documentation for more information: https://cubiedev.github.io/TheNounProjectAPI
from TheNounProjectAPI import API

if __name__ == "__main__":
    # API Key and Secret from https://api.thenounproject.com/getting_started.html#creating-an-api-key
    key = "<my api key>"
    secret = "<my api secret>"

    # Create api object
    api = API(key=key, secret=secret)

    # See the documentation for more endpoints
    icons = api.get_icons_by_term("goat", public_domain_only=True, limit=2)

    # >>>icons
    # [<IconModel: Term: Goat Feeding, Slug: goat-feeding, Id: 24014>,
    # <IconModel: Term: Herbivore teeth, Slug: herbivore-teeth, Id: 675870>]

    for icon in icons:
        print("Icon's term:", icon.term)
        print("This icon's tags:", ", ".join(tag.slug for tag in icon.tags))
        print("Uploader's username:", icon.uploader.username)

Examine the TheNounProjectAPI documentation for more examples of what can be done with TheNounProjectAPI.

---

Documentation

Documentation can be found here: https://cubiedev.github.io/TheNounProjectAPI

---

Tests

Run python runner.py, nosetests, python setup.py nosetests or python setup.py test to run all tests in one batch.

License

TheNounProjectAPI is licensed under MIT.

Contributions

Contributions are welcome.