Skip to main content

Python3 interface to fanart.tv API (v3)

Project description

Home-page: http://github.com/opacam/python3-fanart
Author: Andrea De Marco
Author-email: 24erre@gmail.com
Maintainer: Pol Canelles
Maintainer-email: canellestudi@gmail.com
License: Apache License 2.0
Description: =======================================
Python3 interface to fanart.tv API (v3)
=======================================

.. image:: https://api.travis-ci.org/opacam/python3-fanart.png?branch=master
:target: http://travis-ci.org/opacam/python3-fanart

.. image:: https://coveralls.io/repos/github/opacam/python3-fanart/badge.svg?branch=master
:target: https://coveralls.io/github/opacam/python3-fanart?branch=master


.. image:: https://pypip.in/v/python3-fanart/badge.png
:target: https://pypi.python.org/pypi/python3-fanart

.. image:: https://pypip.in/d/python3-fanart/badge.png
:target: https://pypi.python.org/pypi/python3-fanart

This package provides a module to interface with the `fanart.tv`_. It's a fork
of the project named `python-fanart`_ but updated to work with
`fanart.tv api v3`. It also limits the python version to 3.4+, because the end
of life of python2 it's near (2020). To use this package you need your own
**api key**. You can request your api key in here: `fanart.tv api key`_


.. contents::
:local:

.. _installation:

Installation
============
Using pip::

$ pip install git+https://github.com/opacam/python3-fanart

.. _summary:

FANART API Summary
==================

Low Level
---------

::

from fanart.core import Request
import fanart
request = Request(
apikey='<YOURAPIKEY>',
id='24e1b53c-3085-4581-8472-0b0088d2508c',
ws=fanart.WS.MUSIC,
type=fanart.TYPE.ALL,
sort=fanart.SORT.POPULAR,
limit=fanart.LIMIT.ALL,
)
print(request.response())


Music
-----

::

import os
os.environ.setdefault('FANART_APIKEY', '<YOURAPIKEY>')
import requests

from fanart.music import Artist

artist = Artist.get(id='24e1b53c-3085-4581-8472-0b0088d2508c')
print(artist.name)
print(artist.mbid)
for album in artist.albums:
for cover in album.covers:
print('Saving: %s' % cover)
_, ext = os.path.splitext(cover.url)
filepath = os.path.join(path, '%d%s' % (cover.id, ext))
with open(filepath, 'wb') as fp:
fp.write(cover.content())

Movie
-----

::

import os
os.environ.setdefault('FANART_APIKEY', '<YOURAPIKEY>')

from fanart.movie import Movie

movie = Movie.get(id='70160')


TV Shows
--------

::

import os
os.environ.setdefault('FANART_APIKEY', '<YOURAPIKEY>')

from fanart.tv import TvShow

tvshow = TvShow.get(id='80379')

.. _license:

License
=======

This software is licensed under the ``Apache License 2.0``. See the ``LICENSE``
file in the top distribution directory for the full license text.

.. _references:

References
==========
* `fanart.tv`_
* `python-fanart`_
* `fanart.tv api key`_

.. _fanart.tv: http://fanart.tv/
.. _python-fanart: https://github.com/z4r/python-fanart
.. _fanart.tv api key: https://fanart.tv/get-an-api-key/

Keywords: fanart.tv
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python3-fanart-2.0.0.tar.gz (9.6 kB view hashes)

Uploaded Source

Built Distributions

python3_fanart-2.0.0-py3.7.egg (30.9 kB view hashes)

Uploaded Source

python3_fanart-2.0.0-py3-none-any.whl (13.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page