Skip to content

refactor: github-url added instead of github-project-folder and github-files options #245

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
Artanias merged 15 commits into from
Dec 5, 2025
Merged

refactor: github-url added instead of github-project-folder and github-files options #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
7b007f1
github-url added, github-project-folder github-files removed
PeeachPie Nov 7, 2025
7d4caa4
lint fix
PeeachPie Nov 7, 2025
49fddeb
lint fix
PeeachPie Nov 7, 2025
8c6e372
lint fix
PeeachPie Nov 7, 2025
df941ab
lint fix
PeeachPie Nov 7, 2025
2bf517b
lint fix
PeeachPie Nov 7, 2025
97f0905
Merge branch 'main' into github_url_arg
PeeachPie Nov 8, 2025
fe7ab23
definition of the content type is delegated to the GithubParser
PeeachPie Nov 8, 2025
0903b9e
definition of the content type is delegated to the GithubParser
PeeachPie Nov 8, 2025
88d74b5
async_github_parser updated
PeeachPie Nov 29, 2025
b329a90
merge
PeeachPie Dec 1, 2025
8164d1b
refactored
PeeachPie Dec 2, 2025
59ade5b
i18n: updates translates.
Artanias Dec 5, 2025
875eafb
doc: updates usecases.ipynb.
Artanias Dec 5, 2025
34774b3
doc: updates usecases.ipynb with async GitHub parser.
Artanias Dec 5, 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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,17 +151,17 @@ If you want to use MongoDB cache for saving reports and works metadata, complete
$ codeplag check --extension py --files src/codeplag/pyplag/astwalkers.py --directories src/codeplag/pyplag
$ codeplag check --extension py --directories src/codeplag/algorithms src
$ codeplag check --extension py --files src/codeplag/pyplag/astwalkers.py --github-user OSLL --repo-regexp code- --all-branches
$ codeplag check --extension py --github-files https://github.com/OSLL/code-plagiarism/blob/main/src/codeplag/pyplag/utils.py --github-user OSLL --repo-regexp code- --all-branches
$ codeplag check --extension py --github-files https://github.com/OSLL/code-plagiarism/blob/main/src/codeplag/pyplag/utils.py --directories src/codeplag/pyplag/
$ codeplag check --extension py --github-urls https://github.com/OSLL/code-plagiarism/blob/main/src/codeplag/pyplag/utils.py --github-user OSLL --repo-regexp code- --all-branches
$ codeplag check --extension py --github-urls https://github.com/OSLL/code-plagiarism/blob/main/src/codeplag/pyplag/utils.py --directories src/codeplag/pyplag/
$ codeplag check --extension py --directories src/ --github-user OSLL --repo-regexp code-
$ codeplag check --extension py --github-project-folders https://github.com/OSLL/code-plagiarism/blob/main/src/codeplag/pyplag --github-user OSLL --repo-regexp code-
$ codeplag check --extension py --github-project-folders https://github.com/OSLL/code-plagiarism/blob/main/src/codeplag/pyplag --directories src/codeplag/pyplag/
$ codeplag check --extension py --github-urls https://github.com/OSLL/code-plagiarism/blob/main/src/codeplag/pyplag --github-user OSLL --repo-regexp code-
$ codeplag check --extension py --github-urls https://github.com/OSLL/code-plagiarism/blob/main/src/codeplag/pyplag --directories src/codeplag/pyplag/
```
- C++/C analyzer:
```
$ codeplag check --extension cpp --directories src/codeplag/cplag/tests/data src/ --files test/codeplag/cplag/data/sample1.cpp test/codeplag/cplag/data/sample2.cpp
$ codeplag check --extension cpp --github-files https://github.com/OSLL/code-plagiarism/blob/main/test/codeplag/cplag/data/sample3.cpp https://github.com/OSLL/code-plagiarism/blob/main/test/codeplag/cplag/data/sample4.cpp
$ codeplag check --extension cpp --github-project-folders https://github.com/OSLL/code-plagiarism/tree/main/test
$ codeplag check --extension cpp --github-urls https://github.com/OSLL/code-plagiarism/blob/main/test/codeplag/cplag/data/sample3.cpp https://github.com/OSLL/code-plagiarism/blob/main/test/codeplag/cplag/data/sample4.cpp
$ codeplag check --extension cpp --github-urls https://github.com/OSLL/code-plagiarism/tree/main/test
$ codeplag check --extension cpp --github-user OSLL --repo-regexp "code-plag"
```
- Create html report: `codeplag report create --path /usr/src/works`
147 changes: 100 additions & 47 deletions docs/notebooks/usecases.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

48 changes: 22 additions & 26 deletions locales/codeplag.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: codeplag 0.6.0\n"
"POT-Creation-Date: 2025-11-04 15:37+0300\n"
"Project-Id-Version: codeplag 0.6.1\n"
"POT-Creation-Date: 2025-12-02 18:35+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: Artyom Semidolin\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
Expand Down Expand Up @@ -154,7 +154,7 @@ msgstr ""
#: src/codeplag/codeplagcli.py:287
msgid ""
"A regular expression for filtering checked works by name. Used with "
"options 'directories', 'github-user' and 'github-project-folders'."
"options 'directories', 'github-user' and 'github-urls'."
msgstr ""

#: src/codeplag/codeplagcli.py:295
Expand All @@ -173,89 +173,85 @@ msgstr ""
msgid "A regular expression to filter searching repositories on GitHub."
msgstr ""

#: src/codeplag/codeplagcli.py:326
msgid "URL to file in a GitHub repository."
msgstr ""

#: src/codeplag/codeplagcli.py:332
#: src/codeplag/codeplagcli.py:322
msgid "GitHub organization/user name."
msgstr ""

#: src/codeplag/codeplagcli.py:339
msgid "URL to a GitHub project folder."
#: src/codeplag/codeplagcli.py:329
msgid "URL to a GitHub file or folder."
msgstr ""

#: src/codeplag/codeplagcli.py:350
#: src/codeplag/codeplagcli.py:340
#, python-brace-format
msgid ""
"Handling generated by the {util_name} reports as creating html report "
"file or show it on console."
msgstr ""

#: src/codeplag/codeplagcli.py:357
#: src/codeplag/codeplagcli.py:347
#, python-brace-format
msgid "Report commands of the '{util_name}' util."
msgstr ""

#: src/codeplag/codeplagcli.py:366
#: src/codeplag/codeplagcli.py:356
msgid "Generate general report from created some time ago report files."
msgstr ""

#: src/codeplag/codeplagcli.py:372
#: src/codeplag/codeplagcli.py:362
msgid ""
"Path to save generated report. If it's a directory, then create a file in"
" it."
msgstr ""

#: src/codeplag/codeplagcli.py:380
#: src/codeplag/codeplagcli.py:370
msgid "Type of the created report file."
msgstr ""

#: src/codeplag/codeplagcli.py:389
#: src/codeplag/codeplagcli.py:379
msgid ""
"Path to first compared works. Can be path to directory or URL to the "
"project folder."
msgstr ""

#: src/codeplag/codeplagcli.py:399
#: src/codeplag/codeplagcli.py:389
msgid ""
"Path to second compared works. Can be path to directory or URL to the "
"project folder."
msgstr ""

#: src/codeplag/codeplagcli.py:411
#: src/codeplag/codeplagcli.py:401
msgid ""
"Program help to find similar parts of source codes for the different "
"languages."
msgstr ""

#: src/codeplag/codeplagcli.py:417
#: src/codeplag/codeplagcli.py:407
msgid "Print current version number and exit."
msgstr ""

#: src/codeplag/codeplagcli.py:423
#: src/codeplag/codeplagcli.py:413
msgid "Commands help."
msgstr ""

#: src/codeplag/codeplagcli.py:438
#: src/codeplag/codeplagcli.py:428
msgid "No command is provided; please choose one from the available (--help)."
msgstr ""

#: src/codeplag/codeplagcli.py:449
#: src/codeplag/codeplagcli.py:439
msgid "There is nothing to modify; please provide at least one argument."
msgstr ""

#: src/codeplag/codeplagcli.py:453
#: src/codeplag/codeplagcli.py:443
msgid "The'repo-regexp' option requires the provided 'github-user' option."
msgstr ""

#: src/codeplag/codeplagcli.py:462
#: src/codeplag/codeplagcli.py:450
msgid ""
"The'path-regexp' option requires the provided 'directories', 'github-"
"user', or 'github-project-folder' options."
"user', or 'github-urls' options."
msgstr ""

#: src/codeplag/codeplagcli.py:472 src/codeplag/handlers/report.py:440
#: src/codeplag/codeplagcli.py:460 src/codeplag/handlers/report.py:440
msgid "All paths must be provided."
msgstr ""

Expand Down
52 changes: 24 additions & 28 deletions locales/translations/en/LC_MESSAGES/codeplag.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#
msgid ""
msgstr ""
"Project-Id-Version: codeplag 0.6.0\n"
"Project-Id-Version: codeplag 0.6.1\n"
"POT-Creation-Date: 2024-05-21 09:28+0300\n"
"PO-Revision-Date: 2025-03-28 12:05+0300\n"
"Last-Translator: Artyom Semidolin\n"
Expand Down Expand Up @@ -175,10 +175,10 @@ msgstr ""
#: src/codeplag/codeplagcli.py:287
msgid ""
"A regular expression for filtering checked works by name. Used with "
"options 'directories', 'github-user' and 'github-project-folders'."
"options 'directories', 'github-user' and 'github-urls'."
msgstr ""
"A regular expression for filtering checked works by name. Used with "
"options 'directories', 'github-user' and 'github-project-folders'."
"options 'directories', 'github-user' and 'github-urls'."

#: src/codeplag/codeplagcli.py:295
msgid "Ignore the threshold when checking of works."
Expand All @@ -196,19 +196,15 @@ msgstr "Searching in all branches."
msgid "A regular expression to filter searching repositories on GitHub."
msgstr "A regular expression to filter searching repositories on GitHub."

#: src/codeplag/codeplagcli.py:326
msgid "URL to file in a GitHub repository."
msgstr "URL to file in a GitHub repository."

#: src/codeplag/codeplagcli.py:332
#: src/codeplag/codeplagcli.py:322
msgid "GitHub organization/user name."
msgstr "GitHub organization/user name."

#: src/codeplag/codeplagcli.py:339
msgid "URL to a GitHub project folder."
msgstr "URL to a GitHub project folder."
#: src/codeplag/codeplagcli.py:329
msgid "URL to a GitHub file or folder."
msgstr "URL to a GitHub file or folder."

#: src/codeplag/codeplagcli.py:350
#: src/codeplag/codeplagcli.py:340
#, python-brace-format
msgid ""
"Handling generated by the {util_name} reports as creating html report "
Expand All @@ -217,80 +213,80 @@ msgstr ""
"Handling generated by the {util_name} reports as creating html report "
"file or show it on console."

#: src/codeplag/codeplagcli.py:357
#: src/codeplag/codeplagcli.py:347
#, python-brace-format
msgid "Report commands of the '{util_name}' util."
msgstr "Report commands of the '{util_name}' util."

#: src/codeplag/codeplagcli.py:366
#: src/codeplag/codeplagcli.py:356
msgid "Generate general report from created some time ago report files."
msgstr "Generate general report from created some time ago report files."

#: src/codeplag/codeplagcli.py:372
#: src/codeplag/codeplagcli.py:362
msgid ""
"Path to save generated report. If it's a directory, then create a file in"
" it."
msgstr ""
"Path to save generated report. If it's a directory, then create a file in"
" it."

#: src/codeplag/codeplagcli.py:380
#: src/codeplag/codeplagcli.py:370
msgid "Type of the created report file."
msgstr "Type of the created report file."

#: src/codeplag/codeplagcli.py:389
#: src/codeplag/codeplagcli.py:379
msgid ""
"Path to first compared works. Can be path to directory or URL to the "
"project folder."
msgstr ""
"Path to first compared works. Can be path to directory or URL to the "
"project folder."

#: src/codeplag/codeplagcli.py:399
#: src/codeplag/codeplagcli.py:389
msgid ""
"Path to second compared works. Can be path to directory or URL to the "
"project folder."
msgstr ""
"Path to second compared works. Can be path to directory or URL to the "
"project folder."

#: src/codeplag/codeplagcli.py:411
#: src/codeplag/codeplagcli.py:401
msgid ""
"Program help to find similar parts of source codes for the different "
"languages."
msgstr ""
"Program help to find similar parts of source codes for the different "
"languages."

#: src/codeplag/codeplagcli.py:417
#: src/codeplag/codeplagcli.py:407
msgid "Print current version number and exit."
msgstr "Print current version number and exit."

#: src/codeplag/codeplagcli.py:423
#: src/codeplag/codeplagcli.py:413
msgid "Commands help."
msgstr "Commands help."

#: src/codeplag/codeplagcli.py:438
#: src/codeplag/codeplagcli.py:428
msgid "No command is provided; please choose one from the available (--help)."
msgstr "No command is provided; please choose one from the available (--help)."

#: src/codeplag/codeplagcli.py:449
#: src/codeplag/codeplagcli.py:439
msgid "There is nothing to modify; please provide at least one argument."
msgstr "There is nothing to modify; please provide at least one argument."

#: src/codeplag/codeplagcli.py:453
#: src/codeplag/codeplagcli.py:443
msgid "The'repo-regexp' option requires the provided 'github-user' option."
msgstr "The'repo-regexp' option requires the provided 'github-user' option."

#: src/codeplag/codeplagcli.py:462
#: src/codeplag/codeplagcli.py:450
msgid ""
"The'path-regexp' option requires the provided 'directories', 'github-"
"user', or 'github-project-folder' options."
"user', or 'github-urls' options."
msgstr ""
"The'path-regexp' option requires the provided 'directories', 'github-"
"user', or 'github-project-folder' options."
"user', or 'github-urls' options."

#: src/codeplag/codeplagcli.py:472 src/codeplag/handlers/report.py:440
#: src/codeplag/codeplagcli.py:460 src/codeplag/handlers/report.py:440
msgid "All paths must be provided."
msgstr "All or none of the root paths must be specified."

Expand Down
Loading
Loading