add ruff formatting info and CI pipeline

This commit is contained in:
yedpodtrzitko 2024-05-01 15:19:20 +08:00
parent 1a7316d54c
commit 1030328420
3 changed files with 14 additions and 1 deletions

11
.github/workflows/ruff.yaml vendored Normal file
View file

@ -0,0 +1,11 @@
name: Ruff
on: [ push, pull_request ]
jobs:
ruff:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: chartboost/ruff-action@v1
with:
version: 0.4.2
args: 'format --check'

View file

@ -276,4 +276,4 @@ As of right now, no. However, I _did_ have a CLI version in the recent past befo
**Yes!!** I recommend taking a look at the [Priority Features](#priority-features), [Future Features](#future-features), and [Features I Won't Pull](#features-i-likely-wont-addpull) lists, as well as the project issues to see whats currently being worked on. Please do not submit pull requests with new feature additions without opening up an issue with a feature request first.
As of writing I dont have a concrete style guide, just try to stay within or close enough to the [PEP 8](https://peps.python.org/pep-0008/) style guide and/or match the style of the existing code.
Code formatting is automatically checked via [ruff](https://docs.astral.sh/ruff/). To format your code, install ruff via `pip install -r requirements-dev.txt` and run `ruff format`

2
pyproject.toml Normal file
View file

@ -0,0 +1,2 @@
[tool.ruff]
exclude = ["main_window.py", "home_ui.py"]