plotair 0.2.0__tar.gz → 0.2.1__tar.gz

plotair-0.2.1/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: plotair
+Version: 0.2.1
+Summary: Generate CO₂, humidity and temperature plots from VisiblAir sensor CSV files.
+Project-URL: Repository, https://github.com/monsieurlinux/plotair
+Author-email: Monsieur Linux <info@mlinux.ca>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,data-analysis,data-science,iot,monitoring,python,terminal,visualization
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Requires-Dist: pandas<3.0.0,>=2.0.0
+Requires-Dist: seaborn<1.0.0,>=0.13.2
+Description-Content-Type: text/markdown
+
+![Air quality plot](https://github.com/monsieurlinux/plotair/raw/main/img/cuisine.png)
+
+# PlotAir
+
+[![PyPI][pypi-badge]][pypi-link]
+[![License][license-badge]][license-link]
+
+PlotAir is a Python script that processes one or more CSV files containing [VisiblAir][visiblair-link] sensor data. For each file, it reads the data into a [pandas][pandas-link] DataFrame, ignores incorrectly formatted lines, keeps only the most recent data sequence, and generates a [Seaborn][seaborn-link] plot saved as a PNG file with the same base name as the input CSV.
+
+## Dependencies
+
+PlotAir requires the following external libraries:
+
+* **[pandas][pandas-link]**: Used for data manipulation and analysis.
+* **[seaborn][seaborn-link]**: Used for creating plots.
+
+These libraries and their sub-dependencies will be installed automatically when you install PlotAir.
+
+## Installation
+
+It is recommended to install PlotAir within a [virtual environment][venv-link] to avoid conflicts with system packages. Some Linux distributions enforce this. You can use `pipx` to handle the virtual environment automatically, or create one manually and use `pip`.
+
+### Installation with `pipx`
+
+`pipx` installs PlotAir in an isolated environment and makes it available globally.
+
+**1. Install `pipx`:**
+
+*   **Linux (Debian / Ubuntu / Mint):**
+    
+    ```bash
+    sudo apt install pipx
+    pipx ensurepath
+    ```
+*   **Linux (Other) / macOS:**
+    
+    ```bash
+    python3 -m pip install --user pipx
+    python3 -m pipx ensurepath
+    ```
+*   **Windows:**
+    
+    ```bash
+    python -m pip install --user pipx
+    python -m pipx ensurepath
+    ```
+
+You may need to reopen your terminal for the PATH changes to take effect. If you encounter a problem, please refer to the official [pipx documentation][pipx-link].
+
+**2. Install PlotAir:**
+
+```bash
+pipx install plotair
+```
+
+### Installation with `pip`
+
+If you prefer to manage the virtual environment manually, you can create and activate it by following this [tutorial][venv-link]. Then install PlotAir:
+
+```bash
+pip install plotair
+```
+
+## Deployments
+
+View all releases on:
+
+- **[PyPI Releases][pypi-releases]**
+- **[GitHub Releases][github-releases]**
+
+## Usage
+
+### Basic Usage
+
+```bash
+plotair [arguments] FILE [FILE ...]
+```
+
+### Command-Line Arguments
+
+None for now.
+
+## Configuration
+
+When you run PlotAir for the first time, a `config.toml` file is automatically created. Its location depends on your operating system (typical paths are listed below):
+
+*   **Linux:** `~/.config/plotair`
+*   **macOS:** `~/Library/Preferences/plotair`
+*   **Windows:** `C:/Users/YourUsername/AppData/Roaming/plotair`
+
+You can edit this file to customize various settings. Common customizations include translating plot labels into different languages or modifying the line colors.
+
+## License
+
+Copyright (c) 2026 Monsieur Linux
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+## Acknowledgements
+
+Thanks to the creators and contributors of the [pandas][pandas-link] and [seaborn][seaborn-link] libraries, and to the developer of the great [VisiblAir][visiblair-link] air quality monitors and CO₂ sensors. Thanks also to the founder of [Bâtiments vivants][batiments-link] for the idea of this script.
+
+[batiments-link]: https://batimentsvivants.ca/
+[github-releases]: https://github.com/monsieurlinux/plotair/releases
+[license-badge]: https://img.shields.io/pypi/l/plotair.svg
+[license-link]: https://github.com/monsieurlinux/plotair/blob/main/LICENSE
+[pandas-link]: https://github.com/pandas-dev/pandas
+[pipx-link]: https://github.com/pypa/pipx
+[pypi-badge]: https://img.shields.io/pypi/v/plotair.svg
+[pypi-link]: https://pypi.org/project/plotair/
+[pypi-releases]: https://pypi.org/project/plotair/#history
+[seaborn-link]: https://github.com/mwaskom/seaborn
+[venv-link]: https://docs.python.org/3/tutorial/venv.html
+[visiblair-link]: https://visiblair.com/

plotair-0.2.1/README.md

@@ -0,0 +1,114 @@
+![Air quality plot](https://github.com/monsieurlinux/plotair/raw/main/img/cuisine.png)
+
+# PlotAir
+
+[![PyPI][pypi-badge]][pypi-link]
+[![License][license-badge]][license-link]
+
+PlotAir is a Python script that processes one or more CSV files containing [VisiblAir][visiblair-link] sensor data. For each file, it reads the data into a [pandas][pandas-link] DataFrame, ignores incorrectly formatted lines, keeps only the most recent data sequence, and generates a [Seaborn][seaborn-link] plot saved as a PNG file with the same base name as the input CSV.
+
+## Dependencies
+
+PlotAir requires the following external libraries:
+
+* **[pandas][pandas-link]**: Used for data manipulation and analysis.
+* **[seaborn][seaborn-link]**: Used for creating plots.
+
+These libraries and their sub-dependencies will be installed automatically when you install PlotAir.
+
+## Installation
+
+It is recommended to install PlotAir within a [virtual environment][venv-link] to avoid conflicts with system packages. Some Linux distributions enforce this. You can use `pipx` to handle the virtual environment automatically, or create one manually and use `pip`.
+
+### Installation with `pipx`
+
+`pipx` installs PlotAir in an isolated environment and makes it available globally.
+
+**1. Install `pipx`:**
+
+*   **Linux (Debian / Ubuntu / Mint):**
+    
+    ```bash
+    sudo apt install pipx
+    pipx ensurepath
+    ```
+*   **Linux (Other) / macOS:**
+    
+    ```bash
+    python3 -m pip install --user pipx
+    python3 -m pipx ensurepath
+    ```
+*   **Windows:**
+    
+    ```bash
+    python -m pip install --user pipx
+    python -m pipx ensurepath
+    ```
+
+You may need to reopen your terminal for the PATH changes to take effect. If you encounter a problem, please refer to the official [pipx documentation][pipx-link].
+
+**2. Install PlotAir:**
+
+```bash
+pipx install plotair
+```
+
+### Installation with `pip`
+
+If you prefer to manage the virtual environment manually, you can create and activate it by following this [tutorial][venv-link]. Then install PlotAir:
+
+```bash
+pip install plotair
+```
+
+## Deployments
+
+View all releases on:
+
+- **[PyPI Releases][pypi-releases]**
+- **[GitHub Releases][github-releases]**
+
+## Usage
+
+### Basic Usage
+
+```bash
+plotair [arguments] FILE [FILE ...]
+```
+
+### Command-Line Arguments
+
+None for now.
+
+## Configuration
+
+When you run PlotAir for the first time, a `config.toml` file is automatically created. Its location depends on your operating system (typical paths are listed below):
+
+*   **Linux:** `~/.config/plotair`
+*   **macOS:** `~/Library/Preferences/plotair`
+*   **Windows:** `C:/Users/YourUsername/AppData/Roaming/plotair`
+
+You can edit this file to customize various settings. Common customizations include translating plot labels into different languages or modifying the line colors.
+
+## License
+
+Copyright (c) 2026 Monsieur Linux
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+## Acknowledgements
+
+Thanks to the creators and contributors of the [pandas][pandas-link] and [seaborn][seaborn-link] libraries, and to the developer of the great [VisiblAir][visiblair-link] air quality monitors and CO₂ sensors. Thanks also to the founder of [Bâtiments vivants][batiments-link] for the idea of this script.
+
+[batiments-link]: https://batimentsvivants.ca/
+[github-releases]: https://github.com/monsieurlinux/plotair/releases
+[license-badge]: https://img.shields.io/pypi/l/plotair.svg
+[license-link]: https://github.com/monsieurlinux/plotair/blob/main/LICENSE
+[pandas-link]: https://github.com/pandas-dev/pandas
+[pipx-link]: https://github.com/pypa/pipx
+[pypi-badge]: https://img.shields.io/pypi/v/plotair.svg
+[pypi-link]: https://pypi.org/project/plotair/
+[pypi-releases]: https://pypi.org/project/plotair/#history
+[seaborn-link]: https://github.com/mwaskom/seaborn
+[venv-link]: https://docs.python.org/3/tutorial/venv.html
+[visiblair-link]: https://visiblair.com/

plotair-0.2.1/plotair/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.1"

{plotair-0.2.0 → plotair-0.2.1}/plotair/config.toml

@@ -2,32 +2,33 @@
 max_missing_samples = 4
 
 [plot]
-size = [11.0, 8.5]
+size = [15, 10]
 font_family = 'Noto Sans'  # Set to '' to use default system font
-font_scale = 1.4
+font_scale = 1.8
 grid2_opacity = 0.7        # 0 is fully transparent and 1 is fully opaque
 grid1_line_style = '-'     # Options: '-', '--', ':' and '-.'
 grid2_line_style = '--'
+default_line_style = '-'
 limit_zone_opacity = 0.075
 limit_line_opacity = 0.7
-limit_line_width = 1
 limit_line_style = '--'
-"pm2.5_line_width" = 1.5
 "pm2.5_line_style" = '-'
-"pm10_line_width" = 1.5
 "pm10_line_style" = '-.'
 date_rotation = 30
 
 # Options: 'best', 'upper right', 'upper left', 'lower left', 'lower right',
 # 'center left', 'center right', 'lower center', 'upper center', 'center'
-legend_location = 'best'
+legend_location = 'upper left'
 
 [axis_ranges]
 co2 = [0, 2000]
-temp_h = [0, 80]
+humidity = [0, 80]
+temp = [0, 80]
 tvoc = [0, 500]
-co_form = [0, 50]
-"pm2.5_10" = [0, 70]
+co = [0, 50]
+form = [0, 50]
+"pm2.5" = [0, 70]
+"pm10" = [0, 70]
 
 [labels]
 co2 = 'CO₂ (ppm)'
@@ -35,8 +36,8 @@ temp = 'Température (°C)'
 humidity = 'Humidité (%)'
 tvoc = 'COVT (ppb)'
 tvoc_limit = 'Limite LEED, WELL et LBC'
-co = 'Monoxyde de carbone (ppm x 10)'
-co_limit = 'Limite anomalie légère BBI'
+co = 'Monoxyde de carbone (ppm)'
+co_limit = 'Limite Environnement Canada'
 form = 'Formaldéhyde (ppb)'
 form_limit = 'Limite anomalie légère BBI'
 "pm2.5" = 'PM2.5 (µg/m³)'
@@ -47,7 +48,7 @@ form_limit = 'Limite anomalie légère BBI'
 [limits]
 humidity = [40, 60]
 tvoc = 218  # ppb
-co = 4      # ppm
+co = 5      # ppm
 form = 16   # ppb
 "pm2.5" = 10
 "pm10" = 50