Metadata-Version: 2.1
Name: letterboxd
Version: 0.2.6
Summary: Python 3 wrapper for the Letterboxd API
Home-page: https://github.com/bobtiki/letterboxd/
Author: Mark Boszko
Author-email: mboszko@mac.com
License: MIT
Keywords: api,movie,film,movie database,movie review,watchlist,letterboxd,moviedb
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: requests

.. Semaphore Build Status
.. image:: https://semaphoreci.com/api/v1/bobtiki/letterboxd/branches/master/badge.svg
   :target: https://semaphoreci.com/bobtiki/letterboxd

.. Travis CI build status
.. image:: https://travis-ci.org/bobtiki/letterboxd.svg?branch=master
   :target: https://travis-ci.org/bobtiki/letterboxd

.. ReadTheDocs document status
.. image:: https://readthedocs.org/projects/letterboxd/badge/?version=latest
   :target: https://letterboxd.readthedocs.io/en/latest/?badge=latest

Letterboxd
==========

Python 3 implementation of the `Letterboxd API v0 <http://api-docs.letterboxd.com/>`_.

* PyPI package: https://pypi.org/project/letterboxd/
* GitHub repo: https://github.com/bobtiki/letterboxd
* Documentation: https://letterboxd.readthedocs.io
* Free software: MIT license

Python ≥3.6 is required.

.. warning::

    **THIS PROJECT IS CURRENTLY IN ALPHA:**

    - It may be broken.
    - What is working now may break between now and v1.0
    - Initial focus is on implementing endpoints related to retrieving watchlists and other lists for users.

Letterboxd API Access
---------------------

Letterboxd has posted an `example Ruby client <https://github.com/grantyb/letterboxd-api-example-ruby-client>`_, but as they say in the readme there:

    Although the Letterboxd API isn’t public yet (as at 2017-06-12), we have seeded some developers with API keys.

If you need more information about API access, please see `<https://letterboxd.com/api-coming-soon/>`_.


Changelog
=========

All notable changes to this project will be documented in this file.

The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_
and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.

[Unreleased]
------------

[0.2.0]
------------

Added
.....

- This ``CHANGELOG.rst``
- Converted ``README.md`` to ``.rst``
- Documentation written with reStructuredText and Sphinx, being built to `Read the Docs <https://letterboxd.readthedocs.io/>`_
- Added a number of defaults and tests as provided in `cookiecutter-pypackage <https://github.com/audreyr/cookiecutter-pypackage>`_
- Added an easy initializer with ``import letterboxd`` and then ``letterboxd.new()``
- ``User.refresh_token()`` to refresh the user authentication oAuth token
- Coverage for Letterboxd API endpoints:
    - /film/{id}/members
    - /film/{id}/report
    - /film/{id}/statistics
    - /films
    - /films/film-services
    - /films/genres
    - /film-collection/{id}
    - /search

Changed
.......

- All api-calling methods now return the dictionary from the response JSON, instead of the entire ``requests.Response``.

[0.1.0] - 2018-06-24
--------------------

Added
.....

- First public version! Version 0.1.0a `tagged on GitHub <https://github.com/bobtiki/letterboxd/releases/tag/v0.1.0a>`_, and `posted to PyPI <https://pypi.org/project/letterboxd/>`_.
- letterboxd, api, user, auth, member, and film modules.
- coverage for Letterboxd API endpoints:
    - film
    - /film/{id}
    - /film/{id}/availability — this data is first-party only
    - /film/{id}/me
    - /me
    - /member/{id}/watchlist

Changelog format
----------------

- Each version should:
    - List its release date in ISO 8601 format (YYYY-MM-DD).
    - Group changes to describe their impact on the project, as follows:
        - ``Added`` for new features.
        - ``Changed`` for changes in existing functionality.
        - ``Deprecated`` for once-stable features removed in upcoming releases.
        - ``Removed`` for deprecated features removed in this release.
        - ``Fixed`` for any bug fixes.
        - ``Security`` to invite users to upgrade in case of vulnerabilities.
    - Take a look at `this checklist for packaging a new version <http://www.sherifsoliman.com/2016/09/30/Python-package-with-GitHub-PyPI/>`_, and `this one <https://cookiecutter-pypackage.readthedocs.io/en/latest/pypi_release_checklist.html>`_

