diff --git a/README.md b/README.md index 65c02c4..0ffb8a6 100644 --- a/README.md +++ b/README.md @@ -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 `contact@purpleair.com` 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) | | | --------------- | --------------- | --------------- | --------------- | @@ -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. ### PAA Multiple Sensor Request Example @@ -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. The below snippet is taken From the PurpleAirAPI (PAA) documentation: @@ -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. @@ -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. \ No newline at end of file +See this [file](./sample_json_config_files/sample_local_sensor_request_json_file.json) for an example. diff --git a/setup.cfg b/setup.cfg index b9bee89..ffda4d6 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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]