@@ -12,25 +12,38 @@ It can also ruin your day by letting you know how much your code sucks.
12
12
13
13
So like... enjoy.
14
14
15
- ## Deps
15
+ ## Deps 📦
16
16
17
17
It uses a bundle of different linters and a code formatter:
18
18
19
- [ bandit] ( https://bandit.readthedocs.io/ ) | [ black] ( https://github.com/psf/black ) | [ codespell] ( https://github.com/codespell-project/codespell ) | [ mypy] ( https://mypy.readthedocs.io/ ) | [ pylama] ( https://github.com/klen/pylama ) | [ pylint] ( https://github.com/pylint-dev/pylint ) | [ pyright] ( https://github.com/microsoft/pyright ) | [ ruff] ( https://github.com/astral-sh/ruff )
19
+ [ bandit] ( https://bandit.readthedocs.io/ )
20
+ | [ black] ( https://github.com/psf/black )
21
+ | [ codespell] ( https://github.com/codespell-project/codespell )
22
+ | [ mypy] ( https://mypy.readthedocs.io/ )
23
+ | [ pylama] ( https://github.com/klen/pylama )
24
+ | [ pylint] ( https://github.com/pylint-dev/pylint )
25
+ | [ pyright] ( https://github.com/microsoft/pyright )
26
+ | [ ruff] ( https://github.com/astral-sh/ruff )
20
27
21
- ## Installation
28
+ ## Installation 💾
22
29
23
- Just put it where your project is and install required modules:
30
+ Just put it where your project is and install the required modules:
31
+
32
+ ```
33
+ ./okrutnik.sh --install
34
+ ```
35
+
36
+ Include custom modules used in your project with ` -r requirements.txt ` :
24
37
25
38
```
26
39
./okrutnik.sh --install -r requirements.txt
27
40
```
28
41
29
- Okrutnik will create venv in .okrutnik_venv for itself and store its tools in ordor to perform a scan.
42
+ Okrutnik will create a virtual Python environment in .okrutnik_venv for itself and store its tools in order to perform a scan.
30
43
31
44
You can --update or --uninstall them at any time.
32
45
33
- ## Usage
46
+ ## Usage 🚀
34
47
35
48
```
36
49
./okrutnik.sh target.py
@@ -57,14 +70,14 @@ Standalone:
57
70
--safety Run safety check
58
71
```
59
72
60
- ## Screenshot
73
+ ## Screenshot 📸
61
74
62
75
<div align =" center " >
63
76
64
77
![ image] ( https://github.com/c0m4r/okrutnik/assets/6292788/667464d6-bbf2-4011-bddb-e3234b66b758 )
65
78
66
79
</div >
67
80
68
- ## Funding
81
+ ## Funding 💌
69
82
70
83
If you found this script helpful, please consider [ making donation] ( https://en.wosp.org.pl/fundacja/jak-wspierac-wosp/wesprzyj-online ) to a charity on my behalf. Thank you.
0 commit comments