Skip to content

Commit

Permalink
README: Document use of autopep8
Browse files Browse the repository at this point in the history
  • Loading branch information
fhemberger committed Sep 12, 2021
1 parent ce138bb commit 86d79ec
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Subscribes to one or more MQTT topics, and lets you configure prometheus metrics

[![Test with pytest](https://github.com/fhemberger/mqtt_exporter/actions/workflows/test.yml/badge.svg)](https://github.com/fhemberger/mqtt_exporter/actions/workflows/test.yml)[![CodeQL](https://github.com/fhemberger/mqtt_exporter/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/fhemberger/mqtt_exporter/actions/workflows/codeql-analysis.yml)


## Usage

- Create a folder to hold the config (default: `conf/`)
Expand Down Expand Up @@ -42,9 +43,9 @@ docker run -d \
- PyYAML
- yamlreader

## Testing
Functional tests are written in `pytest` (see [tests/readme.md](tests/readme.md)), code formatting uses [`autopep8`](https://pypi.org/project/autopep8/) with default settings. If you submit a PR to this repo, please make sure it follows its formatting guidelines.


pytest is used to test the functionality see [tests/readme.md](tests/readme.md)
## TODO

- Add persistence of metrics on restart

0 comments on commit 86d79ec

Please sign in to comment.