Skip to content

Manual linting #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Manual linting #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions {{cookiecutter.project_shortname}}/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,21 @@ pip install {{cookiecutter.project_shortname}}
```shell
npm run build
```
5. Code Formatting (optional):

This project uses:

- [Black](https://black.readthedocs.io/) for code formatting
- [isort](https://pycqa.github.io/isort/) for import sorting
- [Ruff](https://docs.astral.sh/ruff/) for linting

Run:

```bash
black .
isort .
ruff check . --fix
````

### Create a production build and publish:

Expand Down
10 changes: 10 additions & 0 deletions {{cookiecutter.project_shortname}}/pyptoject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[tool.black]
line-length = 88
target-version = ['py311']

[tool.isort]
profile = "black"

[tool.ruff]
line-length = 88
select = ["E", "F", "W"]
3 changes: 3 additions & 0 deletions {{cookiecutter.project_shortname}}/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
dash[dev]>=3.0.0
wheel
build
black
isort
ruff