Lizard - Letterboxd Data Processor

This project provides a web-based tool for downloading and processing Letterboxd data including user lists and watchlists from Letterboxd*.

demo.mp4

Table of Contents

• Usage
• Local Installation
• Documentation

Usage

For User Lists:

1. Enter the username/list-name or the direct list URL into the textbox on the main page or use the 'q' argument as a URL parameter.
   • Examples for user lists:
     • fastfingertips/list_name
     • fastfingertips/list/list_name
     • with filter:
       • fastfingertips/list_name/genre/crime
       • fastfingertips/list/list_name/genre/crime

For Watchlists:

1. Enter just the username to access their watchlist data.
   • Example for watchlists:
     • fastfingertips (username only)

For User List URLs (http or https):

• Examples:
  • https://letterboxd.com/fastfingertips/list/list_name
  • https://boxd.it/rSrSc
  • with filter:
    • https://letterboxd.com/fastfingertips/list/list_name/genre/crime
    • https://letterboxd.com/fastfingertips/list/list_name/decade/1990s/genre/crime
    • letterboxd short links do not support filters, so we did not implement this. it seems these are used only for sharing the list.

0. Press Enter.
1. If the list is verified, detailed information about the list will be presented.

Local Installation

You can use Lizard without installing anything on your local machine by visiting the web application.

If you prefer to run Lizard locally, follow these steps:

1. Clone the Repository:

   git clone https://github.com/FastFingertips/lizard.git
   cd lizard

2. Install Dependencies:

   # Option 1: Using pip with requirements.txt
   pip install -r requirements.txt
   
   # Option 2: Using modern pyproject.toml (recommended)
   pip install -e .

3. Run the Application:

   streamlit run main.py --server.port 8080

Now, you can access the Letterboxd List Downloader locally by opening your web browser and navigating to http://localhost:8080.

Documentation

For comprehensive API references and documentation links used throughout the project, see docs/references.md. This includes:

• Streamlit API references
• Python standard library documentation
• Third-party library documentation
• Development tools and external services