Skip to main content

Python wrapper for FilmAffinity

Project description

This is a simple python scraping for the FilmAffinity.

https://github.com/sergiormb/python_filmaffinity/workflows/Tests/badge.svg?branch=master https://img.shields.io/github/license/mashape/apistatus.svg https://img.shields.io/pypi/pyversions/python-filmaffinity.svg https://readthedocs.org/projects/python-filmaffinity/badge/?version=latest

Installation

Pip

pip install python-filmaffinity

Optional Pydantic models:

pip install "python-filmaffinity[models]"

From Source

git clone git@github.com:sergiormb/python_filmaffinity.git
cd python_filmaffinity
python -m pip install -e ".[dev]"

Requirements

beautifulsoup4 >= 4.9.1
requests >= 2.24.0
requests-cache >= 1.0.0

Python 3.9 or newer is required.

FilmAffinity does not provide a public API for this package. The library uses HTML scraping, so selectors can break when FilmAffinity changes its layout.

Examples

import python_filmaffinity
service = python_filmaffinity.FilmAffinity()
movie = service.get_movie(title='Celda 211')
movie['title']
Celda 211
movie['rating']
7.7
movie['directors']
['Daniel Monzón']
movie['actors']
['Luis Tosar', 'Alberto Ammann', 'Antonio Resines', 'Carlos Bardem', 'Marta Etura', 'Vicente Romero', 'Manuel Morón', 'Manolo Solo', 'Fernando Soto', 'Luis Zahera', 'Patxi Bisquert', 'Félix Cubero', 'Josean Bengoetxea', 'Juan Carlos Mangas', 'Jesús Carroza']

Optional models and exporters

The public API keeps returning dictionaries by default. Install the models extra and pass as_model=True to receive Pydantic models:

service = python_filmaffinity.FilmAffinity()
movie = service.get_movie(id='495280', as_model=True)
movie.title

Export helpers accept dictionaries, lists and models:

movies = service.search(title='Batman')
python_filmaffinity.to_json(movies, 'movies.json')
python_filmaffinity.to_csv(movies, 'movies.csv')
python_filmaffinity.to_markdown(movies, 'movies.md')

Command line

filmaffinity search "Batman" --top 5
filmaffinity movie 197671 --images --json
filmaffinity top --kind filmaffinity --top 10

Development

