Skip to content

Commit

Permalink
- fixing syntax in README.md
Browse files Browse the repository at this point in the history
- fixing syntax in setup.cfg
  • Loading branch information
carlkidcrypto committed Dec 13, 2023
1 parent 940e449 commit c468349
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
A set of data logger(s) that will query purple air sensor(s) for data. That data will then be ingested into a TimeScaleDB PostGreSQL database, CSV files, or a SQLite3 database. To use these tools a PurpleAPI key is required. You can get API keys by sending an email to `[email protected]` with a first and last name to assign them to.

| [![Behave Tests](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/behave_tests.yml/badge.svg?branch=main)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/behave_tests.yml) | [![PyPI Distributions](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/build_and_publish_to_pypi.yml/badge.svg?branch=main)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/build_and_publish_to_pypi.yml) | [![TestPyPI Distributions](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/build_and_publish_to_test_pypi.yml/badge.svg?branch=main)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/build_and_publish_to_test_pypi.yml) | [![Black](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/black.yml/badge.svg)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/black.yml) |
| --------------- | --------------- | --------------- | --------------- |


| --------------- | --------------- | --------------- | --------------- |

| [![Pull Request Sphinx Docs Check](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/sphinx_build.yml/badge.svg)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/sphinx_build.yml) | [![pages-build-deployment](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/pages/pages-build-deployment) | [![CodeQL](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/github-code-scanning/codeql) | |
| --------------- | --------------- | --------------- | --------------- |
Expand Down Expand Up @@ -175,7 +173,6 @@ Out of the parameters in the file below "sensor_index" is required. The others a
See this [file](./sample_json_config_files/sample_single_sensor_request_json_file.json) for an example.
> Note: `poll_interval_seconds` is also required. It can not be lower than `60`. This is a custom field not defined by the PAA documentation.
> Note: Refer to the PurpleAirAPI (PAA) documentation for more information. <https://api.purpleair.com/#api-sensors-get-sensor-data>
### PAA Multiple Sensor Request Example
Expand All @@ -185,7 +182,6 @@ Out of the parameters in the file below "fields" is required. The others are all
See this [file](./sample_json_config_files/sample_multiple_sensor_request_json_file.json) for an example.
> Note: `poll_interval_seconds` is also required. It can not be lower than `60`. This is a custom field not defined by the PAA documentation.
> Note: Refer to the PurpleAirAPI (PAA) documentation for more information. <https://api.purpleair.com/#api-sensors-get-sensors-data>
The below snippet is taken From the PurpleAirAPI (PAA) documentation:
Expand Down Expand Up @@ -278,7 +274,6 @@ The rest of the settings are official PAA settings. They are the same as the [##
See this [file](./sample_json_config_files/sample_group_sensor_request_json_file.json) for an example.
### PAA Local Sensor Request Example
Out of the parameters in the file below all are custom settings and are required.
Expand All @@ -287,4 +282,4 @@ Out of the parameters in the file below all are custom settings and are required
`poll_interval_seconds` - The poll interval to get information from local sensors on the network.
See this [file](./sample_json_config_files/sample_local_sensor_request_json_file.json) for an example.
See this [file](./sample_json_config_files/sample_local_sensor_request_json_file.json) for an example.
3 changes: 2 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ platforms =
Windows 32/64
Linux 32/64
MacOS 32/64
description-file = README.md
long_description_content_type="text/markdown"
description_file = README.md
license_files = LICENSE

[options]
Expand Down

0 comments on commit c468349

Please sign in to comment.