Skip to content

Sync #390

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

Merged
rosafilgueira merged 5 commits into from
Jan 11, 2023
Merged

Sync #390

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4158f16
README
rosafilgueira Jan 11, 2023
a9ffde8
Merge branch 'dev' of https://github.com/SoftwareUnderstanding/inspec…
rosafilgueira Jan 11, 2023
b8c952d
Merge branch 'dev' of https://github.com/SoftwareUnderstanding/inspec…
rosafilgueira Jan 11, 2023
b09b8e2
Merge pull request #389 from SoftwareUnderstanding/main
rosafilgueira Jan 11, 2023
76a2b4b
Merge branch 'dev' of https://github.com/SoftwareUnderstanding/inspec…
rosafilgueira Jan 11, 2023
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
5 changes: 1 addition & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,13 +157,11 @@ docker run -it -v -v $PWD:/out --rm inspect4py:1.0 /bin/bash
root@e04792563e6a:/# inspect4py -i /out/path/to/repo
```

<!--
Other useful commands when using Docker:
```
docker cp [OPTIONS] CONTAINER:SRC_PATH DEST_PATH|-
docker image rm -f inspect4py:1.0
```
-->

## Execution

Expand All @@ -173,17 +171,16 @@ For example, it can be used to inspect all the python files of a given GitHub re
The tool by default stores the results in the `OutputDir` directory, but users can specify their own directory name by using `-o` or `--output` flags.


<!--
```
inspect4py --input_path <FILE.py | DIRECTORY> [--output_dir "OutputDir", --ignore_dir_pattern "__", ignore_file_pattern "__" --requirements --html_output]
```
-->

For clarity, we have added a `help` command to explain each input parameter:

```
inspect4py --help

```
Usage: inspect4py [OPTIONS]

Options:
Expand Down