README.rst
1|pypi| |pyversions| |license| |travis|
2
3.. |pypi| image:: https://img.shields.io/pypi/v/imdbpy.svg?style=flat-square
4 :target: https://pypi.org/project/imdbpy/
5 :alt: PyPI version.
6
7.. |pyversions| image:: https://img.shields.io/pypi/pyversions/imdbpy.svg?style=flat-square
8 :target: https://pypi.org/project/imdbpy/
9 :alt: Supported Python versions.
10
11.. |license| image:: https://img.shields.io/pypi/l/imdbpy.svg?style=flat-square
12 :target: https://github.com/alberanid/imdbpy/blob/master/LICENSE.txt
13 :alt: Project license.
14
15.. |travis| image:: https://travis-ci.org/alberanid/imdbpy.svg?branch=master
16 :target: https://travis-ci.org/alberanid/imdbpy
17 :alt: Travis CI build status.
18
19
20**IMDbPY** is a Python package for retrieving and managing the data
21of the `IMDb`_ movie database about movies, people and companies.
22
23.. admonition:: Revamp notice
24 :class: note
25
26 Starting on November 2017, many things were improved and simplified:
27
28 - moved the package to Python 3 (compatible with Python 2.7)
29 - removed dependencies: SQLObject, C compiler, BeautifulSoup
30 - removed the "mobile" and "httpThin" parsers
31 - introduced a test suite (`please help with it!`_)
32
33
34Main features
35-------------
36
37- written in Python 3 (compatible with Python 2.7)
38
39- platform-independent
40
41- can retrieve data from both the IMDb's web server, or a local copy
42 of the database
43
44- simple and complete API
45
46- released under the terms of the GPL 2 license
47
48IMDbPY powers many other software and has been used in various research papers.
49`Curious about that`_?
50
51
52Installation
53------------
54
55Whenever possible, please use the latest version from the repository::
56
57 pip install git+https://github.com/alberanid/imdbpy
58
59
60But if you want, you can also install the latest release from PyPI::
61
62 pip install imdbpy
63
64
65Example
66-------
67
68Here's an example that demonstrates how to use IMDbPY:
69
70.. code-block:: python
71
72 from imdb import IMDb
73
74 # create an instance of the IMDb class
75 ia = IMDb()
76
77 # get a movie
78 movie = ia.get_movie('0133093')
79
80 # print the names of the directors of the movie
81 print('Directors:')
82 for director in movie['directors']:
83 print(director['name'])
84
85 # print the genres of the movie
86 print('Genres:')
87 for genre in movie['genres']:
88 print(genre)
89
90 # search for a person name
91 people = ia.search_person('Mel Gibson')
92 for person in people:
93 print(person.personID, person['name'])
94
95
96Getting help
97------------
98
99Please refer to the `support`_ page on the `project homepage`_
100and to the the online documentation on `Read The Docs`_.
101
102The sources are available on `GitHub`_.
103
104License
105-------
106
107Copyright (C) 2004-2019 Davide Alberani <da --> mimante.net> et al.
108
109IMDbPY is released under the GPL license, version 2 or later.
110Read the included `LICENSE.txt`_ file for details.
111
112NOTE: For a list of persons who share the copyright over specific portions of code, see the `CONTRIBUTORS.txt`_ file.
113
114NOTE: See also the recommendations in the `DISCLAIMER.txt`_ file.
115
116.. _IMDb: https://www.imdb.com/
117.. _please help with it!: http://imdbpy.readthedocs.io/en/latest/devel/test.html
118.. _Curious about that: https://imdbpy.github.io/ecosystem/
119.. _project homepage: https://imdbpy.github.io/
120.. _support: https://imdbpy.github.io/support/
121.. _Read The Docs: https://imdbpy.readthedocs.io/
122.. _GitHub: https://github.com/alberanid/imdbpy
123.. _LICENSE.txt: https://raw.githubusercontent.com/alberanid/imdbpy/master/LICENSE.txt
124.. _CONTRIBUTORS.txt: https://raw.githubusercontent.com/alberanid/imdbpy/master/CONTRIBUTORS.txt
125.. _DISCLAIMER.txt: https://raw.githubusercontent.com/alberanid/imdbpy/master/DISCLAIMER.txt
126
