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

Commit 317b646

Browse files
committed
Update README.md
1 parent b2b8344 commit 317b646

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,37 @@ pip install twitter-video-tools
1616
```sh
1717
poetry add twitter-video-tools
1818
```
19+
20+
## Contribution
21+
22+
### Prerequisites
23+
24+
- Python 3.9
25+
- poetry
26+
- code editor (vscode recommended)
27+
28+
### Quick Info of setups
29+
30+
- strict type checking using mypy
31+
- amazing linters & formatters (`yapf`, `pylint`, `isort`)
32+
- `unify` for forcing single-quote
33+
- unit test using `pytest`
34+
- vscode launch & formatting setups
35+
36+
### All-in-one
37+
38+
```sh
39+
gh repo clone code-yeongyu/twitter_video_tools
40+
python3 -m pip install poetry
41+
poetry install # install dependencies
42+
code --install-extension emeraldwalk.RunOnSave # to force single quote
43+
```
44+
45+
Done!
46+
47+
### Test
48+
49+
```sh
50+
poetry shell
51+
inv test
52+
```

0 commit comments

Comments
 (0)