Skip to content

Commit

Permalink
🎨 lint: Apply prettier on yaml and markdown files
Browse files Browse the repository at this point in the history
and fix typo on library name in contribute.md
  • Loading branch information
azogue committed Nov 24, 2023
1 parent 536c081 commit 11ac370
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 38 deletions.
28 changes: 14 additions & 14 deletions .github/workflows/poetry-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ jobs:
if: github.repository == 'sabuhish/fastapi-mqtt'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v1
with:
python-version: '3.8'
architecture: x64
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install poetry
- uses: actions/checkout@v2
- uses: actions/setup-python@v1
with:
python-version: "3.8"
architecture: x64
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install poetry
- name: Build and publish
run: |
poetry version $(git describe --tags --abbrev=0)
poetry build
poetry publish --username ${{ secrets.PYPI_USERNAME }} --password ${{ secrets.PYPI_PASSWORD }}
- name: Build and publish
run: |
poetry version $(git describe --tags --abbrev=0)
poetry build
poetry publish --username ${{ secrets.PYPI_USERNAME }} --password ${{ secrets.PYPI_PASSWORD }}
6 changes: 3 additions & 3 deletions .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ jobs:
- name: Start Mosquitto MQTT broker
uses: namoshek/mosquitto-github-action@v1
with:
version: '1.6.15'
ports: '1883:1883 9001:9001'
container-name: 'mqtt'
version: "1.6.15"
ports: "1883:1883 9001:9001"
container-name: "mqtt"

- name: Check out repository
uses: actions/checkout@v3
Expand Down
19 changes: 8 additions & 11 deletions docs/contribute.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,22 @@
Contributing to fastapi-mqtt
=========================================
# Contributing to fastapi-mqtt

We welcome contributions to [fastapi-mqtt](https://github.com/sabuhish/fastapi-mqtt)

Issues
------
## Issues

Feel free to submit issues and enhancement requests.

[Fastapi-MQTT Issues](https://github.com/sabuhish/fastapi-mqtt/issues)

Contributing
------------
## Contributing

Please refer to each project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work
5. Submit a **Pull request** so that we can review your changes
1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work
5. Submit a **Pull request** so that we can review your changes

## Before contributing, here is how to install

Expand Down
12 changes: 6 additions & 6 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,11 @@ client has the following parameters. The class object holds session information
- client_id: Should be a unique identifier for connection to the MQTT broker.

- clean_session: Enables broker to establish a persistent session.
In a persistent session clean_session = False.
The broker stores all subscriptions for the client.
If the session is not persistent (clean_session = True).
The broker does not store anything for the client and \
purges all information from any previous persistent session.
The client_id identifies the session.
In a persistent session clean_session = False.
The broker stores all subscriptions for the client.
If the session is not persistent (clean_session = True).
The broker does not store anything for the client and \
purges all information from any previous persistent session.
The client_id identifies the session.

- optimistic_acknowledgement
1 change: 1 addition & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ source .venv/bin/activate

pip install fastapi-mqtt
```

Alternatively, if you prefer to use `poetry` for package dependencies:

```bash
Expand Down
8 changes: 4 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ theme:
repo: fontawesome/brands/github
repo_name: fastapi-mqtt
repo_url: https://github.com/sabuhish/fastapi-mqtt
edit_uri: ''
edit_uri: ""

plugins:
- search
- markdownextradata:
data: data
- search
- markdownextradata:
data: data

markdown_extensions:
- toc:
Expand Down

0 comments on commit 11ac370

Please sign in to comment.