Skip to content
This repository was archived by the owner on Apr 17, 2023. It is now read-only.

Update readme about Development Environments overview #36

Merged
merged 2 commits into from
Nov 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 11 additions & 11 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
{
"python.envFile": "${workspaceFolder}/.env",
"python.formatting.yapfPath": "${workspaceFolder}/.venv/bin/yapf",
"python.languageServer": "Pylance",
"python.formatting.provider": "yapf",
"[python]": {
"editor.insertSpaces": true,
"editor.tabSize": 4,
Expand All @@ -13,10 +9,14 @@
"source.organizeImports": true
}
},
"isort.path": [
"${workspaceFolder}/.venv/bin/isort"
],
"python.envFile": "${workspaceFolder}/.env",
"python.languageServer": "Pylance",
"python.formatting.provider": "yapf",
"python.formatting.yapfPath": "${workspaceFolder}/.venv/bin/yapf",
"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.linting.pylintPath": "${workspaceFolder}/.venv/bin/pylint",
"python.linting.mypyEnabled": true,
"python.linting.mypyArgs": [
"--strict",
"--follow-imports=silent",
Expand All @@ -26,10 +26,13 @@
"--namespace-packages",
"--no-implicit-reexport"
],
"isort.path": [
"${workspaceFolder}/.venv/bin/isort"
],
"python.testing.pytestEnabled": true,
"python.testing.pytestArgs": [
"."
],
"python.testing.pytestEnabled": true,
"emeraldwalk.runonsave": {
"commands": [
{
Expand All @@ -38,9 +41,6 @@
}
]
},
"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.linting.mypyEnabled": true,
"[toml]": {
"editor.defaultFormatter": "tamasfe.even-better-toml"
}
Expand Down
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,19 @@ poetry add twitter-video-tools
- poetry
- code editor (vscode recommended)

### Quick Info of setups

- strict type checking using mypy
- amazing linters & formatters (`yapf`, `pylint`, `isort`)
- `unify` for forcing single-quote
- unit test using `pytest`
- vscode launch & formatting setups
### Overview of Development Environments

- Local
- vscode ready (launching, debugging, formatting)
- strict type checking using [mypy](https://github.com/python/mypy) & [pyright](https://github.com/microsoft/pyright)
- amazing linters & formatters ([`yapf`](https://github.com/google/yapf), [`pylint`](https://github.com/PyCQA/pylint), [`isort`](https://github.com/PyCQA/isort))
- `unify` for forcing single-quote
- unit test using [`pytest`](https://github.com/myint/unify)

- GitHub Actions
- [All PRs are statically analyzed & checked by `yapf`, `pylint`, `pyright`, `mypy`](https://github.com/code-yeongyu/TwitterVideoTools/actions/workflows/check_code.yaml)
- [All PRs are tested with `pytest`](https://github.com/code-yeongyu/TwitterVideoTools/actions/workflows/test.yaml)
- [Can be released with Github Action when creating GitHub Releases](https://github.com/code-yeongyu/TwitterVideoTools/actions/workflows/release.yaml)

### All-in-one

Expand Down