allocine 0.0.12__tar.gz → 0.1.0__tar.gz

allocine-0.1.0/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+* allocine version:
+* Python version:
+* Operating System:
+
+### Description
+
+Describe what you were trying to get done.
+Tell us what happened, what went wrong, and what you expected to happen.
+
+### What I Did
+
+```
+Paste the command(s) you ran and the output.
+If there was a crash, please include the traceback here.
+```

allocine-0.1.0/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly

allocine-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,68 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  quality:
+    name: Quality checks
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          enable-cache: true
+          python-version: "3.14"
+          version: "0.12.19"
+
+      - name: Install the project
+        run: uv sync --locked --extra dev
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Check formatting
+        run: uv run ruff format --check .
+
+      - name: Type-check
+        run: uv run ty check
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+          version: "0.12.19"
+
+      - name: Install the project
+        run: uv sync --locked --extra dev
+
+      - name: Run tests
+        run: uv run pytest

allocine-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,74 @@
+name: Publish release to PyPI
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+[ab][0-9]+"
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+    env:
+      RELEASE_TAG: ${{ github.ref_name }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          enable-cache: false
+          version: "0.12.19"
+
+      - name: Build distributions
+        run: uv build --no-sources
+
+      - name: Smoke-test wheel
+        run: uv run --isolated --no-project --with dist/*.whl tests/smoke_test.py
+
+      - name: Smoke-test source distribution
+        run: uv run --isolated --no-project --with dist/*.tar.gz tests/smoke_test.py
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: distributions
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: pypi
+      url: https://pypi.org/project/allocine/
+    permissions:
+      id-token: write
+    steps:
+      - name: Install uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          enable-cache: false
+          version: "0.12.19"
+
+      - name: Download distributions
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: distributions
+          path: dist/
+
+      - name: Generate PEP 740 attestations
+        uses: astral-sh/attest-action@f589a42a7efb6fe400b4f400de60b4bc90390027 # v0.0.6
+
+      - name: Publish distributions
+        run: uv publish

allocine-0.1.0/.gitignore

@@ -0,0 +1,112 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# Ruff
+.ruff_cache/
+
+# VS Code workspace configuration
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json

allocine-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        entry: .venv/bin/ruff check --fix
+        language: system
+        types_or: [python, pyi]
+      - id: ruff-format
+        name: ruff format
+        entry: .venv/bin/ruff format
+        language: system
+        types_or: [python, pyi]
+      - id: ty-check
+        name: ty check
+        entry: .venv/bin/ty check
+        language: system
+        pass_filenames: false
+        always_run: true

allocine-0.1.0/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "astral-sh.ty",
+    "charliermarsh.ruff",
+    "ms-python.python"
+  ]
+}

allocine-0.1.0/.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+  "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+  "python.languageServer": "None",
+  "ruff.configurationPreference": "filesystemFirst",
+  "ruff.interpreter": ["${workspaceFolder}/.venv/bin/python"],
+  "ruff.nativeServer": "on",
+  "ty.diagnosticMode": "workspace",
+  "ty.interpreter": ["${workspaceFolder}/.venv/bin/python"],
+  "[python]": {
+    "editor.codeActionsOnSave": {
+      "source.fixAll.ruff": "explicit",
+      "source.organizeImports.ruff": "explicit"
+    },
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.formatOnSave": true
+  }
+}

allocine-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018, Thibault Ducret
+
+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.
+

allocine-0.1.0/Makefile

@@ -0,0 +1,6 @@
+.PHONY: check
+
+check:
+	.venv/bin/ruff check --fix .
+	.venv/bin/ruff format .
+	.venv/bin/ty check

allocine-0.1.0/PKG-INFO

@@ -0,0 +1,214 @@
+Metadata-Version: 2.4
+Name: allocine
+Version: 0.1.0
+Summary: Non official Python wrapper for allocine.fr
+Author-email: Thibault Ducret <hello@tducret.com>
+License: MIT
+Project-URL: Homepage, https://github.com/tducret/allocine-python
+Keywords: allocine,api,parser,parsing,python-wrapper,scraper,scraping
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: backoff>=2.2.1
+Requires-Dist: click>=8.5.0
+Requires-Dist: diskcache<6,>=5.6
+Requires-Dist: httpx2>=2.13.1
+Requires-Dist: jmespath>=1.1.0
+Requires-Dist: parsel>=1.10.0
+Requires-Dist: platformdirs>=4.3
+Requires-Dist: rich>=14.2.0
+Provides-Extra: dev
+Requires-Dist: freezegun>=1.5.5; extra == "dev"
+Requires-Dist: pre-commit>=4.6.2; extra == "dev"
+Requires-Dist: pytest>=9.1.1; extra == "dev"
+Requires-Dist: pytest-cov>=7.1.0; extra == "dev"
+Requires-Dist: ruff>=0.16.9; extra == "dev"
+Requires-Dist: syrupy>=6.1.1; extra == "dev"
+Requires-Dist: ty>=0.0.84; extra == "dev"
+Requires-Dist: vcrpy>=8.3.0; extra == "dev"
+Dynamic: license-file
+
+# Allociné
+
+[![PyPI](https://img.shields.io/pypi/v/allocine.svg)](https://pypi.org/project/allocine/)
+![License](https://img.shields.io/github/license/tducret/allocine-python.svg)
+
+![Cinéma](cinema.jpg)
+
+## Description
+
+**Avec cet outil, vous récupérez les horaires des séances ciné directement dans le terminal**.
+
+## Prérequis
+
+- Python 3.10 ou une version ultérieure
+- [uv](https://docs.astral.sh/uv/)
+
+## Installation
+
+```bash
+uv tool install --upgrade allocine
+```
+
+## Utilisation en ligne de commande
+
+Commencez par rechercher l’identifiant de votre cinéma sur [allocine.fr](https://www.allocine.fr/).
+
+Recherchez votre cinéma et relevez son identifiant dans l’URL. Dans cet exemple, il s’agit de `P0645`.
+
+![Identifiant du cinéma](snapshot_theater_id.png)
+
+![Capture terminal](demo.gif)
+
+#### Aide
+
+```bash
+seances --help
+Usage: seances [OPTIONS] ID_CINEMA
+
+  Les séances de votre cinéma dans le terminal, avec ID_CINEMA : identifiant
+  du cinéma sur Allociné, ex: C0159 pour l’UGC Ciné Cité Les Halles. Se
+  trouve dans l’url :
+  http://allocine.fr/seance/salle_gen_csalle=<ID_CINEMA>.html
+
+Options:
+  -j, --jour TEXT    jour des séances souhaitées (au format DD/MM/YYYY ou +1
+                     pour demain), par défaut : aujourd’hui
+  -s, --semaine      affiche les séance pour les 7 prochains jours
+  -e, --entrelignes  ajoute une ligne entre chaque film pour améliorer la
+                     lisibilité
+  --help             Show this message and exit.
+```
+
+#### Utilisation simple
+
+```bash
+seances P2235
+
+27/12/2018
+┌──────────────────────────────────────────────────────────┬──────┬───────┬───────┬───────┬───────┐
+│ Astérix - Le Secret de la Potion Magique... (VF) - 01h25 │ 4.1* │ 10:15 │       │       │       │
+│ L’Empereur de Paris (VF) - 01h50                         │ 3.4* │       │       │ 17:15 │       │
+│ Ma mère est folle (VF) - 01h35                           │ 3.0* │       │ 14:15 │       │       │
+│ Marche ou crève (VF) - 01h25                             │ 3.6* │       │       │       │ 20:15 │
+└──────────────────────────────────────────────────────────┴──────┴───────┴───────┴───────┴───────┘
+```
+
+#### Pour demain, avec des interlignes
+
+```bash
+seances P2235 -j+1 --entrelignes
+
+28/12/2018
+┌────────────────────────────────────────────────────┬──────┬───────┬───────┬───────┐
+│ Casse-noisette et les quatre royaumes (VF) - 01h39 │ 3.1* │       │       │ 20:15 │
+├────────────────────────────────────────────────────┼──────┼───────┼───────┼───────┤
+│ Ma mère est folle (VF) - 01h35                     │ 3.0* │       │ 17:15 │       │
+├────────────────────────────────────────────────────┼──────┼───────┼───────┼───────┤
+│ Marche ou crève (VF) - 01h25                       │ 3.6* │ 14:15 │       │       │
+└────────────────────────────────────────────────────┴──────┴───────┴───────┴───────┘
+```
+
+#### Pour une date précise
+
+```bash
+seances P2235 --jour 29/12/2018
+```
+
+#### Pour toute la semaine
+
+```bash
+seances P2235 --semaine
+```
+
+## Utilisation de la bibliothèque
+
+```python
+from allocine import Allocine
+
+with Allocine() as allocine:
+    showtimes = allocine.get_showtimes("P2235")
+
+for showtime in showtimes:
+    print(showtime)
+```
+
+Exemple de sortie :
+
+```bash
+27/12/2018 10:15 : Astérix - Le Secret de la Potion Magique [244560] (VF) (01h25)
+27/12/2018 14:15 : Ma mère est folle [260370] (VF) (01h35)
+27/12/2018 17:15 : L’Empereur de Paris [258914] (VF) (01h50)
+27/12/2018 20:15 : Marche ou crève [258052] (VF) (01h25)
+28/12/2018 14:15 : Marche ou crève [258052] (VF) (01h25)
+28/12/2018 17:15 : Ma mère est folle [260370] (VF) (01h35)
+28/12/2018 20:15 : Casse-noisette et les quatre royaumes [245656] (VF) (01h39)
+29/12/2018 14:15 : Astérix - Le Secret de la Potion Magique [244560] (VF) (01h25)
+[...]
+```
+
+Le cache est activé par défaut. Les réponses sont enregistrées dans le répertoire de cache utilisateur du système :
+
+- macOS: `~/Library/Caches/allocine`
+- Linux: `${XDG_CACHE_HOME:-~/.cache}/allocine`
+- Windows: `%LOCALAPPDATA%\\allocine\\Cache`
+
+Videz le cache en ligne de commande (aucun identifiant de cinéma n’est nécessaire) :
+
+```bash
+seances --clear-cache
+```
+
+## Développement
+
+Créez l’environnement virtuel et installez le paquet avec ses dépendances de développement :
+
+```bash
+uv sync --extra dev
+```
+
+Installez les hooks pre-commit une première fois, puis utilisez `make check` pour analyser, formater et vérifier les types
+de l’ensemble du code :
+
+```bash
+uv run pre-commit install
+make check
+```
+
+Exécutez chaque vérification sans modifier les fichiers :
+
+```bash
+uv run ruff check .
+uv run ruff format --check .
+uv run ty check
+```
+
+Exécutez manuellement tous les hooks pre-commit avec :
+
+```bash
+uv run pre-commit run --all-files
+```
+
+Les utilisateurs de VS Code doivent accepter les recommandations d’extensions de l’espace de travail afin d’activer les
+diagnostics Ruff et ty en temps réel, ainsi que le formatage Ruff à l’enregistrement.
+
+## Publication
+
+Le workflow de publication publie sur PyPI les tags de version tels que `0.0.13` grâce à Trusted Publishing, sans
+stocker de jeton d’API. Avant la première publication :
+
+1. Créez un environnement GitHub nommé `pypi`. Il est recommandé d’exiger une approbation avant tout déploiement.
+2. Dans les paramètres de publication PyPI du projet `allocine`, ajoutez un Trusted Publisher GitHub avec le
+   propriétaire `tducret`, le dépôt `allocine-python`, le workflow `release.yml` et l’environnement `pypi`.
+
+Le tag Git définit la version du paquet ; aucun fichier de version ne doit être mis à jour. Ajoutez le tag au commit à
+publier. Le workflow rejette les distributions dont la version ne correspond pas au tag et effectue un test rapide du
+wheel et de la distribution source avant leur publication :
+
+```bash
+VERSION=0.0.13
+git tag -a ${VERSION} -m ${VERSION}
+git push origin ${VERSION}
+```