Skip to main content

A lightweight and user-friendly Python SDK for interacting with the CineAPP REST API, built on top of the MovieLens dataset.

Project description

🎬 CineAPP SDK – cineapp-sdk

A lightweight and user-friendly Python SDK for interacting with the CineAPP REST API, built on top of the MovieLens dataset.
Designed for Data Analysts, Data Scientists, and learners — with native support for Pydantic models, Python dictionaries, and Pandas DataFrames.

PyPI version License: MIT


📦 Installation

pip install cineapp-sdk

⚙️ Configuration

from cineapp_sdk import CineClient, CineConfig

# Connect to the CineAPP API (hosted version)
config = CineConfig(cine_base_url="https://cineapp-xl99.onrender.com")
client = CineClient(config=config)

✅ Quick Examples

1. Health check

client.health_check()

2. Get a movie by ID

movie = client.get_movie(15)
print("Movie with ID = 15 is :", movie.title)

3. List First 5 Movies as a DataFrame

df = client.list_movies(limit=5, output_format="pandas")
print(df.head())

🔄 Output Modes

All listing methods (list_movies, list_ratings, etc.) support the following output formats:

  • pydantic (default) → List of Pydantic model instances

  • dict → Raw dictionaries

  • pandas → DataFrame for data analysis

Exemple :

client.list_movies(limit=50, output_format="dict")
client.list_ratings(limit=50, output_format="pandas")

🧪 Local API Testing

You can also connect to a local FastAPI instance if running CineAPP locally:

config = CineConfig(cine_base_url="http://localhost:8000")
client = CineConfig(config=config)

📝 Licence

This project is licensed under the MIT License.


🔗 Useful Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cineapp_sdk-0.1.1.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cineapp_sdk-0.1.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file cineapp_sdk-0.1.1.tar.gz.

File metadata

  • Download URL: cineapp_sdk-0.1.1.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for cineapp_sdk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 cb6371c09b898d62222c1d1688e074cb8d5bbfb7b6c61f3e53dbe131227b71a7
MD5 11f186506adc5da6e28d64cc99f7e624
BLAKE2b-256 77de580c8eaeaef217073a391a9b8c1c71aea8b8a79494c599381a65fa7e19c5

See more details on using hashes here.

File details

Details for the file cineapp_sdk-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cineapp_sdk-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for cineapp_sdk-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 35d10d472d5883deaf6af857cd18831bf82994463bc135b06926dc80178d4fdd
MD5 7f2a82603dd403ea37091a25fc01ee27
BLAKE2b-256 81508b82e944f3f8e0108b2f212562d420d7883901409fc59729f216f19f6ccd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page