Skip to content

How to extend the dataset [README.md] #238

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
babenek merged 2 commits into from
Jul 21, 2025
Merged

How to extend the dataset [README.md] #238

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1d0b03
readme, closes #76
babenek Jul 21, 2025
4ccb2dc
Merge branch 'main' into main
babenek Jul 21, 2025
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
* [Benchmark](#benchmark)
* [Main Requirements](#main-requirements)
* [Installation](#installation)
* [How to extend the dataset](#how-to-extend-the-dataset)
* [How to run](#how-to-run)
* [Benchmark Result](#benchmark-result)
* [Used Tools for Benchmarking](#used-tools-for-benchmarking)
Expand Down Expand Up @@ -265,6 +266,19 @@ $ source venv/bin/activate
$ pip install -qr requirements.txt
```

### How to extend the dataset

1. Find an interesting repo and commit
2. add to snapshot.json the data:
``` json
"{commit_hash}{any_padding_hex_symbols_to_64}": "https://github.com/org/repo",
```
3. run download_data.py twice (first - a meta file will be created, second - all files from the commit will be downloaded)
4. run CredSweeper for the downloaded data to obtain a report (preferred with ``--ml_threshold 0`` argument)
5. run benchmark for the report with ``--fix`` option - all found values will be inserted into meta
6. review, correct markup if necessary, produce empty benchmark report for CI, commit the changes


### How to run
``` bash
usage: python -m benchmark [-h] --scanner [SCANNER]
Expand Down
Loading