Skip to content

RyLaney/zinny-api

Repository files navigation

Zinny API: A Backend Server for Structured Media Evaluations

License

What's the skinny on the ciné?

Zinny API powers the backend for structured media evaluations using surveys from zinny-surveys. It stores ratings in a SQLite database and provides endpoints for managing surveys, titles, ratings, and collections.

The API is used by the zinny-webui frontend and the zinny-cli command-line interface for seamless user interaction.

Quickstart

  1. Start the server: python zinny-api.py or zinny-api
  2. Open the web browser to: http://127.0.0.1:5219

API Documentation

For detailed API endpoints and usage, see API_REFERENCE.md.

Installation Details

see SETUP.md

Contributing

We welcome contributions! If you'd like to report an issue, suggest a feature, or contribute code, please check out the CONTRIBUTING.md file for guidelines.

Acknowledgements

  • Flask for the API framework.
  • PyInstaller for building executables.
  • Platypus for creating macOS app bundles.
  • Special thanks to IMDb for being the standard reference for movie and TV data. While no IMDb data is used directly, title information may coincide with their dataset.
  • Development sponsored by Teus Media.

About

Zinny is an open-source project for rating films via structured data surveys. This is the API

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors