Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/barrust/pyomdbapi

OMDB API python wrapper
https://github.com/barrust/pyomdbapi

imdb movie omdb omdb-api series

Last synced: 14 days ago
JSON representation

OMDB API python wrapper

Awesome Lists containing this project

README

        

pyomdbapi
===========

A simple OMDB API python wrapper

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://opensource.org/licenses/MIT/
:alt: License
.. image:: https://img.shields.io/github/release/barrust/pyomdbapi.svg
:target: https://github.com/barrust/pyomdbapi/releases
:alt: GitHub release
.. image:: https://badge.fury.io/py/pyomdbapi.svg
:target: https://badge.fury.io/py/pyomdbapi
:alt: PyPy Version
.. image:: https://pepy.tech/badge/pyomdbapi
:target: https://pepy.tech/project/pyomdbapi
:alt: Downloads

Documenation
-------------------------------------------------------------------------------

Online documentation can be found on `readthedocs.org `__.

Installation
------------------

Pip Installation:

::

$ pip install pyomdbapi

To install from source:

To install ``pyomdbapi``, simply clone the `repository on GitHub
`__, then run from the folder:

::

$ python setup.py install

`pyomdbapi` supports python versions 3.5 - 3.11

Quickstart
-------------------------------------------------------------------------------
To use ``pyomdbapi`` you will need to get an API Key from `the OMDBApi site
`__. There are several versions available
with the free version limiting to 1000 requests per day.

After installation, using ``pyomdbapi`` should be fairly straight forward:

.. code:: python

from omdb import OMDB

omdb = OMDB(YOUR_API_KEY)

print(omdb.get_movie('despicable me'))