Created frontend for repository_finder (formerly mining_repo_with_java)

Author: Andrei-Constantin-Programmer

README.md

@@ -6,8 +6,11 @@ Its role is to mine repositories (from the Apache Software Project) to see how m
 ## Table of Contents
 - [Installing](#installing)
 - [Run Analysis](#run-analysis)
-  - [Parameters](#parameters)
-  - [Help](#help)
+  - [Parameters](#analysis-parameters)
+  - [Help](#analysis-help)
+- [Run Repo Finder](#run-repo-finder)
+    - [Parameters](#repo-finder-parameters)
+    - [Help](#finder-help)
 - [Run Tests](#run-tests)
 
 ## Installing
@@ -31,7 +34,8 @@ python tdd_analysis.py  [--date DATE] [--language LANGUAGE] [--languages LANGUAG
                         [--verbose]
 ```
 
-### Parameters
+### Analysis Parameters
+
 - `--date DATE (optional)`: The date for the experiment in YYYY-MM-DD format. Defaults to a specific date in `tdd_analysis.py`.
 
 - `--language LANGUAGE (optional)`: Single programming language to analyse. Defaults to `Java`.
@@ -52,13 +56,38 @@ python tdd_analysis.py  [--date DATE] [--language LANGUAGE] [--languages LANGUAG
 
 - `--verbose (optional)`: Enable verbose output for debugging or detailed logs.  
 
-### Help
+
+### Analysis Help
 To display a help message with detailed usage instructions, run:
 
 ```bash
 python tdd_analysis.py --help
 ``` 
 
+## Run Repo Finder
+To execute the repo finder, use the command-line interface:
+```bash
+python find_repos.py  [--github_token TOKEN] [--organisation ORGANISATION] [--language LANGUAGE] [--pagination PAGINATION] [--maximum MAXIMUM]
+```
+
+### Repo Finder Parameters
+- `--github_token GITHUB_TOKEN`: Personal GitHub token. For information on how to create one, visit: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token
+  
+- `--language LANGUAGE`: Programming language to find repositories for.
+
+- `--organisation --org ORGANISATION (optional)`: Organisation to find repositories for. (default: Apache)
+      
+- `--pagination PAGINATION (optional)`: Pagination for searching GitHub. Defaults to 100.
+
+- `--maximum --max MAXIMUM (optional)`: Maximum number of repositories to find.
+
+### Finder Help
+To display a help message with detailed usage instructions, run:
+
+```bash
+python find_repos.py --help
+``` 
+
 ## Run Tests
 To run the unit tests, simply call:
 ```bash

find_repos.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python
+
+import argparse
+import asyncio
+import logging
+import sys
+from src.mining.repository_finder import RepositoryFinder
+
+def _get_parameters():
+    parser = argparse.ArgumentParser(
+        description="Find repositories on GitHub.",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    )
+
+    parser.add_argument(
+        "--github_token",
+        required=True,
+        type=str,
+        help="Personal GitHub token. For information on how to create one, visit: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token"
+    )
+    parser.add_argument(
+        "--language",
+        required=True,
+        type=str,
+        help="Programming language to find repositories for.",
+    )
+    parser.add_argument(
+        "--organisation",
+        "--org",
+        type=str,
+        default=RepositoryFinder.APACHE_ORGANISATION,
+        help="Organisation to find repositories for."
+    )
+    parser.add_argument(
+        "--pagination",
+        type=int,
+        default = 100,
+        help="Pagination for retrieving repositories."
+    )
+    parser.add_argument(
+        "--maximum",
+        "--max",
+        type=int,
+        help="Maximum number of repositories to find."
+    )
+
+    args = parser.parse_args()
+
+    if args.pagination < 1:
+        raise argparse.ArgumentError(None, "--pagination cannot be lower than 1.")
+    if args.maximum is not None and args.maximum < 1:
+        raise argparse.ArgumentError(None, "--maximum cannot be lower than 1.")
+    
+    return args
+
+async def main():
+    try:
+        args = _get_parameters()
+
+        repository_finder = RepositoryFinder(args.github_token)
+        repository_finder.extract_repositories(args.organisation.lower(), args.pagination, args.language.lower(), args.maximum)
+
+        print("Repository find complete.")
+
+    except Exception as e:
+        logging.exception(e)
+        print(f"Error: {e}", file=sys.stderr)
+        sys.exit(1)
+
+if __name__ == "__main__":
+    asyncio.run(main())

requirements.txt

@@ -4,4 +4,4 @@ pytest-asyncio
 matplotlib~=3.9.4
 tqdm
 requests
-numpy
+numpy