pyIntradel 0.0.3__tar.gz → 0.0.5__tar.gz

pyintradel-0.0.5/.github/check_version.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+version=$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+result=$(curl -s https://pypi.org/pypi/pyIntradel/json | jq -r '.releases | keys[]' | grep -w "$version")
+
+if [ -z "$result" ]
+then
+  echo Version "$version" not found in pypi, all good
+  exit 0
+else
+  echo Version "$version" already exist in pypi
+  exit 1
+fi

pyintradel-0.0.5/.github/workflows/build.yml

@@ -0,0 +1,50 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Build
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.12', '3.13']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[dev]
+
+    - name: Lint with ruff
+      run: ruff check pyintradel tests
+      if: ${{ always() }}
+
+    - name: Check formatting with ruff
+      run: ruff format --check pyintradel tests
+      if: ${{ always() }}
+
+    - name: Type check with mypy
+      run: mypy pyintradel tests
+      if: ${{ always() }}
+
+    - name: Run tests
+      run: pytest
+      if: ${{ always() }}
+
+    - name: Check new pypi version is correct
+      run: (chmod +x .github/check_version.sh && sh .github/check_version.sh)
+      if: ${{ always() }}

pyintradel-0.0.5/.github/workflows/publish-pypi.yml

@@ -0,0 +1,37 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Publish to pypi
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      # Required for PyPI trusted publishing (OIDC). No token/secret needed.
+      id-token: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build a binary wheel and a source tarball
+      run: python -m build --sdist --wheel --outdir dist/
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@release/v1

pyintradel-0.0.5/.gitignore

@@ -0,0 +1,131 @@
+# 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/
+pip-wheel-metadata/
+share/python-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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.idea/

pyintradel-0.0.5/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: pyIntradel
+Version: 0.0.5
+Summary: Python interface for Intradel
+Project-URL: Homepage, https://github.com/thomasgermain/pyintradel
+Author-email: Thomas Germain <12560542+thomasgermain@users.noreply.github.com>
+License: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.12
+Requires-Dist: aiohttp<4.0,>=3.14
+Requires-Dist: beautifulsoup4<5.0,>=4.15
+Provides-Extra: dev
+Requires-Dist: build>=1.5; extra == 'dev'
+Requires-Dist: mypy>=2.1; extra == 'dev'
+Requires-Dist: pytest>=9.0; extra == 'dev'
+Requires-Dist: ruff>=0.15; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pyIntradel
+
+![PyPI - License](https://img.shields.io/github/license/thomasgermain/pyIntradel)
+![PyPI](https://img.shields.io/pypi/v/pyIntradel)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyIntradel.svg)
+
+A python connector for waste collection for province of Liège. This connector is using screen scraping to collect
+following data (for the current year), in json:
+- "Green bin" (organic waste) and "black bin" residual waste
+  - Total weight
+  - Number of collections
+  - details of all the collections
+  - chip number
+  - starting date (01/01 of the current year)
+- Recypark
+  - details of all the visits
+  - (01/01 of the current year)
+
+Here is an example of json:
+
+```json
+[
+    {
+        "name": "ORGANIQUE",
+        "start_date": "01-01-2022",
+        "id": "123456",
+        "details":
+        [
+            {
+                "date": "20-01-2022",
+                "detail": "34.0"
+            },
+            {
+                "date": "17-02-2022",
+                "detail": "27.0"
+            },
+            {
+                "date": "07-04-2022",
+                "detail": "36.0"
+            }
+        ],
+        "total": "97"
+    },
+    {
+        "name": "RESIDUEL",
+        "start_date": "01-01-2022",
+        "id": "78810",
+        "details":
+        [
+            {
+                "date": "20-01-2022",
+                "detail": "14.5"
+            },
+            {
+                "date": "07-04-2022",
+                "detail": "11.5"
+            },
+            {
+                "date": "21-04-2022",
+                "detail": "11.5"
+            }
+        ],
+        "total": "37.5"
+    },
+    {
+        "name": "RECYPARC",
+        "start_date": "01-01-2022",
+        "id": "RECYPARC",
+        "details":
+        [
+            {
+                "date": "14-04-2022",
+                "detail": "Encombrants (0.35 m³), Petits Bruns (0.00 pièce)"
+            }
+        ],
+        "total": "1"
+    }
+]
+```
+
+## Usage
+
+The `town` parameter is the name of the town, you can check it here: [towns](pyintradel/api/towns.py)
+
+### Python module
+
+```python
+import aiohttp
+from pyintradel import api
+
+async with aiohttp.ClientSession() as sess:
+    await api.get_data(sess, login, password, town)
+```
+
+### Command line
+```bash
+python3 -m pyintradel.main user passw town
+```
+
+---
+<a href="https://www.buymeacoffee.com/tgermain" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>

pyintradel-0.0.5/README.md

@@ -0,0 +1,101 @@
+# pyIntradel
+
+![PyPI - License](https://img.shields.io/github/license/thomasgermain/pyIntradel)
+![PyPI](https://img.shields.io/pypi/v/pyIntradel)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyIntradel.svg)
+
+A python connector for waste collection for province of Liège. This connector is using screen scraping to collect
+following data (for the current year), in json:
+- "Green bin" (organic waste) and "black bin" residual waste
+  - Total weight
+  - Number of collections
+  - details of all the collections
+  - chip number
+  - starting date (01/01 of the current year)
+- Recypark
+  - details of all the visits
+  - (01/01 of the current year)
+
+Here is an example of json:
+
+```json
+[
+    {
+        "name": "ORGANIQUE",
+        "start_date": "01-01-2022",
+        "id": "123456",
+        "details":
+        [
+            {
+                "date": "20-01-2022",
+                "detail": "34.0"
+            },
+            {
+                "date": "17-02-2022",
+                "detail": "27.0"
+            },
+            {
+                "date": "07-04-2022",
+                "detail": "36.0"
+            }
+        ],
+        "total": "97"
+    },
+    {
+        "name": "RESIDUEL",
+        "start_date": "01-01-2022",
+        "id": "78810",
+        "details":
+        [
+            {
+                "date": "20-01-2022",
+                "detail": "14.5"
+            },
+            {
+                "date": "07-04-2022",
+                "detail": "11.5"
+            },
+            {
+                "date": "21-04-2022",
+                "detail": "11.5"
+            }
+        ],
+        "total": "37.5"
+    },
+    {
+        "name": "RECYPARC",
+        "start_date": "01-01-2022",
+        "id": "RECYPARC",
+        "details":
+        [
+            {
+                "date": "14-04-2022",
+                "detail": "Encombrants (0.35 m³), Petits Bruns (0.00 pièce)"
+            }
+        ],
+        "total": "1"
+    }
+]
+```
+
+## Usage
+
+The `town` parameter is the name of the town, you can check it here: [towns](pyintradel/api/towns.py)
+
+### Python module
+
+```python
+import aiohttp
+from pyintradel import api
+
+async with aiohttp.ClientSession() as sess:
+    await api.get_data(sess, login, password, town)
+```
+
+### Command line
+```bash
+python3 -m pyintradel.main user passw town
+```
+
+---
+<a href="https://www.buymeacoffee.com/tgermain" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>

{pyIntradel-0.0.3 → pyintradel-0.0.5}/pyintradel/api/__init__.py

@@ -5,10 +5,7 @@ from typing import Any
 
 import aiohttp
 
-from . import parser
-from . import towns
-
-logging.basicConfig(level=logging.INFO, format="%(asctime)s:%(levelname)s:%(name)s: %(message)s")
+from . import parser, towns
 
 _LOGGER = logging.getLogger(__name__)
 _URL = "https://www.intradel.be/particulier/"
@@ -22,7 +19,7 @@ async def get_data(
 
     town_id = towns.TOWNS_MAP.get(town.upper())
     if not town_id:
-        ValueError("Town not found", town)
+        raise ValueError("Town not found", town)
 
     data = {"llogin": "YES", "login": login, "pass": password, "commune": town_id}
 

pyintradel-0.0.5/pyintradel/api/parser.py

@@ -0,0 +1,77 @@
+from typing import Any
+
+from bs4 import BeautifulSoup, Tag
+
+
+def parse(response: str) -> list[Any]:
+    """Parse response from intradel"""
+    results: list[Any] = []
+    soup = BeautifulSoup(response, features="html.parser")
+
+    if soup.select_one('[name="pLogin"]') is not None:
+        raise ValueError("Wrong response received, login/password seems incorrect", response)
+
+    for data in soup.select(".grid .row .post__content"):
+        result: dict[str, Any] = {}
+        if data.find("h3") is not None:
+            name = _name(data)
+            start_date = _start_date(data)
+            chip_id = _chip_id(data) or name
+            details = _details(data)
+            total = _total(data) or str(len(details))
+
+            result.update({"name": name})
+            result.update({"start_date": start_date})
+            result.update({"id": chip_id})
+            result.update({"details": details})
+            result.update({"total": total})
+            results.append(result)
+
+    return results
+
+
+def _require_tag(node: object) -> Tag:
+    """Narrow a bs4 lookup result to a Tag, failing loudly on unexpected markup."""
+    if not isinstance(node, Tag):
+        raise ValueError("Unexpected response structure from intradel")
+    return node
+
+
+def _name(data: Tag) -> str:
+    return _require_tag(data.find("h3")).text.strip()
+
+
+def _start_date(data: Tag) -> str:
+    info = data.find_all("p")
+    start_date = info[0]
+    if len(info) > 1:
+        start_date = info[3]
+
+    return start_date.text.split(":")[1].strip()
+
+
+def _chip_id(data: Tag) -> str | None:
+    chip_id = None
+    possible_chip_id = data.find_all("p")
+    if len(possible_chip_id) > 1:
+        chip_id = possible_chip_id[1].text.split(":")[1].strip()
+    return chip_id
+
+
+def _details(data: Tag) -> list[Any]:
+    attrs = []
+    for row in _require_tag(data.find("tbody")).find_all("tr"):
+        tds = row.find_all("td")
+        # When the list is empty, the website still includes an empty row.
+        # Let's just skip empty rows, as a valid row needs a date anyway.
+        if tds[0].text:
+            attrs.append({"date": tds[0].text, "detail": tds[2].text})
+    return attrs
+
+
+def _total(data: Tag) -> str | None:
+    total = None
+    possible_total = _require_tag(data.find("tfoot")).find_all("td")
+    if possible_total:
+        total = possible_total[2].text.split(" ")[0].strip()
+    return total

pyintradel-0.0.5/pyintradel/main.py

@@ -0,0 +1,24 @@
+import asyncio
+import json
+import sys
+
+import aiohttp
+
+from pyintradel import api
+
+
+async def _run(login: str, password: str, town: str) -> None:
+    async with aiohttp.ClientSession() as sess:
+        json.dump(await api.get_data(sess, login, password, town), sys.stdout, indent=2)
+
+
+def main() -> None:
+    if len(sys.argv) != 4:
+        print("Usage: pyintradel user pass town")
+        sys.exit(0)
+
+    asyncio.run(_run(sys.argv[1], sys.argv[2], sys.argv[3]))
+
+
+if __name__ == "__main__":
+    main()

pyintradel-0.0.5/pyproject.toml

@@ -0,0 +1,74 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyIntradel"
+version = "0.0.5"
+description = "Python interface for Intradel"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.12"
+authors = [
+    { name = "Thomas Germain", email = "12560542+thomasgermain@users.noreply.github.com" },
+]
+dependencies = [
+    "aiohttp>=3.14,<4.0",
+    "beautifulsoup4>=4.15,<5.0",
+]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Home Automation",
+]
+
+[project.urls]
+Homepage = "https://github.com/thomasgermain/pyintradel"
+
+[project.optional-dependencies]
+dev = [
+    "ruff>=0.15",
+    "mypy>=2.1",
+    "pytest>=9.0",
+    "build>=1.5",
+]
+
+[project.scripts]
+pyintradel = "pyintradel.main:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["pyintradel"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+# Large scraped HTML fixture, kept verbatim for parser tests.
+extend-exclude = ["tests/mock.py"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "ERA", # eradicate (commented-out code)
+    "UP",  # pyupgrade
+]
+
+[tool.mypy]
+strict = true
+ignore_missing_imports = true
+show_error_context = true
+show_column_numbers = true
+
+[[tool.mypy.overrides]]
+module = "pyintradel.*"
+implicit_reexport = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

pyintradel-0.0.5/tests/__init__.py

@@ -0,0 +1,5 @@
+"""pyIntradel tests."""
+
+import logging
+
+logging.basicConfig(level=logging.ERROR, format="%(asctime)s:%(levelname)s:%(name)s: %(message)s")

pyintradel-0.0.5/tests/api_test.py

@@ -0,0 +1,13 @@
+import unittest
+
+from pyintradel.api.parser import parse
+from tests.mock import CORRECT_RESPONSE, INCORRECT_LOGIN
+
+
+class ParsingTest(unittest.TestCase):
+    def test_parsing_correct(self) -> None:
+        result = parse(CORRECT_RESPONSE)
+        self.assertEqual(len(result), 3)
+
+    def test_parsing_login_error(self) -> None:
+        self.assertRaises(ValueError, parse, INCORRECT_LOGIN)