Skip to content

Commit 6c663cf

Browse files
authored
Migrate to poetry (#35)
1 parent 798d97a commit 6c663cf

File tree

6 files changed

+787
-50
lines changed

6 files changed

+787
-50
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,20 +37,45 @@ python -m pip install -e .
3737

3838
To use the tool for Chef you also need Ruby and its Ripper package installed.
3939

40+
### Poetry
41+
42+
To install GLITCH using Poetry, run:
43+
```
44+
poetry install
45+
```
46+
47+
**WARNING**: _For now, the GLITCH VSCode extension does not function if GLITCH
48+
is installed via Poetry. Since Poetry uses virtual environments it does not
49+
create a binary for GLITCH available in the user's PATH, which is required for
50+
the VSCode extension._
51+
4052
## Usage
4153

42-
You can use the command to see all options:
54+
To explore all available options, use the command:
4355
```
4456
glitch --help
4557
```
4658

47-
To analyze a file or folder and get the csv results you can run:
59+
To analyze a file or folder and retrieve CSV results, use the following command:
4860
```
4961
glitch --tech (chef|puppet|ansible|terraform) --csv --config PATH_TO_CONFIG PATH_TO_FILE_OR_FOLDER
5062
```
5163

5264
If you want to consider the module structure you can add the flag ```--module```.
5365

66+
### Poetry
67+
68+
If GLITCH was installed using Poetry, execute GLITCH commands as follows:
69+
```
70+
poetry run glitch --help
71+
```
72+
73+
Alternatively, you can use `poetry shell`:
74+
```
75+
poetry shell
76+
glitch --help
77+
```
78+
5479
## Tests
5580

5681
To run the tests for GLITCH go to the folder ```glitch``` and run:

0 commit comments

Comments
 (0)