library letterboxd-ics {🖫 6, ⚐ 11, ★ 0}

cmbuckley/letterboxd-ics

Export Letterboxd diary to iCalendar format

Friday, February 12, 2016
by cmbuckley
Repository
1 Watchers
0 Stars
6 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
11 Versions
0 % Grown

The README.md

letterboxd-ics is a package to render a Letterboxd diary in iCalendar format., _(*1)

, _(*2)

How to install (Heroku)

, _(*3)

The installation will prompt you to set the LETTERBOXD_USERNAME and LETTERBOXD_PASSWORD secrets., _(*4)

How to install (standalone)

If you want to use the standalone package, you can do the following:, _(*5)

git clone https://github.com/cmbuckley/letterboxd-ics.git
cd letterboxd-ics
composer install

Once you have the package and its dependencies, set environment variables LETTERBOXD_USERNAME and LETTERBOXD_PASSWORD to your credentials, then point a Web server at the public folder., _(*6)

How to install (Packagist)

Alternatively, letterboxd-ics is available on Packagist, so it can be specified as a dependency using Composer:, _(*7)

{
    "require": {
        "cmbuckley/letterboxd-ics": "^8.0"
    }
}

How to use

You can specify your own options:, _(*8)

<?php
require 'vendor/autoload.php';

$calendar = new Starsquare\Letterboxd\Calendar(array(
    'auth' => array(
        'username' => 'user@example.com',
        'password' => 'password',
    ),
));

echo $calendar;

Other configuration options:, _(*9)

calendar: Config for the calendar.
- name: Name of the calendar.
- description: Full description of the calendar.
- timezone: Timezone of the calendar.
output: Config for the output.
- headers: Whether to send response headers.
- errors: Whether to display errors.
- content-type: Content-Type sent with the response. Defaults to text/calendar, but text/plain will work for most clients.
- charset: Character set sent with the response.

Alternatively, you can define your configuration options in a JSON-encoded config file, and pass the file path to the Calendar object. An example is provided in the public folder., _(*10)