python -m pip install -e ".[dev]"
python -m pytest
RUN_INTEGRATION=1 python -m pytest -m integration
python -m build
twine check dist/*

The persistent sqlite cache is stored in the user’s cache directory by default. Use cache_backend="memory" for runs that should not write to disk.

Usage

language

  • Spanish: ‘es’

  • USA, UK: ‘en’

  • México: ‘mx’

  • Argentina: ‘ar’

  • Chile: ‘cl’

  • Colombia: ‘co’

  • Example

import python_filmaffinity
service = python_filmaffinity.FilmAffinity(lang='en')

get_movie

Parameter

Required

Type

Description

id

False

String

FilmAffinity id

title

False

String

Get movie by title

trailer

False

Boolean

Return movie with trailer

images

False

Boolean

Return movie with images

  • Example

movies = service.get_movie(title='Avatar')
movies = service.get_movie(id='495280')

top_filmaffinity

Parameter

Required

Type

Description

from_year

False

String

Search start date

to_year

False

String

Search end date

top

False

Integer

Number of elements

  • Example

movies = service.top_filmaffinity()
movies = service.top_filmaffinity(from_year=2010, to_year=2011)

top_premieres

Parameter

Required

Type

Description

top

False

Integer

Number of elements

  • Example

movies = service.top_premieres()

top_netflix, top_hbo, top_filmin, top_movistar, top_rakuten, top_tv_series

Parameter

Required

Type

Description

top

False

Integer

Number of elements

  • Example

movies = service.top_netflix()
movies = service.top_hbo(top=5)
movies = service.top_filmin()
movies = service.top_movistar()
movies = service.top_rakuten()
movies = service.top_tv_series()

recommend HBO, Netflix, Filmin, Movistar, Rakuten

Parameter

Required

Type

Description

trailer

False

Boolean

Return movie with trailer

images

False

Boolean

Return movie with images

  • Example

movies = service.recommend_netflix()
movies = service.recommend_hbo()
movies = service.recommend_filmin()
movies = service.recommend_movistar()
movies = service.recommend_rakuten()

Changelog

v0.1.0 (17-06-2026)

  • Added the filmaffinity command line interface.

  • Added optional Pydantic models via as_model=True.

  • Added JSON, CSV and Markdown export helpers.

  • Moved the default persistent cache to the user’s cache directory.

  • Renamed the PyPI publishing workflow to publish-to-pypi.yml.

v0.0.21 (17-06-2026)

  • Updated scraping for the current FilmAffinity layout.

  • Replaced the deprecated user-agent dependency with an internal header pool.

  • Added fast parser tests and optional live integration tests.

  • Modernized packaging metadata and GitHub Actions.

v0.0.20 (28-09-2023)

  • Scrapping updated

v0.0.19 (22-06-2021)

  • Fixed errors in get_country

v0.0.18 (26-02-2021)

  • When images are requested, lets provide also the country where they were published (@jcea)

  • Correctly provide the trailers listed in filmaffinity (@jcea)

  • Spurious search in youtube deleted (@jcea)

  • Extract correctly when multiple genres (@jcea)

  • Added “writers”, “music”, “cinematography” and “producers” (@jcea)

  • Regression processing “original_title” in searches (@jcea)

v0.0.17 (18-02-2021)

  • Deleted spaces at the end of the title (@jcea)

  • Added original_title (@jcea)

  • Fix directors scraping (@jcea)

v0.0.15 (03-08-2020)

  • Search by genre

v0.0.14 (08-09-2018)

  • Fixed errors

v0.0.13 (07-09-2018)

  • Adds proxies and random user-agent in headers

v0.0.12 (27-08-2018)

  • Changed description

v0.0.11 (27-08-2018)

  • Fixed errors

v0.0.1O (27-08-2018)

  • Fixed errors with SSL

v0.0.09 (28-12-2017)

  • Replaces cachetools for requests-cache

v0.0.8 (26-12-2017)

  • Add images

  • Fixed errors

v0.0.7 (15-12-2017)

  • Fixes encoding for the analyzed results

  • Disabled limitations for all the supported languages

  • Change of name to the main class.

  • Adds initial language check and raise error if this is not in support

  • Adds basic exceptions

v0.0.6 (12-06-2017)

  • Add cachetools

v0.0.5 (13-06-2017)

  • Fixed errors

v0.0.4 (11-06-2017)

  • Top new DVDs

  • Get movie with trailer

  • Top TV series

  • Return movies list with raiting

v0.0.3 (10-06-2017)

  • Top Netlfix, HBO and Filmin

  • Recommendation from Netflix, HBO or Filmin

  • Fixed errors

v0.0.2 (31-05-2017)

  • Search movies by title, year, director or cast.

  • Get the filmaffinity top and search by year

  • Get the premieres top

v0.0.1 (29-05-2017)

  • Initial release.

Authors

Lead

Collaborators

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

python_filmaffinity-0.1.0.tar.gz (25.8 kB view details)

Uploaded Source

Built Distribution

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

python_filmaffinity-0.1.0-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file python_filmaffinity-0.1.0.tar.gz.

File metadata

  • Download URL: python_filmaffinity-0.1.0.tar.gz
  • Upload date:
  • Size: 25.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for python_filmaffinity-0.1.0.tar.gz
Algorithm Hash digest
SHA256 750a69035b931131303ae4acc0df45028b69ccb5caff96d535c67ef46fe97019
MD5 3ab08c701119568b823acaddf3471688
BLAKE2b-256 00b8199ff0241df581d205f25766178d52c6a59981987e6c9437d925c80a1660

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_filmaffinity-0.1.0.tar.gz:

Publisher: publish-to-pypi.yml on sergiormb/python_filmaffinity

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file python_filmaffinity-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for python_filmaffinity-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2f4da806fa4869c7b217b39d9add1d1c39c290dbe0933e1e438c614db03fe9ba
MD5 af854607ba20419afde74c397d23c872
BLAKE2b-256 22add30fde25cc3a667b63b061b2600847ba25471dcbab0c5370c17b400f215c

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_filmaffinity-0.1.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on sergiormb/python_filmaffinity

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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