Commit a88b348d authored by richardARPANET's avatar richardARPANET

Correct license and use rst format since pypi has a but with markdown

parent 57d14d3b
# Release History
5.4.3 (unreleased)
------------------
- Nothing changed yet.
5.4.2 (2018-04-05)
------------------
- Fixes missing setuptools dependency for pypi display of markdown formatted files.
5.4.1 (2018-04-05)
------------------
- Packaging documentation fixes.
5.4.0 (2018-03-18)
------------------
- Bugfix for incorrect AttributeError message showing when undefined
attrs called on client class.
- Adds `get_title_top_crew` method.
5.3.0 (2018-02-27)
------------------
- Adds `get_title_plot_taglines` method.
- Adds `get_title_news` method.
- Adds `get_title_trivia` method.
- Adds `get_title_soundtracks` method.
- Adds `get_title_goofs` method.
- Adds `get_title_technical` method.
- Adds `get_title_companies` method.
- Adds `get_title_episodes_detailed` method.
5.2.0 (2018-01-11)
------------------
- Updates `get_title` to call "/auxiliary" as "/fulldetails" endpoint
now returns an error.
- Adds `get_title_quotes` method.
- Adds `get_title_ratings` method.
- Adds `get_title_connections` method.
- Adds `get_title_awards` method.
- Adds `get_title_plot_synopsis` method.
- Adds `get_title_versions` method.
- Adds `get_title_releases` method.
- Adds `get_title_similarities` method.
- Adds `get_title_videos` method.
- Adds `get_name_videos` method.
- Adds `get_name_filmography` method.
- Adds response status code to `ImdbAPIError` exception message.
5.1.0 (2018-01-10)
------------------
- Adds `get_title_genres` method.
5.0.0 (2018-01-10)
------------------
- Fixes client to work with new API.
- Renames most of methods on `Imdb` class.
- Changes all methods on `Imdb` to return raw JSON resource dictionary
rather than Python objects.
- Removes params from `Imdb` `__init__` method (user\_agent,
proxy\_uri, verify\_ssl, api\_key, cache, anonymize).
- Adds `clear_cached_credentials` method to `Imdb` class.
4.4.2 (2018-01-03)
------------------
- Fixes bug when searching with non alphanumeric characters, second
attempt.
4.4.1 (2017-12-27)
------------------
- Fixes bug when searching with non alphanumeric characters.
4.4.0 (2017-12-24)
------------------
- Fixes `search_for_person` and `search_for_title` methods, which were
broken because XML api used by the client was removed, migrated to
using search suggestions api used by the website itself.
- Adds optional `session` param to client init method, used to specify
`requests.Session`.
- All client methods will raise `ValueError` if invalid `imdb_id`
param given.
4.3.0 (2017-08-10)
------------------
**Added**
- Added `Imdb.popular_movies` to retrieve current popular movies.
4.2.0 (2016-09-29)
------------------
**Added**
- `Person.photo_url` has been added. It returns a string (url) or
None.
4.1.0 (2016-07-26)
------------------
- Changed `Title` and other objects to use less memory.
- Added notice of deprecation of caching in version 5.0.0.
- Added `Imdb.get_episodes` to retrieve Title Episode information.
4.0.2 (2015-08-08)
------------------
**Added** - Added `cache_expiry` parameter to `Imdb` class, to specify
cache expiry in seconds.
.. :changelog:
Release History
---------------
5.4.1 (unreleased)
++++++++++++++++++
- Nothing changed yet.
5.4.0 (2018-03-18)
++++++++++++++++++
- Bugfix for incorrect AttributeError message showing when undefined attrs called on client class.
- Adds ``get_title_top_crew`` method.
5.3.0 (2018-02-27)
++++++++++++++++++
- Adds ``get_title_plot_taglines`` method.
- Adds ``get_title_news`` method.
- Adds ``get_title_trivia`` method.
- Adds ``get_title_soundtracks`` method.
- Adds ``get_title_goofs`` method.
- Adds ``get_title_technical`` method.
- Adds ``get_title_companies`` method.
- Adds ``get_title_episodes_detailed`` method.
5.2.0 (2018-01-11)
++++++++++++++++++
- Updates ``get_title`` to call "/auxiliary" as "/fulldetails" endpoint now returns an error.
- Adds ``get_title_quotes`` method.
- Adds ``get_title_ratings`` method.
- Adds ``get_title_connections`` method.
- Adds ``get_title_awards`` method.
- Adds ``get_title_plot_synopsis`` method.
- Adds ``get_title_versions`` method.
- Adds ``get_title_releases`` method.
- Adds ``get_title_similarities`` method.
- Adds ``get_title_videos`` method.
- Adds ``get_name_videos`` method.
- Adds ``get_name_filmography`` method.
- Adds response status code to ``ImdbAPIError`` exception message.
5.1.0 (2018-01-10)
++++++++++++++++++
- Adds ``get_title_genres`` method.
5.0.0 (2018-01-10)
++++++++++++++++++
- Fixes client to work with new API.
- Renames most of methods on ``Imdb`` class.
- Changes all methods on ``Imdb`` to return raw JSON resource dictionary rather than Python objects.
- Removes params from ``Imdb`` ``__init__`` method (user_agent, proxy_uri, verify_ssl, api_key, cache, anonymize).
- Adds ``clear_cached_credentials`` method to ``Imdb`` class.
4.4.2 (2018-01-03)
++++++++++++++++++
- Fixes bug when searching with non alphanumeric characters, second attempt.
4.4.1 (2017-12-27)
++++++++++++++++++
- Fixes bug when searching with non alphanumeric characters.
4.4.0 (2017-12-24)
++++++++++++++++++
- Fixes ``search_for_person`` and ``search_for_title`` methods, which were broken because XML api used by the client was removed, migrated to using search suggestions api used by the website itself.
- Adds optional ``session`` param to client init method, used to specify ``requests.Session``.
- All client methods will raise ``ValueError`` if invalid ``imdb_id`` param given.
4.3.0 (2017-08-10)
++++++++++++++++++
**Added**
- Added ``Imdb.popular_movies`` to retrieve current popular movies.
4.2.0 (2016-09-29)
++++++++++++++++++
**Added**
- ``Person.photo_url`` has been added. It returns a string (url) or None.
4.1.0 (2016-07-26)
++++++++++++++++++
- Changed ``Title`` and other objects to use less memory.
- Added notice of deprecation of caching in version 5.0.0.
- Added ``Imdb.get_episodes`` to retrieve Title Episode information.
4.0.2 (2015-08-08)
++++++++++++++++++
**Added**
- Added ``cache_expiry`` parameter to ``Imdb`` class, to specify cache expiry in seconds.
**Changes**
- Internal caching changed you use 3rd party package ``cachecontrol``.
**Removed**
- ``Imdb`` class no longer takes a ``cache_dir`` parameter.
3.0.0 (2015-06-12)
++++++++++++++++++
**Changed**
- All methods on ``Imdb`` will raise ``imdbpie.exceptions.HTTPError`` if a bad request to the API or resource is not found ("Errors should never pass silently").
- ``Imdb.get_title_reviews`` now has param `max_results` to limit number of reviews returned.
2.1.0 (2015-05-03)
++++++++++++++++++
**Added**
- Added verify_ssl kwarg option to ``Imdb`` object. Allows for controlling of ssl cert verification on all requests made.
2.0.1 (2015-03-30)
++++++++++++++++++
**Added**
- ``Title.plot_outline`` has been added. It returns a string.
2.0.0 (2015-03-12)
++++++++++++++++++
**Added**
- ``Imdb.search_for_person`` has been added. It returns a list of dicts.
- ``Imdb.get_title_plots`` has been added. It returns a list of strings.
- ``Title.trailer_image_urls`` returns a list of trailer urls (string).
- ``Imdb.get_person_by_id`` has been added. It returns a Person object.
**Changed**
- ``Title.plots`` returns a list of *full* plots.
- ``Title.trailers`` returns a list of dicts (keys: "url", "format").
- ``Title.runtime`` returns runtime in seconds now instead of hours.
- ``Person.role`` is now ``Person.roles`` and returns a list rather than a string.
- ``Imdb.person_images`` has been renamed to ``Imdb.get_person_images``.
- ``Imdb.title_reviews`` has been renamed to ``Imdb.get_title_reviews`` and parameter ``limit`` has also been removed.
- ``Imdb.title_images`` has been renamed to ``Imdb.get_title_images``.
- ``Imdb.find_by_title`` has been renamed to ``Imdb.search_for_title``.
- ``Imdb.find_movie_by_id`` has been renamed to ``Imdb.get_title_by_id`` and parameter ``json`` has been removed.
- ``Imdb.movie_exists`` has been renamed to ``Imdb.title_exists``.
**Removed**
- ``Imdb.validate_id`` has been removed.
- ``Title.plot_outline`` has been removed.
- ``Title.trailer_img_url`` has been removed.
1.5.6 (2014-12-07)
++++++++++++++++++
- No notes, release made before changelog inception.
This diff is collapsed.
......@@ -13,10 +13,10 @@ os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
with open('requirements.txt') as f:
install_requires = f.read().splitlines()
with open('README.md', 'r') as rm_file:
with open('README.rst', 'r', encoding='utf-8') as rm_file:
readme = rm_file.read()
with open('HISTORY.md', 'r') as hist_file:
with open('HISTORY.rst', 'r', encoding='utf-8') as hist_file:
history = hist_file.read()
setup(
......@@ -32,9 +32,8 @@ setup(
),
author='Richard O\'Dwyer',
author_email='richard@richard.do',
license='Creative Commons Attribution-Noncommercial-Share Alike license',
license='Apache 2.0',
long_description=readme + '\n\n' + history,
long_description_content_type='text/markdown',
install_requires=install_requires,
classifiers=[
'Intended Audience :: Developers',
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment