plotair 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. plotair/__init__.py +1 -1
  2. plotair/config.toml +13 -12
  3. plotair/main.py +403 -371
  4. plotair-0.3.0.dist-info/METADATA +143 -0
  5. plotair-0.3.0.dist-info/RECORD +8 -0
  6. plotair-0.2.0.dist-info/METADATA +0 -97
  7. plotair-0.2.0.dist-info/RECORD +0 -8
  8. {plotair-0.2.0.dist-info → plotair-0.3.0.dist-info}/WHEEL +0 -0
  9. {plotair-0.2.0.dist-info → plotair-0.3.0.dist-info}/entry_points.txt +0 -0
  10. {plotair-0.2.0.dist-info → plotair-0.3.0.dist-info}/licenses/LICENSE +0 -0
plotair-0.3.0.dist-info/METADATA ADDED
@@ -0,0 +1,143 @@
1
+ Metadata-Version: 2.4
2
+ Name: plotair
3
+ Version: 0.3.0
4
+ Summary: Generate CO₂, humidity and temperature plots from VisiblAir sensor CSV files.
5
+ Project-URL: Repository, https://github.com/monsieurlinux/plotair
6
+ Author-email: Monsieur Linux <info@mlinux.ca>
7
+ License-Expression: MIT
8
+ License-File: LICENSE
9
+ Keywords: cli,data-analysis,data-science,iot,monitoring,python,terminal,visualization
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Programming Language :: Python :: 3
12
+ Requires-Python: >=3.11
13
+ Requires-Dist: pandas<3.0.0,>=2.0.0
14
+ Requires-Dist: seaborn<1.0.0,>=0.13.2
15
+ Description-Content-Type: text/markdown
16
+
17
+ ![Air quality plot](https://github.com/monsieurlinux/plotair/raw/main/img/cuisine.png)
18
+
19
+ # PlotAir
20
+
21
+ [![PyPI][pypi-badge]][pypi-link]
22
+ [![License][license-badge]][license-link]
23
+
24
+ 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.
25
+
26
+ ## Dependencies
27
+
28
+ PlotAir requires the following external libraries:
29
+
30
+ * **[pandas][pandas-link]**: Used for data manipulation and analysis.
31
+ * **[seaborn][seaborn-link]**: Used for creating plots.
32
+
33
+ These libraries and their sub-dependencies will be installed automatically when you install PlotAir.
34
+
35
+ ## Installation
36
+
37
+ 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`.
38
+
39
+ ### Installation with `pipx`
40
+
41
+ `pipx` installs PlotAir in an isolated environment and makes it available globally.
42
+
43
+ **1. Install `pipx`:**
44
+
45
+ * **Linux (Debian / Ubuntu / Mint):**
46
+
47
+ ```bash
48
+ sudo apt install pipx
49
+ pipx ensurepath
50
+ ```
51
+ * **Linux (Other) / macOS:**
52
+
53
+ ```bash
54
+ python3 -m pip install --user pipx
55
+ python3 -m pipx ensurepath
56
+ ```
57
+ * **Windows:**
58
+
59
+ ```bash
60
+ python -m pip install --user pipx
61
+ python -m pipx ensurepath
62
+ ```
63
+
64
+ 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].
65
+
66
+ **2. Install PlotAir:**
67
+
68
+ ```bash
69
+ pipx install plotair
70
+ ```
71
+
72
+ ### Installation with `pip`
73
+
74
+ If you prefer to manage the virtual environment manually, you can create and activate it by following this [tutorial][venv-link]. Then install PlotAir:
75
+
76
+ ```bash
77
+ pip install plotair
78
+ ```
79
+
80
+ ## Deployments
81
+
82
+ View all releases on:
83
+
84
+ - **[PyPI Releases][pypi-releases]**
85
+ - **[GitHub Releases][github-releases]**
86
+
87
+ ## Usage
88
+
89
+ ### Basic Usage
90
+
91
+ ```bash
92
+ plotair [arguments] FILE [FILE ...]
93
+ ```
94
+
95
+ ### Command-Line Arguments
96
+
97
+ | Argument | Short Flag | Description |
98
+ | --------------------- | ---------- | ---------------------------------------------------- |
99
+ | `--help` | `-h` | Show help message |
100
+ | `--all-dates` | `-a` | Plot all dates (otherwise only latest sequence) |
101
+ | `--boxplot` | `-b` | Generate boxplots along with text stats |
102
+ | `--merge` | `-m` | Merge field from file1 to file2, and output to file3 |
103
+ | `--filter-multiplier` | `-M` | Multiplier for IQR outlier filtering (default: 1.5) |
104
+ | `--filter-outliers` | `-o` | Filter out outliers from the plots |
105
+ | `--reset-config` | `-r` | Reset configuration file to default |
106
+ | `--start-date` | `-s` | Date at which to start the plot (YYYY-MM-DD) |
107
+ | `--stop-date` | `-S` | Date at which to stop the plot (YYYY-MM-DD) |
108
+ | `--title` | `-t` | Set the plot title |
109
+ | `--snapshots` | `-T` | Generate a snapshots table from all files |
110
+ | `--version` | `-v` | Show program's version number and exit |
111
+
112
+ ## Configuration
113
+
114
+ 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):
115
+
116
+ * **Linux:** `~/.config/plotair`
117
+ * **macOS:** `~/Library/Preferences/plotair`
118
+ * **Windows:** `C:/Users/YourUsername/AppData/Roaming/plotair`
119
+
120
+ You can edit this file to customize various settings. Common customizations include translating plot labels into different languages or modifying the line colors.
121
+
122
+ ## License
123
+
124
+ Copyright (c) 2026 Monsieur Linux
125
+
126
+ This project is licensed under the MIT License. See the LICENSE file for details.
127
+
128
+ ## Acknowledgements
129
+
130
+ 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.
131
+
132
+ [batiments-link]: https://batimentsvivants.ca/
133
+ [github-releases]: https://github.com/monsieurlinux/plotair/releases
134
+ [license-badge]: https://img.shields.io/pypi/l/plotair.svg
135
+ [license-link]: https://github.com/monsieurlinux/plotair/blob/main/LICENSE
136
+ [pandas-link]: https://github.com/pandas-dev/pandas
137
+ [pipx-link]: https://github.com/pypa/pipx
138
+ [pypi-badge]: https://img.shields.io/pypi/v/plotair.svg
139
+ [pypi-link]: https://pypi.org/project/plotair/
140
+ [pypi-releases]: https://pypi.org/project/plotair/#history
141
+ [seaborn-link]: https://github.com/mwaskom/seaborn
142
+ [venv-link]: https://docs.python.org/3/tutorial/venv.html
143
+ [visiblair-link]: https://visiblair.com/
plotair-0.3.0.dist-info/RECORD ADDED
@@ -0,0 +1,8 @@
1
+ plotair/__init__.py,sha256=VrXpHDu3erkzwl_WXrqINBm9xWkcyUy53IQOj042dOs,22
2
+ plotair/config.toml,sha256=CHEjYYtlvwTEVLoWB1_rfXRjy9Rp8ITU-TKmOxKIYdc,1660
3
+ plotair/main.py,sha256=QKzXNoVpB1vmnfBlYCBiHgo07zWVmntGz7cgsKnOgos,30445
4
+ plotair-0.3.0.dist-info/METADATA,sha256=fDHYqTssCjfF09jKHmOYXmZ_qS1BfTNWYWE2K6Y2b3c,5828
5
+ plotair-0.3.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
6
+ plotair-0.3.0.dist-info/entry_points.txt,sha256=ekJAavHU_JAF9a66br_T4-Vni_OAyd7QX-tnVlsH8pY,46
7
+ plotair-0.3.0.dist-info/licenses/LICENSE,sha256=Lb4o6Virnt4fVuYjZ_QO4qrvRUJqHe0MCkqVr_lncJo,1071
8
+ plotair-0.3.0.dist-info/RECORD,,
plotair-0.2.0.dist-info/METADATA DELETED
@@ -1,97 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: plotair
3
- Version: 0.2.0
4
- Summary: Generate CO₂, humidity and temperature plots from VisiblAir sensor CSV files.
5
- Project-URL: Repository, https://github.com/monsieurlinux/plotair
6
- Author-email: Monsieur Linux <info@mlinux.ca>
7
- License-Expression: MIT
8
- License-File: LICENSE
9
- Keywords: cli,data-analysis,data-science,iot,monitoring,python,terminal,visualization
10
- Classifier: Operating System :: OS Independent
11
- Classifier: Programming Language :: Python :: 3
12
- Requires-Python: >=3.11
13
- Requires-Dist: pandas<3.0.0,>=2.0.0
14
- Requires-Dist: seaborn>=0.13.2
15
- Description-Content-Type: text/markdown
16
-
17
- ![Air quality plot](https://github.com/monsieurlinux/plotair/raw/main/img/cuisine.png)
18
-
19
- # PlotAir
20
-
21
- PlotAir is a Python script that processes one or more CSV files containing [VisiblAir](https://visiblair.com/) sensor data. For each file, it reads the data into a [pandas](https://github.com/pandas-dev/pandas) DataFrame, ignores incorrectly formatted lines, keeps only the most recent data sequence, and generates a [Seaborn](https://github.com/mwaskom/seaborn) plot saved as a PNG file with the same base name as the input CSV.
22
-
23
- ## Dependencies
24
-
25
- PlotAir requires the following external libraries:
26
-
27
- * **[pandas](https://github.com/pandas-dev/pandas)**: Used for data manipulation and analysis.
28
- * **[seaborn](https://github.com/mwaskom/seaborn)**: Used for creating plots.
29
-
30
- These libraries and their sub-dependencies will be installed automatically when you install PlotAir.
31
-
32
- ## Installation
33
-
34
- It is recommended to install PlotAir within a [virtual environment](https://docs.python.org/3/tutorial/venv.html) 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`.
35
-
36
- ### Installation with `pipx`
37
-
38
- `pipx` installs PlotAir in an isolated environment and makes it available globally.
39
-
40
- **1. Install `pipx`:**
41
-
42
- * **Linux (Debian / Ubuntu / Mint):**
43
-
44
- ```bash
45
- sudo apt install pipx
46
- pipx ensurepath
47
- ```
48
- * **Linux (Other) / macOS:**
49
-
50
- ```bash
51
- python3 -m pip install --user pipx
52
- python3 -m pipx ensurepath
53
- ```
54
- * **Windows:**
55
-
56
- ```bash
57
- python -m pip install --user pipx
58
- python -m pipx ensurepath
59
- ```
60
-
61
- You may need to close and restart your terminal for the PATH changes to take effect.
62
-
63
- **2. Install PlotAir:**
64
-
65
- ```bash
66
- pipx install plotair
67
- ```
68
-
69
- ### Installation with `pip`
70
-
71
- If you prefer to manage the virtual environment manually, you can create and activate it by following this [tutorial](https://docs.python.org/3/tutorial/venv.html). Then install PlotAir:
72
-
73
- ```bash
74
- pip install plotair
75
- ```
76
-
77
- ## Usage
78
-
79
- ### Basic Usage
80
-
81
- ```bash
82
- plotair [arguments] FILE [FILE ...]
83
- ```
84
-
85
- ### Command-Line Arguments
86
-
87
- None for now.
88
-
89
- ## License
90
-
91
- Copyright (c) 2026 Monsieur Linux
92
-
93
- This project is licensed under the MIT License. See the LICENSE file for details.
94
-
95
- ## Acknowledgements
96
-
97
- Thanks to the creators and contributors of the [pandas](https://github.com/pandas-dev/pandas) and [seaborn](https://github.com/mwaskom/seaborn) libraries, and to the developer of the great [VisiblAir](https://visiblair.com/) air quality monitors and CO₂ sensors. Thanks also to the founder of [Bâtiments vivants](https://batimentsvivants.ca/) for the idea of this script.
plotair-0.2.0.dist-info/RECORD DELETED
@@ -1,8 +0,0 @@
1
- plotair/__init__.py,sha256=Zn1KFblwuFHiDRdRAiRnDBRkbPttWh44jKa5zG2ov0E,22
2
- plotair/config.toml,sha256=WYKZgfmpHNwERI3ua6X9aO4X1yv95JfOLOjKF3NT-SU,1668
3
- plotair/main.py,sha256=G3QZSDMiX4mQUBpbMDVbw-juQ1eQa-15fetX1qt00QU,30631
4
- plotair-0.2.0.dist-info/METADATA,sha256=Wtn1lbOmmRlnsuPc61GG4PaE3R81-thGtGQik6giDlE,3331
5
- plotair-0.2.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
6
- plotair-0.2.0.dist-info/entry_points.txt,sha256=ekJAavHU_JAF9a66br_T4-Vni_OAyd7QX-tnVlsH8pY,46
7
- plotair-0.2.0.dist-info/licenses/LICENSE,sha256=Lb4o6Virnt4fVuYjZ_QO4qrvRUJqHe0MCkqVr_lncJo,1071
8
- plotair-0.2.0.dist-info/RECORD,,