earthobservations / luftdatenpumpe

Acquire and process live and historical air quality data without efforts. Filter by station-id, sensor-id and sensor-type, apply reverse geocoding, store into time-series and RDBMS databases, publish to MQTT, output as JSON, or visualize in Grafana. Data sources: Sensor.Community (luftdaten.info), IRCELINE, and OpenAQ.
https://luftdatenpumpe.readthedocs.io/
GNU Affero General Public License v3.0
34 stars 3 forks source link

A few more adjustments and improvements to the documentation #60

Closed amotl closed 1 year ago

amotl commented 1 year ago

What the title says.

codecov[bot] commented 1 year ago

Codecov Report

Base: 55.89% // Head: 26.95% // Decreases project coverage by -28.94% :warning:

Coverage data is based on head (4dbf910) compared to base (66a7e37). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #60 +/- ## =========================================== - Coverage 55.89% 26.95% -28.95% =========================================== Files 3 18 +15 Lines 297 1640 +1343 =========================================== + Hits 166 442 +276 - Misses 131 1198 +1067 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `26.95% <ø> (-28.95%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations) | Coverage Δ | | |---|---|---| | [luftdatenpumpe/source/rdbms.py](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#diff-bHVmdGRhdGVucHVtcGUvc291cmNlL3JkYm1zLnB5) | `40.00% <0.00%> (ø)` | | | [luftdatenpumpe/target/mqtt.py](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#diff-bHVmdGRhdGVucHVtcGUvdGFyZ2V0L21xdHQucHk=) | `30.13% <0.00%> (ø)` | | | [luftdatenpumpe/source/common.py](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#diff-bHVmdGRhdGVucHVtcGUvc291cmNlL2NvbW1vbi5weQ==) | `28.42% <0.00%> (ø)` | | | [luftdatenpumpe/target/json.py](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#diff-bHVmdGRhdGVucHVtcGUvdGFyZ2V0L2pzb24ucHk=) | `25.00% <0.00%> (ø)` | | | [luftdatenpumpe/target/stream.py](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#diff-bHVmdGRhdGVucHVtcGUvdGFyZ2V0L3N0cmVhbS5weQ==) | `45.45% <0.00%> (ø)` | | | [luftdatenpumpe/source/\_\_init\_\_.py](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#diff-bHVmdGRhdGVucHVtcGUvc291cmNlL19faW5pdF9fLnB5) | `24.39% <0.00%> (ø)` | | | [luftdatenpumpe/grafana/\_\_init\_\_.py](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#diff-bHVmdGRhdGVucHVtcGUvZ3JhZmFuYS9fX2luaXRfXy5weQ==) | `43.75% <0.00%> (ø)` | | | [luftdatenpumpe/commands.py](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#diff-bHVmdGRhdGVucHVtcGUvY29tbWFuZHMucHk=) | `17.17% <0.00%> (ø)` | | | [luftdatenpumpe/source/eea.py](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#diff-bHVmdGRhdGVucHVtcGUvc291cmNlL2VlYS5weQ==) | `28.33% <0.00%> (ø)` | | | [luftdatenpumpe/source/openaq.py](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#diff-bHVmdGRhdGVucHVtcGUvc291cmNlL29wZW5hcS5weQ==) | `13.69% <0.00%> (ø)` | | | ... and [5 more](https://codecov.io/gh/earthobservations/luftdatenpumpe/pull/60/diff?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations) | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.