Compare commits
202 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ac6ebc6d72 | ||
|
|
a12210cfa2 | ||
|
|
47e0b4c64a | ||
|
|
c4847773a0 | ||
|
|
832e887302 | ||
|
|
8487898f93 | ||
|
|
4d8b7394f0 | ||
|
|
e925c9cb8a | ||
|
|
dd2edfd204 | ||
|
|
13efce4f9c | ||
|
|
928ba6580f | ||
|
|
457c2a5472 | ||
|
|
c6c037247f | ||
|
|
f84fcf0d35 | ||
|
|
8424c94bec | ||
|
|
a14b356b18 | ||
|
|
f60f088f05 | ||
|
|
c2a5dc89ea | ||
|
|
6a7b61b1f2 | ||
|
|
4427f30f77 | ||
|
|
9982727de1 | ||
|
|
866621db18 | ||
|
|
48b86cb2d0 | ||
|
|
96b10f0bf9 | ||
|
|
53ccc9899b | ||
|
|
bb82427abe | ||
|
|
ee4af7d266 | ||
|
|
3bd6af4f28 | ||
|
|
7531aa4f02 | ||
|
|
f9d56c51a0 | ||
|
|
5bff3ccc12 | ||
|
|
272fcc36ed | ||
|
|
64c1063ea5 | ||
|
|
4c7109f4f0 | ||
|
|
d907167713 | ||
|
|
9eec2e323d | ||
|
|
ead76074f5 | ||
|
|
e87560939f | ||
|
|
3f1191758b | ||
|
|
34c7cd3918 | ||
|
|
52c4101a7a | ||
|
|
0677b901f7 | ||
|
|
49215fd03e | ||
|
|
8fc14d3ec4 | ||
|
|
3da2b91fb2 | ||
|
|
b6908a19f4 | ||
|
|
4db8300e2c | ||
|
|
07ca8c486c | ||
|
|
9473b0278d | ||
|
|
4113c62d09 | ||
|
|
f235bc1186 | ||
|
|
4d0e7beea7 | ||
|
|
7b1fd3addc | ||
|
|
3968f53e98 | ||
|
|
bd9c1f210f | ||
|
|
0518f33571 | ||
|
|
c783a717a0 | ||
|
|
ea3b8bcd71 | ||
|
|
cdf04fe443 | ||
|
|
f3b90f2e6d | ||
|
|
bf77bc4dfe | ||
|
|
157cb68142 | ||
|
|
53433c119b | ||
|
|
5d41e07bc2 | ||
|
|
331c81ac46 | ||
|
|
e3c151e2d3 | ||
|
|
a89596efc2 | ||
|
|
283a92fa84 | ||
|
|
beb8d561f8 | ||
|
|
b68842df1c | ||
|
|
dd7fcc455d | ||
|
|
b3ae15a062 | ||
|
|
4c8d3626b3 | ||
|
|
1f86ad4034 | ||
|
|
e151f81d76 | ||
|
|
a69fbf33d9 | ||
|
|
227fcd0482 | ||
|
|
8d04112d32 | ||
|
|
66373fd96e | ||
|
|
c4f1940bb6 | ||
|
|
f79813ed45 | ||
|
|
ffd162d881 | ||
|
|
558715fdab | ||
|
|
9984c71a57 | ||
|
|
bb2efb903b | ||
|
|
defe1b1159 | ||
|
|
347acea797 | ||
|
|
46937abb7e | ||
|
|
2963db3608 | ||
|
|
92d4f3f9f2 | ||
|
|
02df05df39 | ||
|
|
549f1940f9 | ||
|
|
e936525f81 | ||
|
|
29eb2bde95 | ||
|
|
d27d9b9168 | ||
|
|
a6ca1e3c0c | ||
|
|
5bf7ef3f39 | ||
|
|
ae73fdffde | ||
|
|
7c8fea02e6 | ||
|
|
40fffcab73 | ||
|
|
9a6127d6bc | ||
|
|
eb724f629f | ||
|
|
6d04b990db | ||
|
|
2537bcbab8 | ||
|
|
bb6c5a09e9 | ||
|
|
083d3e9f71 | ||
|
|
497c855648 | ||
|
|
c2641b3134 | ||
|
|
a108b4784e | ||
|
|
597ad07490 | ||
|
|
94c1e0a737 | ||
|
|
6e83bcf367 | ||
|
|
a57f5d47e2 | ||
|
|
3fa3e7a182 | ||
|
|
d42b7af59f | ||
|
|
8d337c621c | ||
|
|
5842a13975 | ||
|
|
e739f78eb9 | ||
|
|
26cf25bf91 | ||
|
|
ad6959d1b9 | ||
|
|
d7af8602fe | ||
|
|
29d40ec27e | ||
|
|
6a0953401b | ||
|
|
e87e5c64c8 | ||
|
|
c53ab2a00b | ||
|
|
b30ad16719 | ||
|
|
cfa032f7cb | ||
|
|
87f287bfb9 | ||
|
|
ab70a10d19 | ||
|
|
02e19baa93 | ||
|
|
0b76846968 | ||
|
|
9614785455 | ||
|
|
6ae34437a4 | ||
|
|
5a1b5378ee | ||
|
|
64d1b6bf38 | ||
|
|
09fffdf192 | ||
|
|
8e4520b6d2 | ||
|
|
420186bec4 | ||
|
|
758676ac88 | ||
|
|
310b1fb702 | ||
|
|
6822806a77 | ||
|
|
4eddd20480 | ||
|
|
95dcfbea6e | ||
|
|
258be0a2d7 | ||
|
|
3b329d039a | ||
|
|
fec88ac343 | ||
|
|
272cd49d0e | ||
|
|
cea07f187a | ||
|
|
0f96785123 | ||
|
|
000eb80fbc | ||
|
|
e4f1e2928a | ||
|
|
73fa406e82 | ||
|
|
e99e0c317e | ||
|
|
7d2eada3f9 | ||
|
|
f706a08859 | ||
|
|
b3ccb713e1 | ||
|
|
0bb330d771 | ||
|
|
df339d33df | ||
|
|
c296f09e0e | ||
|
|
04ea880276 | ||
|
|
eef44716d5 | ||
|
|
8eea84e546 | ||
|
|
acd65e7919 | ||
|
|
4a7b199929 | ||
|
|
2723e75735 | ||
|
|
0365616478 | ||
|
|
befd61eea0 | ||
|
|
daa426d73b | ||
|
|
22df1eae73 | ||
|
|
51c1efbcec | ||
|
|
d091125c15 | ||
|
|
e2c94fcc89 | ||
|
|
16f9a80818 | ||
|
|
66d7a2c42c | ||
|
|
456d46fdb1 | ||
|
|
539c540a72 | ||
|
|
db413767cd | ||
|
|
6a87cb51de | ||
|
|
f98bfb34f3 | ||
|
|
43637193de | ||
|
|
33d9c7f5f2 | ||
|
|
835a78284b | ||
|
|
4dc2dced32 | ||
|
|
4b18c0307e | ||
|
|
0ec3100347 | ||
|
|
bb287acfe2 | ||
|
|
7a6015b8e4 | ||
|
|
d0f5c660b5 | ||
|
|
2e65cfcb79 | ||
|
|
41f392f5a0 | ||
|
|
18bcc06070 | ||
|
|
c9cf000b23 | ||
|
|
11e55f7804 | ||
|
|
96c62c7097 | ||
|
|
587641cd18 | ||
|
|
d1ad3d14b9 | ||
|
|
0e3568f967 | ||
|
|
51d27c4996 | ||
|
|
ae9d9f4af5 | ||
|
|
482f2ee55a | ||
|
|
9894b15209 | ||
|
|
4d563683d2 |
72
.github/workflows/codeql.yml
vendored
Normal file
@@ -0,0 +1,72 @@
|
||||
# For most projects, this workflow file will not need changing; you simply need
|
||||
# to commit it to your repository.
|
||||
#
|
||||
# You may wish to alter this file to override the set of languages analyzed,
|
||||
# or to provide custom queries or build logic.
|
||||
#
|
||||
# ******** NOTE ********
|
||||
# We have attempted to detect the languages in your repository. Please check
|
||||
# the `language` matrix defined below to confirm you have the correct set of
|
||||
# supported CodeQL languages.
|
||||
#
|
||||
name: "CodeQL"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "master" ]
|
||||
pull_request:
|
||||
# The branches below must be a subset of the branches above
|
||||
branches: [ "master" ]
|
||||
schedule:
|
||||
- cron: '18 7 * * 3'
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
name: Analyze
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
actions: read
|
||||
contents: read
|
||||
security-events: write
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
language: [ 'python' ]
|
||||
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
|
||||
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v3
|
||||
|
||||
# Initializes the CodeQL tools for scanning.
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v2
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
# If you wish to specify custom queries, you can do so here or in a config file.
|
||||
# By default, queries listed here will override any specified in a config file.
|
||||
# Prefix the list here with "+" to use these queries and those in the config file.
|
||||
|
||||
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
|
||||
# queries: security-extended,security-and-quality
|
||||
|
||||
|
||||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
||||
# If this step fails, then you should remove it and run the build manually (see below)
|
||||
- name: Autobuild
|
||||
uses: github/codeql-action/autobuild@v2
|
||||
|
||||
# ℹ️ Command-line programs to run using the OS shell.
|
||||
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
|
||||
|
||||
# If the Autobuild fails above, remove it and uncomment the following three lines.
|
||||
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
|
||||
|
||||
# - run: |
|
||||
# echo "Run, Build Application using script"
|
||||
# ./location_of_script_within_repo/buildscript.sh
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@v2
|
||||
1
.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
__pycache__/
|
||||
11
Dockerfile
Normal file
@@ -0,0 +1,11 @@
|
||||
# syntax=docker/dockerfile:1
|
||||
|
||||
FROM python:latest
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY . .
|
||||
|
||||
RUN pip install --upgrade pip && pip install build && python -m build && pip install dist/*.whl
|
||||
|
||||
ENTRYPOINT ["octosuite"]
|
||||
48
README.md
@@ -1,14 +1,23 @@
|
||||

|
||||

|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
A framework for gathering open-source intelligence on GitHub users, repositories and organizations
|
||||
|
||||
> *Simply gather OSINT on Github users & organizations like a God🔥*
|
||||
[](https://github.com/bellingcat/octosuite/actions/workflows/python-publish.yml)
|
||||
[](https://github.com/bellingcat/octosuite/actions/workflows/codeql.yml)
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
# Installation
|
||||
[Refer to the Wiki](https://github.com/rly0nheart/octosuite/wiki) for installation instructions, in addition to all other documentation.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
|
||||
# Wiki
|
||||
[Refer to the Wiki](https://github.com/bellingcat/octosuite/wiki) for installation instructions, in addition to all other documentation.
|
||||
|
||||
# Features
|
||||
- [x] Fetches an organization's profile information
|
||||
@@ -40,26 +49,19 @@
|
||||
- [x] Searches commits
|
||||
- [x] Automatically logs network activity (.logs folder)
|
||||
- [x] User can view, read and delete logs
|
||||
- [x] More available...
|
||||
- [x] All the above can be used with command-line arguments (PyPI Package only)
|
||||
- [x] ...And more
|
||||
|
||||
## Note
|
||||
> Octosuite automatically logs network and user activity of each session, the logs are saved by date and time in the .logs folder
|
||||
|
||||
> *octosuite automatically logs network and minor user activity of each session. The logs are saved by date and time in the .logs folder*
|
||||
>> *Although octosuite was developed to work on **Mac**, **Windows**, or any **Linux** *Distribution*, it has only been tested on **Termux** *and* **Kali Linux***
|
||||
>>> *If you believe octosuite can be better, feel free to open a pull request with your improvements* ✌🏾🙂
|
||||
|
||||
# License
|
||||

|
||||
|
||||
|
||||
# About developer
|
||||
[About.me](https://about.me/rly0nheart)
|
||||
|
||||
|
||||
# Supporters
|
||||
[](https://github.com/rly0nheart/octosuite/stargazers)
|
||||
[](https://github.com/rly0nheart/octosuite/members)
|
||||
|
||||
|
||||
# Donations
|
||||
Love octosuite? Please consider buying me a coffee, I will really appreciate it. ☕👌🏾😊
|
||||
If you like OctoSuite and would like to show support, you can Buy A Coffee for the developer using the button below
|
||||
|
||||
<a href="https://www.buymeacoffee.com/189381184" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
|
||||
|
||||
Your support will be much appreciated😊
|
||||
|
||||
BIN
images/octosuite_app.png
Normal file
|
After Width: | Height: | Size: 1.2 MiB |
BIN
images/octosuite_app1.png
Normal file
|
After Width: | Height: | Size: 1.0 MiB |
BIN
images/octosuite_exe.png
Normal file
|
After Width: | Height: | Size: 1.1 MiB |
BIN
images/octosuite_gui_exe (1).png
Normal file
|
After Width: | Height: | Size: 248 KiB |
BIN
images/octosuite_gui_exe (2).png
Normal file
|
After Width: | Height: | Size: 264 KiB |
BIN
images/octosuite_gui_exe (3).png
Normal file
|
After Width: | Height: | Size: 257 KiB |
BIN
images/octosuite_gui_exe (4).png
Normal file
|
After Width: | Height: | Size: 234 KiB |
BIN
images/octosuite_gui_exe.png
Normal file
|
After Width: | Height: | Size: 207 KiB |
@@ -1,23 +1,23 @@
|
||||
import getpass
|
||||
from octosuite.colors import Color
|
||||
from octosuite.config import red, white, green, reset, Tree
|
||||
|
||||
'''
|
||||
Banner
|
||||
This class holds the program's banner logo and version tag
|
||||
'''
|
||||
class Banner:
|
||||
versionTag = '2.1.0'
|
||||
nameLogo = f'''{Color.white}
|
||||
|
||||
# banner.py
|
||||
# This file holds the program's banner and version tag
|
||||
version_tag = "3.0.1"
|
||||
|
||||
|
||||
def banner():
|
||||
banner_tree = Tree(getpass.getuser())
|
||||
banner_tree.add(f"use ‘{green}help{reset}’ command for usage")
|
||||
banner_tree.add(f"commands are case insensitive\n")
|
||||
return f"""
|
||||
_______ __ _______ __ __
|
||||
| |.----.| |_.-----.| __|.--.--.|__| |_.-----.
|
||||
| - || __|| _| _ ||__ || | || | _| -__|
|
||||
|_______||____||____|_____||_______||_____||__|____|_____|
|
||||
v{versionTag}
|
||||
{Color.white}— Advanced Github {Color.red}OSINT{Color.white} Framework{Color.reset}
|
||||
v{version_tag}#dev
|
||||
{white}— Advanced Github {red}OSINT{white} Framework
|
||||
|
||||
|
||||
|
||||
.:{getpass.getuser()}:.
|
||||
{Color.white}├─ use {Color.green}help{Color.reset}{Color.white} command for usage{Color.reset}
|
||||
{Color.white}└╼ commands are case insensitive{Color.reset}
|
||||
'''
|
||||
""", banner_tree
|
||||
|
||||
@@ -1,55 +0,0 @@
|
||||
import sys
|
||||
import platform
|
||||
from datetime import datetime
|
||||
|
||||
# The Color class is responsible for enabling/disabling colors in OctoSuite
|
||||
# This class gets called first at start up before any other class/method gets called (makes one think why this is not the firstBlood class)
|
||||
# Color class is the reason why users get to choose whether to enable/disable colors
|
||||
# Unfortunately for our friends the 'non-Linux' users, they will not yet have the opportunity to see what OctoSuite looks like with colors enabled lol
|
||||
class Color:
|
||||
colors = True
|
||||
# Colors will be unavailable on non-linux machines
|
||||
if sys.platform.lower().startswith(("os", "win", "darwin","ios")):
|
||||
colors = False
|
||||
|
||||
if not colors:
|
||||
reset = red = white = green = red_bg = ""
|
||||
|
||||
else:
|
||||
# Printing system information was completely unnecessary (just like most things in this program :D)
|
||||
# But at least users will get to know things they did not know about their machines ;)
|
||||
date_time = datetime.now()
|
||||
sys_info = [("Processor",platform.processor),
|
||||
("Node", platform.node),
|
||||
("Release", platform.release),
|
||||
("Architecture", platform.architecture),
|
||||
("Version", platform.version)]
|
||||
|
||||
banner = f"""
|
||||
OCTOSUITE © 2022 Richard Mwewa
|
||||
{date_time.strftime('%A %d %B %Y, %H:%M:%S%p')}
|
||||
|
||||
|
||||
|
||||
{platform.system()}"""
|
||||
print(banner)
|
||||
for key, value in sys_info:
|
||||
print(f"\t├─ {key}: {value()}")
|
||||
print("\n")
|
||||
while True:
|
||||
try:
|
||||
color_chooser = input(f"[ ? ] Welcome, would you like to enable colors for this session? (Y/n) ")
|
||||
if color_chooser.lower() == "y":
|
||||
white = "\033[97m"
|
||||
red = "\033[91m"
|
||||
reset = "\033[0m"
|
||||
green = "\033[92m"
|
||||
break
|
||||
elif color_chooser.lower() == "n":
|
||||
red = white = green = red_bg = reset = ""
|
||||
break
|
||||
else:
|
||||
print(f"\n[ ! ] Your response ({color_chooser}) is invalid (expected y or n) ")
|
||||
|
||||
except KeyboardInterrupt:
|
||||
exit(f"[ ! ] Process interrupted with [Ctrl+C].")
|
||||
200
octosuite/config.py
Normal file
@@ -0,0 +1,200 @@
|
||||
import psutil
|
||||
import platform
|
||||
import argparse
|
||||
from rich.tree import Tree
|
||||
from rich.text import Text
|
||||
from rich.table import Table
|
||||
from datetime import datetime
|
||||
from rich import print as xprint
|
||||
from rich.prompt import Prompt, Confirm
|
||||
|
||||
|
||||
def usage():
|
||||
return """
|
||||
Basic Usage
|
||||
===========
|
||||
|
||||
Get User Profile Info
|
||||
---------------------
|
||||
octosuite --method user_profile --username <username>
|
||||
|
||||
|
||||
Get User Repos
|
||||
--------------
|
||||
octosuite --method user_repos --username <username>
|
||||
|
||||
|
||||
Get Organi[sz]ation Profile Info
|
||||
-----------------------------
|
||||
octosuite --method org_profile --organization <organization_name>
|
||||
|
||||
|
||||
Get Organi[sz]ation Repos
|
||||
-----------------------------
|
||||
octosuite --method org_repos --organization <organization_name>
|
||||
|
||||
|
||||
Get Repo Profile Info
|
||||
---------------------
|
||||
octosuite --method repo_profile --username <username> --repository <repo_name>
|
||||
|
||||
|
||||
Get Repo Forks
|
||||
--------------
|
||||
octosuite --method repo_forks --username <username> --repository <repo_name>
|
||||
|
||||
|
||||
|
||||
Searching
|
||||
=========
|
||||
|
||||
Search Users
|
||||
------------
|
||||
octosuite --method users_search --query <query>
|
||||
|
||||
|
||||
Search Issues
|
||||
-------------
|
||||
octosuite --method issues_search --query <query>
|
||||
|
||||
|
||||
Search Commits
|
||||
--------------
|
||||
octosuite --method commits_search --query <query>
|
||||
|
||||
|
||||
Search Topics
|
||||
-------------
|
||||
octosuite --method topics_search --query <query>
|
||||
|
||||
|
||||
Search Repositories
|
||||
-------------------
|
||||
octosuite --method repos_search --query <query>
|
||||
|
||||
|
||||
|
||||
Log Management
|
||||
==============
|
||||
|
||||
View logs
|
||||
---------
|
||||
octosuite --method view_logs
|
||||
|
||||
|
||||
Read log
|
||||
--------
|
||||
octosuite --method read_log --log-file <log_file>
|
||||
|
||||
|
||||
Delete log
|
||||
----------
|
||||
octosuite --method delete_log --log-file <log_file>
|
||||
|
||||
|
||||
Clear logs
|
||||
----------
|
||||
octosuite --method clear_logs
|
||||
|
||||
|
||||
|
||||
CSV Management
|
||||
==============
|
||||
|
||||
View CSV
|
||||
---------
|
||||
octosuite --method view_csv
|
||||
|
||||
|
||||
Read CSV
|
||||
--------
|
||||
octosuite --method read_csv --csv-file <csv_file>
|
||||
|
||||
|
||||
Delete CSV
|
||||
----------
|
||||
octosuite --method delete_csv --csv-file <csv_file>
|
||||
|
||||
|
||||
Clear CSV's
|
||||
-----------
|
||||
octosuite --method clear_csv
|
||||
"""
|
||||
|
||||
|
||||
def create_parser():
|
||||
parser = argparse.ArgumentParser(description='OCTOSUITE: Advanced GitHub osint framework — by Richard Mwewa | https://about.me/rly0nheart', usage=usage())
|
||||
parser.add_argument('-m', '--method', help='method', choices=['user_profile', 'user_repos', 'user_gists', 'user_orgs', 'user_events',
|
||||
'user_subscriptions', 'user_following', 'user_followers', 'user_follows',
|
||||
'org_profile', 'org_repos', 'org_events', 'org_member',
|
||||
'repo_profile', 'repo_contributors', 'repo_stargazers', 'repo_forks',
|
||||
'repo_issues', 'repo_releases', 'repo_path_contents', 'users_search', 'issues_search',
|
||||
'commits_search', 'topics_search', 'repos_search', 'view_logs', 'read_log', 'delete_log',
|
||||
'clear_logs', 'view_csv', 'read_csv', 'delete_csv', 'clear_csv', 'about', 'author'])
|
||||
parser.add_argument('-u', '--username', help='username')
|
||||
parser.add_argument('-uB', '--username_b', help='username_B (used with user_follows)')
|
||||
parser.add_argument('-o', '--organization', '--organisation', help='organi[sz]ation name')
|
||||
parser.add_argument('-r', '--repository', help='repository name')
|
||||
parser.add_argument('-p', '--path_name', help='path name (used with repo_path_contents)')
|
||||
parser.add_argument('-q', '--query', help='query (used with search methods)')
|
||||
parser.add_argument('-l', '--limit', help='output limit (used with methods that return results in bulk) (default: %(default)s)', default=10)
|
||||
parser.add_argument('-c', '--colors', '--colours', help='specify to run octosuite cli with colo[u]rs enabled', action='store_true')
|
||||
parser.add_argument('--csv_file', help='csv file (used with csv management methods)')
|
||||
parser.add_argument('--log_file', help='log file (used with logs management methods)')
|
||||
parser.add_argument('--log-to-csv', help='log output to a csv file', action='store_true', dest='log_csv')
|
||||
return parser
|
||||
|
||||
|
||||
parser = create_parser()
|
||||
args = parser.parse_args()
|
||||
|
||||
# This file is responsible for enabling/disabling colo[u]rs and configuring argparse in OctoSuite
|
||||
# This file gets called first at start up before any other file
|
||||
# config.py is the reason why users get to choose whether to enable/disable colo[u]rs, and call the program with command line arguments
|
||||
# delete this file (I dare you), the entire program breaks
|
||||
system_info = [("RAM", f"{str(round(psutil.virtual_memory().total / (1024.0 ** 3)))}GB"),
|
||||
("Node", platform.node()),
|
||||
("Release", platform.release()),
|
||||
("Version", platform.version()),
|
||||
("Processor", platform.processor()),
|
||||
("Architecture", platform.architecture())]
|
||||
first_banner = f"""
|
||||
OCTOSUITE © 2023 Richard Mwewa
|
||||
{datetime.now().strftime('%A %d %B %Y, %H:%M:%S%p')}
|
||||
|
||||
"""
|
||||
|
||||
if args.colors:
|
||||
header_title = "bold white"
|
||||
red = "[red]"
|
||||
white = "[white]"
|
||||
green = "[green]"
|
||||
yellow = "[yellow]"
|
||||
red_bold = "[white bold]"
|
||||
white_bold = "[white bold]"
|
||||
green_bold = "[green bold]"
|
||||
reset = "[/]"
|
||||
else:
|
||||
print(first_banner)
|
||||
system_tree = Tree(platform.system())
|
||||
for system_key, system_value in system_info:
|
||||
system_tree.add(f"{system_key}: {system_value}")
|
||||
xprint(system_tree)
|
||||
print("\n")
|
||||
try:
|
||||
color_chooser = Confirm.ask(f"Welcome, would you like to enable colo(u)rs for this session?")
|
||||
if color_chooser:
|
||||
header_title = "bold white"
|
||||
red = "[red]"
|
||||
white = "[white]"
|
||||
green = "[green]"
|
||||
yellow = "[yellow]"
|
||||
red_bold = "[white bold]"
|
||||
white_bold = "[white bold]"
|
||||
green_bold = "[green bold]"
|
||||
reset = "[/]"
|
||||
else:
|
||||
header_title = red = white = green = red_bold = white_bold = green_bold = reset = yellow = ""
|
||||
except KeyboardInterrupt:
|
||||
exit(f"[WARNING] Process interrupted with Ctrl+C.")
|
||||
|
||||
@@ -1,446 +1,442 @@
|
||||
import os
|
||||
import csv
|
||||
import sys
|
||||
import logging
|
||||
from octosuite.sign_vars import SignVar
|
||||
from octosuite.log_roller import logRoller
|
||||
|
||||
'''
|
||||
csvLogger
|
||||
This class holds the methods for creating .csv files of each functionality in main
|
||||
'''
|
||||
class csvLogger:
|
||||
# .csv for organization' profile
|
||||
def logOrgProfile(response):
|
||||
org_profile_fields = ['Profile photo', 'Name', 'Username', 'ID', 'Node ID', 'Email', 'About', 'Location', 'Blog', 'Followers', 'Following', 'Twitter handle', 'Gists', 'Repositories', 'Account type', 'Is verified?', 'Has organization projects?', 'Has repository projects?', 'Created at', 'Updated at']
|
||||
org_profile_row = [response.json()['avatar_url'], response.json()['name'], response.json()['login'], response.json()['id'], response.json()['node_id'], response.json()['email'], response.json()['description'], response.json()['location'], response.json()['blog'], response.json()['followers'], response.json()['following'], response.json()['twitter_username'], response.json()['public_gists'], response.json()['public_repos'], response.json()['type'], response.json()['is_verified'], response.json()['has_organization_projects'], response.json()['has_repository_projects'], response.json()['created_at'], response.json()['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{response.json()['name']}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(org_profile_fields)
|
||||
writecsv.writerow(org_profile_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
from rich import print as xprint
|
||||
from octosuite.log_roller import prompt_log_csv, logged_to_csv
|
||||
from octosuite.message_prefixes import PROMPT, WARNING, POSITIVE, NEGATIVE, INFO
|
||||
|
||||
|
||||
# Creating a .csv file of a user' profile
|
||||
def logUserProfile(response):
|
||||
user_profile_fields = ['Profile photo', 'Name', 'Username', 'ID', 'Node ID', 'Bio', 'Blog', 'Location', 'Followers', 'Following', 'Twitter handle', 'Gists', 'Repositories', 'Organization', 'Is hireable?', 'Is site admin?', 'Joined at', 'Updated at']
|
||||
user_profile_row = [response.json()['avatar_url'], response.json()['name'], response.json()['login'], response.json()['id'], response.json()['node_id'], response.json()['bio'], response.json()['blog'], response.json()['location'], response.json()['followers'], response.json()['following'], response.json()['twitter_username'], response.json()['public_gists'], response.json()['public_repos'], response.json()['company'], response.json()['hireable'], response.json()['site_admin'], response.json()['created_at'], response.json()['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{response.json()['login']}.csv", 'w',) as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(user_profile_fields)
|
||||
writecsv.writerow(user_profile_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
# csv_loggers.py
|
||||
# This file holds the functions for creating .csv files of each functionality in main
|
||||
def log_org_profile(response):
|
||||
org_profile_fields = ['Profile photo', 'Name', 'Username', 'ID', 'Node ID', 'Email', 'About', 'Location', 'Blog',
|
||||
'Followers', 'Following', 'Twitter handle', 'Gists', 'Repositories', 'Account type',
|
||||
'Is verified?', 'Has organization projects?', 'Has repository projects?', 'Created at',
|
||||
'Updated at']
|
||||
org_profile_row = [response.json()['avatar_url'], response.json()['name'], response.json()['login'],
|
||||
response.json()['id'], response.json()['node_id'], response.json()['email'],
|
||||
response.json()['description'], response.json()['location'], response.json()['blog'],
|
||||
response.json()['followers'], response.json()['following'], response.json()['twitter_username'],
|
||||
response.json()['public_gists'], response.json()['public_repos'], response.json()['type'],
|
||||
response.json()['is_verified'], response.json()['has_organization_projects'],
|
||||
response.json()['has_repository_projects'], response.json()['created_at'],
|
||||
response.json()['updated_at']]
|
||||
|
||||
with open(os.path.join("output", f"{response.json()['name']}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(org_profile_fields)
|
||||
write_csv.writerow(org_profile_row)
|
||||
|
||||
|
||||
# create .csv for repository profile
|
||||
def logRepoProfile(response):
|
||||
repo_profile_fields = [ 'Name','ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility', 'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?', 'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?', 'Has pages?', 'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at', 'Created at', 'Updated at']
|
||||
repo_profile_row = [response.json()['name'], response.json()['id'], response.json()['description'], response.json()['forks'], response.json()['stargazers_count'], response.json()['watchers'], response.json()['license'], response.json()['default_branch'], response.json()['visibility'], response.json()['language'], response.json()['open_issues'], response.json()['topics'], response.json()['homepage'], response.json()['clone_url'], response.json()['ssh_url'], response.json()['fork'], response.json()['allow_forking'], response.json()['private'], response.json()['archived'], response.json()['is_template'], response.json()['has_wiki'], response.json()['has_pages'], response.json()['has_projects'], response.json()['has_issues'], response.json()['has_downloads'], response.json()['pushed_at'], response.json()['created_at'], response.json()['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{response.json()['name']}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(repo_profile_fields)
|
||||
writecsv.writerow(repo_profile_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# create .csv for repository path contents
|
||||
def logRepoPathContents(content, repo_name):
|
||||
path_content_fields = ['Filename', 'Size (bytes)', 'Type', 'Path', 'SHA', 'URL']
|
||||
path_content_row = [content['name'], content['size'], content['type'], content['path'], content['sha'], content['html_url']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{content['name']}_content_from_{repo_name}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(path_content_fields)
|
||||
writecsv.writerow(path_content_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# create .csv for repository stargazer
|
||||
def logRepoStargazers(stargazer, repo_name):
|
||||
user_follower_fields = ['Profile photo', 'Username', 'ID', 'Node ID', 'Gravatar ID', 'Account type', 'Is site admin?', 'URL']
|
||||
user_follower_row = [stargazer['avatar_url'], stargazer['login'], stargazer['id'], stargazer['node_id'], stargazer['gravatar_id'], stargazer['type'], stargazer['site_admin'], stargazer['html_url']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{stargazer['login']}_stargazer_of_{repo_name}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(user_follower_fields)
|
||||
writecsv.writerow(user_follower_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
# Creating a .csv file of a user' profile
|
||||
def log_user_profile(response):
|
||||
user_profile_fields = ['Profile photo', 'Name', 'Username', 'ID', 'Node ID', 'Bio', 'Blog', 'Location', 'Followers',
|
||||
'Following', 'Twitter handle', 'Gists', 'Repositories', 'Organization', 'Is hireable?',
|
||||
'Is site admin?', 'Joined at', 'Updated at']
|
||||
user_profile_row = [response.json()['avatar_url'], response.json()['name'], response.json()['login'],
|
||||
response.json()['id'], response.json()['node_id'], response.json()['bio'],
|
||||
response.json()['blog'], response.json()['location'], response.json()['followers'],
|
||||
response.json()['following'], response.json()['twitter_username'],
|
||||
response.json()['public_gists'], response.json()['public_repos'], response.json()['company'],
|
||||
response.json()['hireable'], response.json()['site_admin'], response.json()['created_at'],
|
||||
response.json()['updated_at']]
|
||||
|
||||
with open(os.path.join("output", f"{response.json()['login']}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(user_profile_fields)
|
||||
write_csv.writerow(user_profile_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# create .csv for repository profile
|
||||
def log_repo_profile(response):
|
||||
repo_profile_fields = ['Name', 'ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility',
|
||||
'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?',
|
||||
'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?', 'Has pages?',
|
||||
'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at', 'Created at', 'Updated at']
|
||||
repo_profile_row = [response.json()['name'], response.json()['id'], response.json()['description'],
|
||||
response.json()['forks'], response.json()['stargazers_count'], response.json()['watchers'],
|
||||
response.json()['license'], response.json()['default_branch'], response.json()['visibility'],
|
||||
response.json()['language'], response.json()['open_issues'], response.json()['topics'],
|
||||
response.json()['homepage'], response.json()['clone_url'], response.json()['ssh_url'],
|
||||
response.json()['fork'], response.json()['allow_forking'], response.json()['private'],
|
||||
response.json()['archived'], response.json()['is_template'], response.json()['has_wiki'],
|
||||
response.json()['has_pages'], response.json()['has_projects'], response.json()['has_issues'],
|
||||
response.json()['has_downloads'], response.json()['pushed_at'], response.json()['created_at'],
|
||||
response.json()['updated_at']]
|
||||
|
||||
with open(os.path.join("output", f"{response.json()['name']}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(repo_profile_fields)
|
||||
write_csv.writerow(repo_profile_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# create .csv for repository forks
|
||||
def logRepoForks(fork, count):
|
||||
repo_fork_fields = [ 'Name','ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility', 'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?', 'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?', 'Has pages?', 'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at', 'Created at', 'Updated at']
|
||||
repo_fork_row = [fork['full_name'], fork['id'], fork['description'], fork['forks'], fork['stargazers_count'], fork['watchers'], fork['license'], fork['default_branch'], fork['visibility'], fork['language'], fork['open_issues'], fork['topics'], fork['homepage'], fork['clone_url'], fork['ssh_url'], fork['fork'], fork['allow_forking'], fork['private'], fork['archived'], fork['is_template'], fork['has_wiki'], fork['has_pages'], fork['has_projects'], fork['has_issues'], fork['has_downloads'], fork['pushed_at'], fork['created_at'], fork['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{fork['name']}_fork_{count}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(repo_fork_fields)
|
||||
writecsv.writerow(repo_fork_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
# create .csv for repository path contents
|
||||
def log_repo_path_contents(content, repo_name):
|
||||
path_content_fields = ['Filename', 'Size (bytes)', 'Type', 'Path', 'SHA', 'URL']
|
||||
path_content_row = [content['name'], content['size'], content['type'], content['path'], content['sha'],
|
||||
content['html_url']]
|
||||
|
||||
with open(os.path.join("output", f"{content['name']}_content_from_{repo_name}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(path_content_fields)
|
||||
write_csv.writerow(path_content_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# create .csv for repository issues
|
||||
def logRepoIssues(issue, repo_name):
|
||||
repo_issue_fields = ['Title', 'ID', 'Node ID', 'Number', 'State', 'Reactions', 'Comments', 'Milestone', 'Assignee', 'Assignees', 'Author association', 'Labels', 'Is locked?', 'Lock reason', 'Closed at', 'Created at', 'Updated at']
|
||||
repo_issue_row = [issue['title'], issue['id'], issue['node_id'], issue['number'], issue['state'], issue['reactions'], issue['comments'], issue['milestone'], issue['assignee'], issue['assignees'], issue['author_association'], issue['labels'], issue['locked'], issue['active_lock_reason'], issue['closed_at'], issue['created_at'], issue['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{repo_name}_issue_{issue['id']}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(repo_issue_fields)
|
||||
writecsv.writerow(repo_issue_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
# create .csv for repository stargazer
|
||||
def log_repo_stargazers(stargazer, repo_name):
|
||||
user_follower_fields = ['Profile photo', 'Username', 'ID', 'Node ID', 'Gravatar ID', 'Account type',
|
||||
'Is site admin?', 'URL']
|
||||
user_follower_row = [stargazer['avatar_url'], stargazer['login'], stargazer['id'], stargazer['node_id'],
|
||||
stargazer['gravatar_id'], stargazer['type'], stargazer['site_admin'], stargazer['html_url']]
|
||||
|
||||
with open(os.path.join("output", f"{stargazer['login']}_stargazer_of_{repo_name}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(user_follower_fields)
|
||||
write_csv.writerow(user_follower_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
# create .csv for repository forks
|
||||
def log_repo_forks(fork, count):
|
||||
repo_fork_fields = ['Name', 'ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility',
|
||||
'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?',
|
||||
'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?', 'Has pages?',
|
||||
'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at', 'Created at', 'Updated at']
|
||||
repo_fork_row = [fork['full_name'], fork['id'], fork['description'], fork['forks'], fork['stargazers_count'],
|
||||
fork['watchers'], fork['license'], fork['default_branch'], fork['visibility'], fork['language'],
|
||||
fork['open_issues'], fork['topics'], fork['homepage'], fork['clone_url'], fork['ssh_url'],
|
||||
fork['fork'], fork['allow_forking'], fork['private'], fork['archived'], fork['is_template'],
|
||||
fork['has_wiki'], fork['has_pages'], fork['has_projects'], fork['has_issues'],
|
||||
fork['has_downloads'], fork['pushed_at'], fork['created_at'], fork['updated_at']]
|
||||
|
||||
with open(os.path.join("output", f"{fork['name']}_fork_{count}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(repo_fork_fields)
|
||||
write_csv.writerow(repo_fork_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# create .csv for repository releases
|
||||
def logRepoReleases(release, repo_name):
|
||||
repo_release_fields = ['Name', 'ID', 'Node ID', 'Tag', 'Branch', 'Assets', 'Is draft?', 'Is prerelease?', 'Created at', 'Published at']
|
||||
repo_release_row = [release['name'], release['id'], release['node_id'], release['tag_name'], release['target_commitish'], release['assets'], release['draft'], release['prerelease'], release['created_at'], release['published_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{repo_name}_release_{release['name']}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(repo_release_fields)
|
||||
writecsv.writerow(repo_release_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# Create .csv file for repository contributors
|
||||
def logRepoContributors(contributor, repo_name):
|
||||
repo_contributor_fields = ['Profile photo', 'Username', 'ID', 'Node ID', 'Gravatar ID', 'Account type', 'Is site admin?', 'URL']
|
||||
repo_contributor_row = [contributor['avatar_url'], contributor['login'], contributor['id'], contributor['node_id'], contributor['gravatar_id'], contributor['type'], contributor['site_admin'], contributor['html_url']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{contributor['login']}_contributor_of_{repo_name}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(repo_contributor_fields)
|
||||
writecsv.writerow(repo_contributor_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
print(f"{SignVar.info} {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# Create .csv for organization' events
|
||||
def logOrgEvents(event, organization):
|
||||
org_event_fields = ['ID', 'Type', 'Created at', 'Payload']
|
||||
org_event_row = [event['id'], event['type'], event['created_at'], event['payload']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{organization}_event_{event['id']}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(org_event_fields)
|
||||
writecsv.writerow(org_event_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# Create .csv for organization' repositories
|
||||
def logOrgRepos(repository, organization):
|
||||
org_repo_fields = [ 'Name','ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility', 'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?', 'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?', 'Has pages?', 'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at', 'Created at', 'Updated at']
|
||||
org_repo_row = [repository['full_name'], repository['id'], repository['description'], repository['forks'], repository['stargazers_count'], repository['watchers'], repository['license'], repository['default_branch'], repository['visibility'], repository['language'], repository['open_issues'], repository['topics'], repository['homepage'], repository['clone_url'], repository['ssh_url'], repository['fork'], repository['allow_forking'], repository['private'], repository['archived'], repository['is_template'], repository['has_wiki'], repository['has_pages'], repository['has_projects'], repository['has_issues'], repository['has_downloads'], repository['pushed_at'], repository['created_at'], repository['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{repository['name']}_repository_of_{organization}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(org_repo_fields)
|
||||
writecsv.writerow(org_repo_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# .csv for user' repositories
|
||||
def logUserRepos(repository, username):
|
||||
user_repo_fields = [ 'Name','ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility', 'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?', 'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?', 'Has pages?', 'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at', 'Created at', 'Updated at']
|
||||
user_repo_row = [repository['full_name'], repository['id'], repository['description'], repository['forks'], repository['stargazers_count'], repository['watchers'], repository['license'], repository['default_branch'], repository['visibility'], repository['language'], repository['open_issues'], repository['topics'], repository['homepage'], repository['clone_url'], repository['ssh_url'], repository['fork'], repository['allow_forking'], repository['private'], repository['archived'], repository['is_template'], repository['has_wiki'], repository['has_pages'], repository['has_projects'], repository['has_issues'], repository['has_downloads'], repository['pushed_at'], repository['created_at'], repository['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{repository['name']}_{username}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(user_repo_fields)
|
||||
writecsv.writerow(user_repo_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
# create .csv for repository issues
|
||||
def log_repo_issues(issue, repo_name):
|
||||
repo_issue_fields = ['Title', 'ID', 'Node ID', 'Number', 'State', 'Reactions', 'Comments', 'Milestone', 'Assignee',
|
||||
'Assignees', 'Author association', 'Labels', 'Is locked?', 'Lock reason', 'Closed at',
|
||||
'Created at', 'Updated at']
|
||||
repo_issue_row = [issue['title'], issue['id'], issue['node_id'], issue['number'], issue['state'],
|
||||
issue['reactions'], issue['comments'], issue['milestone'], issue['assignee'], issue['assignees'],
|
||||
issue['author_association'], issue['labels'], issue['locked'], issue['active_lock_reason'],
|
||||
issue['closed_at'], issue['created_at'], issue['updated_at']]
|
||||
|
||||
# .csv for user events
|
||||
def logUserEvents(event):
|
||||
user_event_fields = ['Actor', 'Type', 'Repository', 'Created at', 'Payload']
|
||||
user_event_row = [event['actor']['login'], event['type'], event['repo']['name'], event['created_at'], event['payload']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{event['actor']['login']}_event_{event['id']}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(user_event_fields)
|
||||
writecsv.writerow(user_event_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# .csv for user gists
|
||||
def logUserGists(gist):
|
||||
user_gist_fields = ['ID', 'Node ID', 'About', 'Comments', 'Files', 'Git Push URL', 'Is public?', 'Is truncated?', 'Updated at']
|
||||
user_gist_row = [gist['id'], gist['node_id'], gist['description'], gist['comments'], gist['files'], gist['git_push_url'], gist['public'], gist['truncated'], gist['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{gist['id']}_gists_{gist['owner']['login']}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(user_gist_fields)
|
||||
writecsv.writerow(user_gist_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# .csv for user followers
|
||||
def logUserFollowers(follower, username):
|
||||
user_follower_fields = ['Profile photo', 'Username', 'ID', 'Node ID', 'Gravatar ID', 'Account type', 'Is site admin?', 'URL']
|
||||
user_follower_row = [follower['avatar_url'], follower['login'], follower['id'], follower['node_id'], follower['gravatar_id'], follower['type'], follower['site_admin'], follower['html_url']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{follower['login']}_follower_of_{username}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(user_follower_fields)
|
||||
writecsv.writerow(user_follower_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# .csv for user following
|
||||
def logUserFollowing(user, username):
|
||||
user_following_fields = ['Profile photo', 'Username', 'ID', 'Node ID', 'Gravatar ID', 'Account type', 'Is site admin?', 'URL']
|
||||
user_following_row = [user['avatar_url'], user['login'], user['id'], user['node_id'], user['gravatar_id'], user['type'], user['site_admin'], user['html_url']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{user['login']}_followed_by_{username}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(user_following_fields)
|
||||
writecsv.writerow(user_following_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# .csv for user' subscriptions
|
||||
def logUserSubscriptions(repository, username):
|
||||
user_subscription_fields = [ 'Name','ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility', 'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?', 'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?', 'Has pages?', 'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at', 'Created at', 'Updated at']
|
||||
user_subscription_row = [repository['name'], repository['id'], repository['description'], repository['forks'], repository['stargazers_count'], repository['watchers'], repository['license'], repository['default_branch'], repository['visibility'], repository['language'], repository['open_issues'], repository['topics'], repository['homepage'], repository['clone_url'], repository['ssh_url'], repository['fork'], repository['allow_forking'], repository['private'], repository['archived'], repository['is_template'], repository['has_wiki'], repository['has_pages'], repository['has_projects'], repository['has_issues'], repository['has_downloads'], repository['pushed_at'], repository['created_at'], repository['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{username}_subscriptions_{repository['name']}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(user_subscription_fields)
|
||||
writecsv.writerow(user_subscription_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# .csv for user organizations
|
||||
def logUserOrgs(organization, username):
|
||||
user_org_fields = ['Profile photo', 'Name', 'ID', 'Node ID', 'URL', 'About']
|
||||
user_org_row = [organization['avatar_url'], organization['login'], organization['id'], organization['node_id'], organization['url'], organization['description']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{organization['login']}_{username}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(user_org_fields)
|
||||
writecsv.writerow(user_org_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
with open(os.path.join("output", f"{repo_name}_issue_{issue['id']}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(repo_issue_fields)
|
||||
write_csv.writerow(repo_issue_row)
|
||||
|
||||
# Create .csv for user search
|
||||
def logUserSearch(user, query):
|
||||
user_search_fields = ['Profile photo', 'Username', 'ID', 'Node ID', 'Gravatar ID', 'Account type', 'Is site admin?', 'URL']
|
||||
user_search_row = [user['avatar_url'], user['login'], user['id'], user['node_id'], user['gravatar_id'], user['type'], user['site_admin'], user['html_url']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{user['login']}_user_search_result_for_{query}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(user_search_fields)
|
||||
writecsv.writerow(user_search_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# Create .csv for repository search
|
||||
def logRepoSearch(repository, query):
|
||||
repo_search_fields = [ 'Name','ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility', 'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?', 'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?', 'Has pages?', 'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at', 'Created at', 'Updated at']
|
||||
repo_search_row = [repository['full_name'], repository['id'], repository['description'], repository['forks'], repository['stargazers_count'], repository['watchers'], repository['license'], repository['default_branch'], repository['visibility'], repository['language'], repository['open_issues'], repository['topics'], repository['homepage'], repository['clone_url'], repository['ssh_url'], repository['fork'], repository['allow_forking'], repository['private'], repository['archived'], repository['is_template'], repository['has_wiki'], repository['has_pages'], repository['has_projects'], repository['has_issues'], repository['has_downloads'], repository['pushed_at'], repository['created_at'], repository['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{repository['name']}_repository_search_result_for_{query}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(repo_search_fields)
|
||||
writecsv.writerow(repo_search_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# Create .csv for topic search
|
||||
def logTopicSearch(topic, query):
|
||||
topic_search_fields = ['Name', 'Score', 'Curated', 'Featured', 'Display name', 'Created by', 'Created at', 'Updated at']
|
||||
topic_search_row = [topic['name'], topic['score'], topic['curated'], topic['featured'], topic['display_name'], topic['created_by'], topic['created_at'], topic['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{topic['name']}_topic_search_result_for_{query}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(topic_search_fields)
|
||||
writecsv.writerow(topic_search_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# Create .csv for issues search
|
||||
def logIssueSearch(issue, query):
|
||||
issue_search_fields = ['Title', 'ID', 'Node ID', 'Number', 'State', 'Reactions', 'Comments', 'Milestone', 'Assignee', 'Assignees', 'Author association', 'Labels', 'Is locked?', 'Lock reason', 'Closed at', 'Created at', 'Updated at']
|
||||
issue_search_row = [issue['title'], issue['id'], issue['node_id'], issue['number'], issue['state'], issue['reactions'], issue['comments'], issue['milestone'], issue['assignee'], issue['assignees'], issue['author_association'], issue['labels'], issue['locked'], issue['active_lock_reason'], issue['closed_at'], issue['created_at'], issue['updated_at']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{issue['id']}_issue_search_result_for_{query}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(issue_search_fields)
|
||||
writecsv.writerow(issue_search_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
|
||||
|
||||
# Create .csv for commits search
|
||||
def logCommitsSearch(commit, query):
|
||||
commit_search_fields = ['SHA', 'Author', 'Username', 'Email', 'Committer', 'Repository', 'URL', 'Description']
|
||||
commit_search_row = [commit['commit']['tree']['sha'], commit['commit']['author']['name'], commit['author']['login'], commit['commit']['author']['email'], commit['commit']['committer']['name'], commit['repository']['full_name'], commit['html_url'], commit['commit']['message']]
|
||||
prompt = input(f'\n{SignVar.prompt} {logRoller.askLogCsv}').lower()
|
||||
if prompt == 'y':
|
||||
with open(f"output/{commit['commit']['tree']['sha']}_commit_search_result_for_{query}.csv", 'w') as file:
|
||||
writecsv = csv.writer(file)
|
||||
writecsv.writerow(commit_search_fields)
|
||||
writecsv.writerow(commit_search_row)
|
||||
|
||||
logging.info(logRoller.loggedToCsv.format(file.name))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.loggedToCsv.format(file.name)}\n")
|
||||
|
||||
else:
|
||||
logging.info(logRoller.loggingSkipped)
|
||||
sys.stdout.write(f"{SignVar.info} ({prompt}) {logRoller.loggingSkipped}\n")
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# create .csv for repository releases
|
||||
def log_repo_releases(release, repo_name):
|
||||
repo_release_fields = ['Name', 'ID', 'Node ID', 'Tag', 'Branch', 'Assets', 'Is draft?', 'Is prerelease?',
|
||||
'Created at', 'Published at']
|
||||
repo_release_row = [release['name'], release['id'], release['node_id'], release['tag_name'],
|
||||
release['target_commitish'], release['assets'], release['draft'], release['prerelease'],
|
||||
release['created_at'], release['published_at']]
|
||||
|
||||
with open(os.path.join("output", f"{repo_name}_release_{release['name']}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(repo_release_fields)
|
||||
write_csv.writerow(repo_release_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# Create .csv file for repository contributors
|
||||
def log_repo_contributors(contributor, repo_name):
|
||||
repo_contributor_fields = ['Profile photo', 'Username', 'ID', 'Node ID', 'Gravatar ID', 'Account type',
|
||||
'Is site admin?', 'URL']
|
||||
repo_contributor_row = [contributor['avatar_url'], contributor['login'], contributor['id'], contributor['node_id'],
|
||||
contributor['gravatar_id'], contributor['type'], contributor['site_admin'],
|
||||
contributor['html_url']]
|
||||
|
||||
with open(os.path.join("output", f"{contributor['login']}_contributor_of_{repo_name}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(repo_contributor_fields)
|
||||
write_csv.writerow(repo_contributor_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# Create .csv for organization' events
|
||||
def log_repo_events(event, organization):
|
||||
org_event_fields = ['ID', 'Type', 'Created at', 'Payload']
|
||||
org_event_row = [event['id'], event['type'], event['created_at'], event['payload']]
|
||||
|
||||
with open(os.path.join("output", f"{organization}_event_{event['id']}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(org_event_fields)
|
||||
write_csv.writerow(org_event_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# Create .csv for organization' repositories
|
||||
def log_org_repos(repository, organization):
|
||||
org_repo_fields = ['Name', 'ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility',
|
||||
'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?',
|
||||
'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?', 'Has pages?',
|
||||
'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at', 'Created at', 'Updated at']
|
||||
org_repo_row = [repository['full_name'], repository['id'], repository['description'], repository['forks'],
|
||||
repository['stargazers_count'], repository['watchers'], repository['license'],
|
||||
repository['default_branch'], repository['visibility'], repository['language'],
|
||||
repository['open_issues'], repository['topics'], repository['homepage'], repository['clone_url'],
|
||||
repository['ssh_url'], repository['fork'], repository['allow_forking'], repository['private'],
|
||||
repository['archived'], repository['is_template'], repository['has_wiki'], repository['has_pages'],
|
||||
repository['has_projects'], repository['has_issues'], repository['has_downloads'],
|
||||
repository['pushed_at'], repository['created_at'], repository['updated_at']]
|
||||
|
||||
with open(os.path.join("output", f"{repository['name']}_repository_of_{organization}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(org_repo_fields)
|
||||
write_csv.writerow(org_repo_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# .csv for user' repositories
|
||||
def log_user_repos(repository, username):
|
||||
user_repo_fields = ['Name', 'ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility',
|
||||
'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?',
|
||||
'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?', 'Has pages?',
|
||||
'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at', 'Created at', 'Updated at']
|
||||
user_repo_row = [repository['full_name'], repository['id'], repository['description'], repository['forks'],
|
||||
repository['stargazers_count'], repository['watchers'], repository['license'],
|
||||
repository['default_branch'], repository['visibility'], repository['language'],
|
||||
repository['open_issues'], repository['topics'], repository['homepage'], repository['clone_url'],
|
||||
repository['ssh_url'], repository['fork'], repository['allow_forking'], repository['private'],
|
||||
repository['archived'], repository['is_template'], repository['has_wiki'], repository['has_pages'],
|
||||
repository['has_projects'], repository['has_issues'], repository['has_downloads'],
|
||||
repository['pushed_at'], repository['created_at'], repository['updated_at']]
|
||||
|
||||
with open(os.path.join("output", f"{repository['name']}_{username}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(user_repo_fields)
|
||||
write_csv.writerow(user_repo_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# .csv for user events
|
||||
def log_user_events(event):
|
||||
user_event_fields = ['Actor', 'Type', 'Repository', 'Created at', 'Payload']
|
||||
user_event_row = [event['actor']['login'], event['type'], event['repo']['name'], event['created_at'],
|
||||
event['payload']]
|
||||
|
||||
with open(os.path.join("output", f"{event['actor']['login']}_event_{event['id']}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(user_event_fields)
|
||||
write_csv.writerow(user_event_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# .csv for user gists
|
||||
def log_user_gists(gist):
|
||||
user_gist_fields = ['ID', 'Node ID', 'About', 'Comments', 'Files', 'Git Push URL', 'Is public?', 'Is truncated?',
|
||||
'Updated at']
|
||||
user_gist_row = [gist['id'], gist['node_id'], gist['description'], gist['comments'], gist['files'],
|
||||
gist['git_push_url'], gist['public'], gist['truncated'], gist['updated_at']]
|
||||
|
||||
with open(os.path.join("output", f"{gist['id']}_gists_{gist['owner']['login']}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(user_gist_fields)
|
||||
write_csv.writerow(user_gist_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# .csv for user followers
|
||||
def log_user_followers(follower, username):
|
||||
user_follower_fields = ['Profile photo', 'Username', 'ID', 'Node ID', 'Gravatar ID', 'Account type',
|
||||
'Is site admin?', 'URL']
|
||||
user_follower_row = [follower['avatar_url'], follower['login'], follower['id'], follower['node_id'],
|
||||
follower['gravatar_id'], follower['type'], follower['site_admin'], follower['html_url']]
|
||||
|
||||
with open(f"output/{follower['login']}_follower_of_{username}.csv", 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(user_follower_fields)
|
||||
write_csv.writerow(user_follower_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# .csv for user following
|
||||
def log_user_following(user, username):
|
||||
user_following_fields = ['Profile photo', 'Username', 'ID', 'Node ID', 'Gravatar ID', 'Account type',
|
||||
'Is site admin?', 'URL']
|
||||
user_following_row = [user['avatar_url'], user['login'], user['id'], user['node_id'], user['gravatar_id'],
|
||||
user['type'], user['site_admin'], user['html_url']]
|
||||
|
||||
with open(os.path.join("output", f"{user['login']}_followed_by_{username}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(user_following_fields)
|
||||
write_csv.writerow(user_following_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# .csv for user' subscriptions
|
||||
def log_user_subscriptions(repository, username):
|
||||
user_subscription_fields = ['Name', 'ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility',
|
||||
'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?',
|
||||
'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?',
|
||||
'Has pages?', 'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at',
|
||||
'Created at', 'Updated at']
|
||||
user_subscription_row = [repository['name'], repository['id'], repository['description'], repository['forks'],
|
||||
repository['stargazers_count'], repository['watchers'], repository['license'],
|
||||
repository['default_branch'], repository['visibility'], repository['language'],
|
||||
repository['open_issues'], repository['topics'], repository['homepage'],
|
||||
repository['clone_url'], repository['ssh_url'], repository['fork'],
|
||||
repository['allow_forking'], repository['private'], repository['archived'],
|
||||
repository['is_template'], repository['has_wiki'], repository['has_pages'],
|
||||
repository['has_projects'], repository['has_issues'], repository['has_downloads'],
|
||||
repository['pushed_at'], repository['created_at'], repository['updated_at']]
|
||||
|
||||
with open(os.path.join("output", f"{username}_subscriptions_{repository['name']}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(user_subscription_fields)
|
||||
write_csv.writerow(user_subscription_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# .csv for user organizations
|
||||
def log_user_orgs(organization, username):
|
||||
user_org_fields = ['Profile photo', 'Name', 'ID', 'Node ID', 'URL', 'About']
|
||||
user_org_row = [organization['avatar_url'], organization['login'], organization['id'], organization['node_id'],
|
||||
organization['url'], organization['description']]
|
||||
|
||||
with open(os.path.join("output", f"{organization['login']}_{username}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(user_org_fields)
|
||||
write_csv.writerow(user_org_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# Create .csv for user search
|
||||
def log_users_search(user, query):
|
||||
user_search_fields = ['Profile photo', 'Username', 'ID', 'Node ID', 'Gravatar ID', 'Account type', 'Is site admin?',
|
||||
'URL']
|
||||
user_search_row = [user['avatar_url'], user['login'], user['id'], user['node_id'], user['gravatar_id'],
|
||||
user['type'], user['site_admin'], user['html_url']]
|
||||
|
||||
with open(os.path.join("output", f"{user['login']}_user_search_result_for_{query}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(user_search_fields)
|
||||
write_csv.writerow(user_search_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# Create .csv for repository search
|
||||
def log_repos_search(repository, query):
|
||||
repo_search_fields = ['Name', 'ID', 'About', 'Forks', 'Stars', 'Watchers', 'License', 'Branch', 'Visibility',
|
||||
'Language(s)', 'Open issues', 'Topics', 'Homepage', 'Clone URL', 'SSH URL', 'Is fork?',
|
||||
'Is forkable?', 'Is private?', 'Is archived?', 'Is template?', 'Has wiki?', 'Has pages?',
|
||||
'Has projects?', 'Has issues?', 'Has downloads?', 'Pushed at', 'Created at', 'Updated at']
|
||||
repo_search_row = [repository['full_name'], repository['id'], repository['description'], repository['forks'],
|
||||
repository['stargazers_count'], repository['watchers'], repository['license'],
|
||||
repository['default_branch'], repository['visibility'], repository['language'],
|
||||
repository['open_issues'], repository['topics'], repository['homepage'], repository['clone_url'],
|
||||
repository['ssh_url'], repository['fork'], repository['allow_forking'], repository['private'],
|
||||
repository['archived'], repository['is_template'], repository['has_wiki'],
|
||||
repository['has_pages'], repository['has_projects'], repository['has_issues'],
|
||||
repository['has_downloads'], repository['pushed_at'], repository['created_at'],
|
||||
repository['updated_at']]
|
||||
|
||||
with open(os.path.join("output", f"{repository['name']}_repository_search_result_for_{query}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(repo_search_fields)
|
||||
write_csv.writerow(repo_search_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# Create .csv for topic search
|
||||
def log_topics_search(topic, query):
|
||||
topic_search_fields = ['Name', 'Score', 'Curated', 'Featured', 'Display name', 'Created by', 'Created at',
|
||||
'Updated at']
|
||||
topic_search_row = [topic['name'], topic['score'], topic['curated'], topic['featured'], topic['display_name'],
|
||||
topic['created_by'], topic['created_at'], topic['updated_at']]
|
||||
|
||||
with open(os.path.join("output", f"{topic['name']}_topic_search_result_for_{query}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(topic_search_fields)
|
||||
write_csv.writerow(topic_search_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# Create .csv for issues search
|
||||
def log_issues_search(issue, query):
|
||||
issue_search_fields = ['Title', 'ID', 'Node ID', 'Number', 'State', 'Reactions', 'Comments', 'Milestone',
|
||||
'Assignee', 'Assignees', 'Author association', 'Labels', 'Is locked?', 'Lock reason',
|
||||
'Closed at', 'Created at', 'Updated at']
|
||||
issue_search_row = [issue['title'], issue['id'], issue['node_id'], issue['number'], issue['state'],
|
||||
issue['reactions'], issue['comments'], issue['milestone'], issue['assignee'],
|
||||
issue['assignees'], issue['author_association'], issue['labels'], issue['locked'],
|
||||
issue['active_lock_reason'], issue['closed_at'], issue['created_at'], issue['updated_at']]
|
||||
|
||||
with open(os.path.join("output", f"{issue['id']}_issue_search_result_for_{query}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(issue_search_fields)
|
||||
write_csv.writerow(issue_search_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
|
||||
# Create .csv for commits search
|
||||
def log_commits_search(commit, query):
|
||||
commit_search_fields = ['SHA', 'Author', 'Username', 'Email', 'Committer', 'Repository', 'URL', 'Description']
|
||||
commit_search_row = [commit['commit']['tree']['sha'], commit['commit']['author']['name'], commit['author']['login'],
|
||||
commit['commit']['author']['email'], commit['commit']['committer']['name'],
|
||||
commit['repository']['full_name'], commit['html_url'], commit['commit']['message']]
|
||||
|
||||
with open(os.path.join("output", f"{commit['commit']['tree']['sha']}_commit_search_result_for_{query}.csv"), 'w') as file:
|
||||
write_csv = csv.writer(file)
|
||||
write_csv.writerow(commit_search_fields)
|
||||
write_csv.writerow(commit_search_row)
|
||||
|
||||
logging.info(logged_to_csv.format(file.name))
|
||||
xprint(f"{POSITIVE} {logged_to_csv.format(file.name)}")
|
||||
|
||||
@@ -1,231 +1,170 @@
|
||||
import sys
|
||||
from octosuite.colors import Color
|
||||
from rich.table import Table
|
||||
from octosuite.config import Tree, xprint, white, green, white_bold, green_bold, header_title, reset
|
||||
|
||||
"""
|
||||
Help
|
||||
This class holds the help text for available.
|
||||
Almost everything in the methods from this class is hard coded
|
||||
"""
|
||||
class Help:
|
||||
usageText = 'Use {} to get started'
|
||||
usageText1 = 'Use {} to view all available subcommands.'
|
||||
|
||||
def Org():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Note:
|
||||
-------
|
||||
The '{Color.green}org{Color.white}' command works with subcommands.
|
||||
{Help.usageText1.format('help:org')}{Color.reset}
|
||||
""")
|
||||
|
||||
|
||||
def Repo():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Note:
|
||||
-----
|
||||
The '{Color.green}repo{Color.white}' command works with subcommands.
|
||||
{Help.usageText1.format('help:repo')}{Color.reset}
|
||||
""")
|
||||
|
||||
|
||||
def User():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Note:
|
||||
-----
|
||||
The '{Color.green}user{Color.white}' command works with subcommands.
|
||||
{Help.usageText1.format('help:user')}{Color.reset}
|
||||
""")
|
||||
|
||||
def Search():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Note:
|
||||
-----
|
||||
The '{Color.green}search{Color.white}' command works with subcommands.
|
||||
{Help.usageText1.format('help:search')}{Color.reset}
|
||||
""")
|
||||
|
||||
|
||||
def Source():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Note:
|
||||
-----
|
||||
The '{Color.green}source{Color.white}' command works with subcommands.
|
||||
{Help.usageText1.format('help:source')}{Color.reset}
|
||||
""")
|
||||
|
||||
def Logs():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Note:
|
||||
-----
|
||||
The '{Color.green}logs{Color.white}' command works with subcommands.
|
||||
{Help.usageText1.format('help:logs')}{Color.reset}
|
||||
""")
|
||||
|
||||
|
||||
def Version():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Note:
|
||||
-----
|
||||
The '{Color.green}version{Color.white}' command works with subcommands.
|
||||
{Help.usageText1.format('help:version')}{Color.reset}
|
||||
""")
|
||||
|
||||
|
||||
def Csv():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Note:
|
||||
-----
|
||||
The '{Color.green}csv{Color.white}' command works with subcommands.
|
||||
{Help.usageText1.format('help:csv')}{Color.reset}
|
||||
""")
|
||||
|
||||
|
||||
def versionCommand():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Version subcommands{Color.reset}
|
||||
{'='*18}
|
||||
{Help.usageText.format('version:<subcommand>')}
|
||||
# helper.py
|
||||
# This file holds the help text for available commands.
|
||||
usage_text = 'Use syntax {} to get started with %s{}%s.' % (green_bold, reset)
|
||||
usage_text_1 = '%sUse {} to view all available subcommands.%s' % (white, reset)
|
||||
usage_text_2 = "%sThe {} command works with subcommands. %s" % (white, reset)
|
||||
|
||||
{Color.white}Command Description{Color.reset}
|
||||
------- -----------
|
||||
check Check for new release(s)
|
||||
info Version info
|
||||
""")
|
||||
|
||||
|
||||
def sourceCommand():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Source subcommands{Color.reset}
|
||||
{'='*18}
|
||||
{Help.usageText.format('source:<subcommand>')}
|
||||
{Color.white}Command Description{Color.reset}
|
||||
-------- -----------
|
||||
zipball Download source code as zipball
|
||||
tarball Download source code as tarball
|
||||
""")
|
||||
|
||||
|
||||
def searchCommand():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Search subcommands{Color.reset}
|
||||
{'='*18}
|
||||
{Help.usageText.format('search:<subcommand>')}
|
||||
|
||||
{Color.white}Command Description{Color.reset}
|
||||
------- -----------
|
||||
users Search user(s)
|
||||
repos Search repositor[yies]
|
||||
topics Search topic(s)
|
||||
issues Search issue(s)
|
||||
commits Search commit(s)
|
||||
""")
|
||||
|
||||
|
||||
def userCommand():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}User subcommands{Color.reset}
|
||||
{'='*17}
|
||||
{Help.usageText.format('user:<subcommand>')}
|
||||
def org():
|
||||
xprint(usage_text_2.format(f"{green_bold}org{reset}") + usage_text_1.format(f"{green_bold}help:org{reset}"))
|
||||
|
||||
{Color.white}Command Description{Color.reset}
|
||||
------- -----------
|
||||
profile Get a user's profile info
|
||||
gists Return a users's gists
|
||||
orgs Return organizations that a user belongs to/owns
|
||||
repos Return a user's repositories
|
||||
events Return a user's events
|
||||
follows Check if user(A) follows user(B)
|
||||
followers Return a user's followers
|
||||
following Return a list of users the target is following
|
||||
subscriptions Return a user's subscriptions
|
||||
""")
|
||||
|
||||
|
||||
def orgCommand():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Org subcommands{Color.reset}
|
||||
{'='*16}
|
||||
{Help.usageText.format('org:<subcommand>')}
|
||||
|
||||
{Color.white}Command Description{Color.reset}
|
||||
------- -----------
|
||||
profile Get an organization's info
|
||||
repos Return an organization's repositories
|
||||
events Return an organization's events
|
||||
member Check if a specified user is a public member of the target organization
|
||||
""")
|
||||
|
||||
|
||||
def repoCommand():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Repo subcommands{Color.reset}
|
||||
{'='*17}
|
||||
{Help.usageText.format('repo:<subcommand>')}
|
||||
def repo():
|
||||
xprint(usage_text_2.format(f"{green_bold}repo{reset}") + usage_text_1.format(f"{green_bold}help:repo{reset}"))
|
||||
|
||||
{Color.white}Command Description{Color.reset}
|
||||
------- -----------
|
||||
profile Get a repository's info
|
||||
issues Return a repository's issues
|
||||
forks Return a repository's forks
|
||||
releases Return a repository's releases
|
||||
stargazers Return a repository's stargazers
|
||||
pathcontents List contents in a path of a repository
|
||||
""")
|
||||
|
||||
|
||||
def logsCommand():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Logs subcommands{Color.reset}
|
||||
{'='*17}
|
||||
{Help.usageText.format('logs:<subcommand>')}
|
||||
|
||||
{Color.white}Command Description{Color.reset}
|
||||
------- -----------
|
||||
view View logs
|
||||
read Read log
|
||||
delete Delete log
|
||||
""")
|
||||
|
||||
def csvCommand():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Csv subcommands{Color.reset}
|
||||
{'='*17}
|
||||
{Help.usageText.format('csv:<subcommand>')}
|
||||
def user():
|
||||
xprint(usage_text_2.format(f"{green_bold}user{reset}") + usage_text_1.format(f"{green_bold}help:user{reset}"))
|
||||
|
||||
{Color.white}Command Description{Color.reset}
|
||||
------- -----------
|
||||
view View csv files
|
||||
read Read csv
|
||||
delete Delete csv
|
||||
""")
|
||||
|
||||
|
||||
def helpCommand():
|
||||
sys.stdout.write(f"""
|
||||
{Color.white}Core commands{Color.reset}
|
||||
{'='*13}
|
||||
|
||||
{Color.white}Command Description{Color.reset}
|
||||
------- -----------
|
||||
help Help menu
|
||||
exit Close session
|
||||
clear Clear screen
|
||||
about Program' info
|
||||
author Developer' info
|
||||
|
||||
|
||||
{Color.white}Help subcommands{Color.reset}
|
||||
{'='*16}
|
||||
{Help.usageText.format('help:<subcommand>')}
|
||||
def search():
|
||||
xprint(usage_text_2.format(f"{green_bold}search{reset}") + usage_text_1.format(f"{green_bold}help:search{reset}"))
|
||||
|
||||
{Color.white}Command Description{Color.reset}
|
||||
------- -----------
|
||||
csv (coming soon)
|
||||
org List all organization investigation commands
|
||||
logs List all logs management commands
|
||||
repo List all repository investigation commands
|
||||
user List all users investigation commands
|
||||
search List all target discovery commands
|
||||
source (beta) List all source code download commands (for developers)
|
||||
version List all version management commands
|
||||
""")
|
||||
|
||||
def source():
|
||||
xprint(usage_text_2.format(f"{green_bold}source{reset}") + usage_text_1.format(f"{green_bold}help:source{reset}"))
|
||||
|
||||
|
||||
def logs():
|
||||
xprint(usage_text_2.format(f"{green_bold}logs{reset}") + usage_text_1.format(f"{green_bold}help:logs{reset}"))
|
||||
|
||||
|
||||
def csv():
|
||||
xprint(usage_text_2.format(f"{green_bold}csv{reset}") + usage_text_1.format(f"{green_bold}help:csv{reset}"))
|
||||
|
||||
|
||||
def source_command():
|
||||
source_cmd_table = Table(show_header=True, header_style=header_title)
|
||||
source_cmd_table.add_column("Command", style="dim")
|
||||
source_cmd_table.add_column("Description")
|
||||
source_cmd_table.add_row("zipball", "Download source code Zipball")
|
||||
source_cmd_table.add_row("tarball", "Download source code Tarball")
|
||||
|
||||
syntax = f"{green}source:<command>{reset}"
|
||||
xprint(f"{usage_text.format(syntax, 'source code downloads')}")
|
||||
xprint(source_cmd_table)
|
||||
|
||||
|
||||
def search_command():
|
||||
search_cmd_table = Table(show_header=True, header_style=header_title)
|
||||
search_cmd_table.add_column("Command", style="dim")
|
||||
search_cmd_table.add_column("Description")
|
||||
search_cmd_table.add_row("users", "Search user(s)")
|
||||
search_cmd_table.add_row("repos", "Search repositor[y][ies]")
|
||||
search_cmd_table.add_row("topics", "Search topic(s)")
|
||||
search_cmd_table.add_row("issues", "Search issue(s)")
|
||||
search_cmd_table.add_row("commits", "Search commit(s)")
|
||||
|
||||
syntax = f"{green}search:<command>{reset}"
|
||||
xprint(f"{usage_text.format(syntax, 'target discovery')}")
|
||||
xprint(search_cmd_table)
|
||||
|
||||
|
||||
def user_command():
|
||||
user_cmd_table = Table(show_header=True, header_style=header_title)
|
||||
user_cmd_table.add_column("Command", style="dim")
|
||||
user_cmd_table.add_column("Description")
|
||||
user_cmd_table.add_row("profile", "Get a target's profile info")
|
||||
user_cmd_table.add_row("gists", "Return a users's gists")
|
||||
user_cmd_table.add_row("org", "Return organizations that a target belongs to/owns")
|
||||
user_cmd_table.add_row("repos", "Return a target's repositories")
|
||||
user_cmd_table.add_row("events", "Return a target's events")
|
||||
user_cmd_table.add_row("follows", "Check if user(A) follows user(B)")
|
||||
user_cmd_table.add_row("followers", "Return a target's followers")
|
||||
user_cmd_table.add_row("following", "Return a list of users the target is following")
|
||||
user_cmd_table.add_row("subscriptions", "Return a target's subscriptions")
|
||||
|
||||
syntax = f"{green}user:<command>{reset}"
|
||||
xprint(f"{usage_text.format(syntax, 'user investigation(s)')}")
|
||||
xprint(user_cmd_table)
|
||||
|
||||
|
||||
def org_command():
|
||||
org_cmd_table = Table(show_header=True, header_style=header_title)
|
||||
org_cmd_table.add_column("Command", style="dim")
|
||||
org_cmd_table.add_column("Description")
|
||||
org_cmd_table.add_row("profile", "Get a target organization' profile info")
|
||||
org_cmd_table.add_row("repos", "Return a target organization' repositories")
|
||||
org_cmd_table.add_row("events", "Return a target organization' events")
|
||||
org_cmd_table.add_row("member", "Check if a specified user is a public member of the target organization")
|
||||
|
||||
syntax = f"{green}org:<command>{reset}"
|
||||
xprint(f"{usage_text.format(syntax, 'organization investigation(s)')}")
|
||||
xprint(org_cmd_table)
|
||||
|
||||
|
||||
def repo_command():
|
||||
repo_cmd_table = Table(show_header=True, header_style=header_title)
|
||||
repo_cmd_table.add_column("Command", style="dim")
|
||||
repo_cmd_table.add_column("Description")
|
||||
repo_cmd_table.add_row("profile", "Get a repository's info")
|
||||
repo_cmd_table.add_row("issues", "Return a repository's issues")
|
||||
repo_cmd_table.add_row("forks", "Return a repository's forks")
|
||||
repo_cmd_table.add_row("releases", "Return a repository's releases")
|
||||
repo_cmd_table.add_row("stargazers", "Return a repository's stargazers")
|
||||
repo_cmd_table.add_row("contributors", "Return a repository's contributors")
|
||||
repo_cmd_table.add_row("path_contents", "List contents in a path of a repository")
|
||||
|
||||
syntax = f"{green}repo:<command>{reset}"
|
||||
xprint(f"{usage_text.format(syntax, 'repository investigation(s)')}")
|
||||
xprint(repo_cmd_table)
|
||||
|
||||
|
||||
def logs_command():
|
||||
logs_cmd_table = Table(show_header=True, header_style=header_title)
|
||||
logs_cmd_table.add_column("Command", style="dim")
|
||||
logs_cmd_table.add_column("Description")
|
||||
logs_cmd_table.add_row("view", "View logs")
|
||||
logs_cmd_table.add_row("read", "Read log")
|
||||
logs_cmd_table.add_row("delete", "Delete log")
|
||||
logs_cmd_table.add_row("clear", "clear logs")
|
||||
|
||||
syntax = f"{green}logs:<command>{reset}"
|
||||
xprint(f"{usage_text.format(syntax, 'log(s) management')}")
|
||||
xprint(logs_cmd_table)
|
||||
|
||||
|
||||
def csv_command():
|
||||
csv_cmd_table = Table(show_header=True, header_style=header_title)
|
||||
csv_cmd_table.add_column("Command", style="dim")
|
||||
csv_cmd_table.add_column("Description")
|
||||
csv_cmd_table.add_row("view", "View csv files")
|
||||
csv_cmd_table.add_row("read", "Read csv")
|
||||
csv_cmd_table.add_row("delete", "Delete csv")
|
||||
csv_cmd_table.add_row("clear", "clear csv files")
|
||||
|
||||
syntax = f"{green}csv:<command>{reset}"
|
||||
xprint(f"{usage_text.format(syntax, 'csv management')}")
|
||||
xprint(csv_cmd_table)
|
||||
|
||||
|
||||
def help_command():
|
||||
core_cmd_table = Table(show_header=True, header_style=header_title)
|
||||
core_cmd_table.add_column("Command", style="dim", width=12)
|
||||
core_cmd_table.add_column("Description")
|
||||
core_cmd_table.add_row("ls", "List contents of the specified directory")
|
||||
core_cmd_table.add_row("cd", "Move to specified directory")
|
||||
core_cmd_table.add_row("help", "Help menu")
|
||||
core_cmd_table.add_row("exit", "Close session")
|
||||
core_cmd_table.add_row("clear", "Clear screen")
|
||||
core_cmd_table.add_row("about", "Program's info")
|
||||
core_cmd_table.add_row("author", "Developer's info")
|
||||
|
||||
help_sub_cmd_table = Table(show_header=True, header_style=header_title)
|
||||
help_sub_cmd_table.add_column("Command", style="dim", width=12)
|
||||
help_sub_cmd_table.add_column("Description")
|
||||
help_sub_cmd_table.add_row("csv", "List all csv management commands")
|
||||
help_sub_cmd_table.add_row("logs", "List all logs management commands")
|
||||
help_sub_cmd_table.add_row("org", "List all organization investigation commands")
|
||||
help_sub_cmd_table.add_row("user", "List all users investigation commands")
|
||||
help_sub_cmd_table.add_row("repo", "List all repository investigation commands")
|
||||
help_sub_cmd_table.add_row("search", "List all target discovery commands")
|
||||
help_sub_cmd_table.add_row("source", "List all source code download commands (for developers)")
|
||||
|
||||
syntax = f"{green}help:<command>{reset}"
|
||||
xprint(core_cmd_table)
|
||||
xprint(f"\n\n{usage_text.format(syntax, 'octosuite')}")
|
||||
xprint(help_sub_cmd_table)
|
||||
|
||||
@@ -1,25 +1,21 @@
|
||||
'''
|
||||
logRoller
|
||||
This class is where the main notification strings/messages are held,
|
||||
and are being used in two different cases (they're beig used by logging to be written to log files, and being printed out to the screen).
|
||||
'''
|
||||
class logRoller:
|
||||
Ctrl = 'Session terminated with {}.'
|
||||
Error = 'An error occurred: {}'
|
||||
sessionOpened = 'Opened new session on {}:{}'
|
||||
sessionClosed = 'Session closed at {}.'
|
||||
deletedLog = 'Deleted log: {}'
|
||||
readingLog = 'Reading log: {}'
|
||||
viewingLogs = 'Viewing logs...'
|
||||
fileDownloading = 'Downloading ({})...'
|
||||
fileDownloaded = 'Downloaded. Saved to downloads/{}'
|
||||
fileNotFound = 'File ({}) not found.'
|
||||
infoNotFound = 'Information ({} - {} - {}) not found.'
|
||||
repoNotFound = 'Repository ({}) not found.'
|
||||
userNotFound = 'User (@{}) not found.'
|
||||
orgNotFound = 'Organization (@{}) not found.'
|
||||
repoOrUserNotFound = 'Repository or user not found ({} - @{}).'
|
||||
askLogCsv = 'Do you wish to log this output to a .csv file? (Y/n) '
|
||||
loggedToCsv = 'Output logged to {}'
|
||||
loggingSkipped = '.csv logging skipped.'
|
||||
limitInput = ' Limit {} output to how many? (1-100) '
|
||||
# LogRoller This class is where the main notification strings/messages are held, and are being used in two different
|
||||
# cases (they're being used by logging to be written to log files, and being printed out to the screen).
|
||||
|
||||
|
||||
ctrl_c = "Session terminated with Ctrl+C."
|
||||
error = "An error occurred: {}"
|
||||
session_opened = "Opened new session on {}:{}"
|
||||
session_closed = "Session closed at {}."
|
||||
viewing_logs = "Viewing logs"
|
||||
viewing_csv = "Viewing CSV file(s)..."
|
||||
deleted = "Deleted: {}"
|
||||
reading = "Reading: {}"
|
||||
file_downloading = "Downloading: {}"
|
||||
file_downloaded = "Downloaded: downloads/{}"
|
||||
info_not_found = "Information not found: {}, {}, {}"
|
||||
user_not_found = "User not found: @{}"
|
||||
org_not_found = "Organization not found: @{}"
|
||||
repo_or_user_not_found = "Repository or User not found: {}, @{}"
|
||||
prompt_log_csv = "Would you like to log this output to a .csv file?"
|
||||
logged_to_csv = "Output logged: {}"
|
||||
limit_output = "Limit '{}' output to how many? (1-100)"
|
||||
|
||||
@@ -1,951 +1,52 @@
|
||||
#!usr/bin/python
|
||||
|
||||
import os
|
||||
import csv
|
||||
import sys
|
||||
import json
|
||||
import logging
|
||||
import getpass
|
||||
import requests
|
||||
import platform
|
||||
import subprocess
|
||||
from pprint import pprint
|
||||
from datetime import datetime
|
||||
from octosuite.helper import Help
|
||||
from octosuite.colors import Color
|
||||
from octosuite.banner import Banner
|
||||
from octosuite.sign_vars import SignVar
|
||||
from octosuite.log_roller import logRoller
|
||||
from octosuite.csv_loggers import csvLogger
|
||||
# import everything from the octosuite.py file
|
||||
from octosuite.octosuite import * # I drifted away from the 'pythonic way' here
|
||||
|
||||
|
||||
global endpoint
|
||||
global path_attrs
|
||||
global path_attr_dict
|
||||
global org_attrs
|
||||
global org_attr_dict
|
||||
global repo_attrs
|
||||
global repo_attr_dict
|
||||
global repo_releases_attrs
|
||||
global repo_releases_attr_dict
|
||||
global profile_attrs
|
||||
global profile_attr_dict
|
||||
global user_attrs
|
||||
global user_attr_dict
|
||||
global topic_attrs
|
||||
global topic_attr_dict
|
||||
global gists_attrs
|
||||
global gists_attr_dict
|
||||
global issue_attrs
|
||||
global issue_attr_dict
|
||||
global repo_issues_attrs
|
||||
global repo_issues_attr_dict
|
||||
global user_orgs_attrs
|
||||
global user_orgs_attr_dict
|
||||
global author_dict
|
||||
|
||||
|
||||
# API endpoint
|
||||
endpoint = 'https://api.github.com'
|
||||
# Path attribute
|
||||
path_attrs =['size','type','path','sha','html_url']
|
||||
# Path attribute dictionary
|
||||
path_attr_dict = {'size': 'Size (bytes)',
|
||||
'type': 'Type',
|
||||
'path': 'Path',
|
||||
'sha': 'SHA',
|
||||
'html_url': 'URL'}
|
||||
|
||||
|
||||
# Organization attributes
|
||||
org_attrs = ['avatar_url','login','id','node_id','email','description','blog','location','followers','following','twitter_username','public_gists','public_repos','type','is_verified','has_organization_projects','has_repository_projects','created_at','updated_at']
|
||||
# Organization attribute dictionary
|
||||
org_attr_dict = {'avatar_url': 'Profile Photo',
|
||||
'login': 'Username',
|
||||
'id': 'ID',
|
||||
'node_id': 'Node ID',
|
||||
'email': 'Email',
|
||||
'description': 'About',
|
||||
'location': 'Location',
|
||||
'blog': 'Blog',
|
||||
'followers': 'Followers',
|
||||
'following': 'Following',
|
||||
'twitter_username': 'Twitter handle',
|
||||
'public_gists': 'Gists',
|
||||
'public_repos': 'Repositories',
|
||||
'type': 'Account type',
|
||||
'is_verified': 'Is verified?',
|
||||
'has_organization_projects': 'Has organization projects?',
|
||||
'has_repository_projects': 'Has repository projects?',
|
||||
'created_at': 'Created at',
|
||||
'updated_at': 'Updated at'}
|
||||
|
||||
|
||||
# Repository attributes
|
||||
repo_attrs = ['id','description','forks','stargazers_count','watchers','license','default_branch','visibility','language','open_issues','topics','homepage','clone_url','ssh_url','fork','allow_forking','private','archived','has_downloads','has_issues','has_pages','has_projects','has_wiki','pushed_at','created_at','updated_at']
|
||||
# Repository attribute dictionary
|
||||
repo_attr_dict = {'id': 'ID',
|
||||
'description': 'About',
|
||||
'forks': 'Forks',
|
||||
'stargazers_count': 'Stars',
|
||||
'watchers': 'Watchers',
|
||||
'license': 'License',
|
||||
'default_branch': 'Branch',
|
||||
'visibility': 'Visibility',
|
||||
'language': 'Language(s)',
|
||||
'open_issues': 'Open issues',
|
||||
'topics': 'Topics',
|
||||
'homepage': 'Homepage',
|
||||
'clone_url': 'Clone URL',
|
||||
'ssh_url': 'SSH URL',
|
||||
'fork': 'Is fork?',
|
||||
'allow_forking': 'Is forkable?',
|
||||
'private': 'Is private?',
|
||||
'archived': 'Is archived?',
|
||||
'is_template': 'Is template?',
|
||||
'has_wiki': 'Has wiki?',
|
||||
'has_pages': 'Has pages?',
|
||||
'has_projects': 'Has projects?',
|
||||
'has_issues': 'Has issues?',
|
||||
'has_downloads': 'Has downloads?',
|
||||
'pushed_at': 'Pushed at',
|
||||
'created_at': 'Created at',
|
||||
'updated_at': 'Updated at'}
|
||||
|
||||
|
||||
# Repo releases attributes
|
||||
repo_releases_attrs = ['id', 'node_id','tag_name','target_commitish','assets','draft','prerelease','created_at','published_at']
|
||||
# Repo releases attribute dictionary
|
||||
repo_releases_attr_dict = {'id': 'ID',
|
||||
'node_id': 'Node ID',
|
||||
'tag_name': 'Tag',
|
||||
'target_commitish': 'Branch',
|
||||
'assets': 'Assets',
|
||||
'draft': 'Is draft?',
|
||||
'prerelease': 'Is prerelease?',
|
||||
'created_at': 'Created at',
|
||||
'published_at': 'Published at'}
|
||||
|
||||
|
||||
# Profile attributes
|
||||
profile_attrs = ['avatar_url','login','id','node_id','bio','blog','location','followers','following','twitter_username','public_gists','public_repos','company','hireable','site_admin','created_at','updated_at']
|
||||
# Profile attribute dictionary
|
||||
profile_attr_dict = {'avatar_url': 'Profile Photo',
|
||||
'login': 'Username',
|
||||
'id': 'ID',
|
||||
'node_id': 'Node ID',
|
||||
'bio': 'Bio',
|
||||
'blog': 'Blog',
|
||||
'location': 'Location',
|
||||
'followers': 'Followers',
|
||||
'following': 'Following',
|
||||
'twitter_username': 'Twitter Handle',
|
||||
'public_gists': 'Gists (public)',
|
||||
'public_repos': 'Repositories (public)',
|
||||
'company': 'Organization',
|
||||
'hireable': 'Is hireable?',
|
||||
'site_admin': 'Is site admin?',
|
||||
'created_at': 'Joined at',
|
||||
'updated_at': 'Updated at'}
|
||||
|
||||
|
||||
# User attributes
|
||||
user_attrs = ['avatar_url','id','node_id','gravatar_id','site_admin','type','html_url']
|
||||
# User attribute dictionary
|
||||
user_attr_dict = {'avatar_url': 'Profile Photo',
|
||||
'id': 'ID',
|
||||
'node_id': 'Node ID',
|
||||
'gravatar_id': 'Gravatar ID',
|
||||
'site_admin': 'Is site admin?',
|
||||
'type': 'Account type',
|
||||
'html_url': 'URL'}
|
||||
|
||||
|
||||
# Topic atrributes
|
||||
topic_attrs = ['score','curated','featured','display_name','created_by','created_at','updated_at']
|
||||
# Topic attribute dictionary
|
||||
topic_attr_dict = {'score': 'Score',
|
||||
'curated': 'Curated',
|
||||
'featured': 'Featured',
|
||||
'display_name': 'Display name',
|
||||
'created_by': 'Created by',
|
||||
'created_at': 'Created at',
|
||||
'updated_at': 'Updated at'}
|
||||
|
||||
|
||||
# Gists attributes
|
||||
gists_attrs = ['node_id','description','comments','files','git_push_url','public','truncated','updated_at']
|
||||
# Gists attribute dictionary
|
||||
gists_attr_dict = {'node_id': 'Node ID',
|
||||
'description': 'About',
|
||||
'comments': 'Comments',
|
||||
'files': 'Files',
|
||||
'git_push_url': 'Git Push URL',
|
||||
'public': 'Is public?',
|
||||
'truncated': 'Is truncated?',
|
||||
'updated_at': 'Updated at'}
|
||||
|
||||
|
||||
# Issue attributes
|
||||
issue_attrs = ['id','node_id','score','state','number','comments','milestone','assignee','assignees','labels','locked','draft','closed_at']
|
||||
# Issue attribute dict
|
||||
issue_attr_dict = {'id': 'ID',
|
||||
'node_id': 'Node ID',
|
||||
'score': 'Score',
|
||||
'state': 'State',
|
||||
'closed_at': 'Closed at',
|
||||
'number': 'Number',
|
||||
'comments': 'Comments',
|
||||
'milestone': 'Milestone',
|
||||
'assignee': 'Assignee',
|
||||
'assignees': 'Assignees',
|
||||
'labels': 'Labels',
|
||||
'draft': 'Is draft?',
|
||||
'locked': 'Is locked?',
|
||||
'created_at': 'Created at'}
|
||||
|
||||
|
||||
# Repo issues attributes
|
||||
repo_issues_attrs = ['id','node_id','state', 'reactions','number','comments','milestone','assignee','active_lock_reason', 'author_association','assignees','labels','locked','closed_at','created_at','updated_at']
|
||||
# Issue attribute dict
|
||||
repo_issues_attr_dict = {'id': 'ID',
|
||||
'node_id': 'Node ID',
|
||||
'number': 'Number',
|
||||
'state': 'State',
|
||||
'reactions': 'Reactions',
|
||||
'comments': 'Comments',
|
||||
'milestone': 'Milestone',
|
||||
'assignee': 'Assignee',
|
||||
'assignees': 'Assignees',
|
||||
'author_association': 'Author association',
|
||||
'labels': 'Labels',
|
||||
'locked': 'Is locked?',
|
||||
'active_lock_reason': 'Lock reason',
|
||||
'closed_at': 'Closed at',
|
||||
'created_at': 'Created at',
|
||||
'updated_at': 'Updated at'}
|
||||
|
||||
|
||||
# User organizations attributes
|
||||
user_orgs_attrs = ['avatar_url','id','node_id','url','description']
|
||||
user_orgs_attr_dict = {'avatar_url': 'Profile Photo',
|
||||
'id': 'ID',
|
||||
'node_id': 'Node ID',
|
||||
'url': 'URL',
|
||||
'description': 'About'}
|
||||
|
||||
|
||||
# Author dictionary
|
||||
author_dict = {'Alias': 'rly0nheart',
|
||||
'Country': 'Zambia, Africa',
|
||||
'About.me': 'https://about.me/rly0nheart',
|
||||
'BuyMeACoffee': 'https://buymeacoffee.com/189381184'}
|
||||
|
||||
|
||||
'''
|
||||
pathFinder()
|
||||
This function is responsible for creating/checking the availability of the (.logs, output, downloads) folders,
|
||||
enabling logging to automatically log network/user activity to a file,
|
||||
and logging the start of a session.
|
||||
'''
|
||||
def pathFinder():
|
||||
'''
|
||||
Windows based machines
|
||||
Here we check the existence of 3 directories
|
||||
If the directories exist, we ignore them.
|
||||
If not, we create them.
|
||||
'''
|
||||
if sys.platform.lower().startswith(('win', 'darwin')):
|
||||
if os.path.exists('.logs'):
|
||||
pass
|
||||
else:
|
||||
subprocess.run(['mkdir','.logs'])
|
||||
|
||||
if os.path.exists('output'):
|
||||
pass
|
||||
else:
|
||||
subprocess.run(['mkdir','output'])
|
||||
|
||||
if os.path.exists('downloads'):
|
||||
pass
|
||||
else:
|
||||
subprocess.run(['mkdir','.downloads'])
|
||||
else:
|
||||
'''
|
||||
Here we do the same as above,
|
||||
except we are not creating on windows based machines
|
||||
'''
|
||||
if os.path.exists('.logs'):
|
||||
pass
|
||||
else:
|
||||
subprocess.run(['sudo','mkdir','.logs'], shell=False)
|
||||
|
||||
if os.path.exists('output'):
|
||||
pass
|
||||
else:
|
||||
subprocess.run(['sudo','mkdir','output'], shell=False)
|
||||
|
||||
if os.path.exists('downloads'):
|
||||
pass
|
||||
else:
|
||||
subprocess.run(['sudo', 'mkdir', 'downloads'], shell=False)
|
||||
|
||||
'''
|
||||
Configure logging to log activities to a file, which will be named by the date and time a session was opened.
|
||||
'''
|
||||
now = datetime.now()
|
||||
now_formatted = now.strftime('%Y-%m-%d %H:%M:%S%p')
|
||||
logging.basicConfig(filename=f'.logs/{now_formatted}.log', format='[%(asctime)s] [%(levelname)s] %(message)s', datefmt='%Y-%m-%d %H:%M:%S%p', level=logging.DEBUG)
|
||||
# Log the start of a session
|
||||
logging.info(logRoller.sessionOpened.format(platform.node(), getpass.getuser()))
|
||||
|
||||
|
||||
'''
|
||||
onStart()
|
||||
This is the main function, responsible for mapping commands, calling other functions, and catching exceptions
|
||||
'''
|
||||
def onStart():
|
||||
pathFinder()
|
||||
# A list of tuples mapping commands to their functions
|
||||
command_map = [('org', Help.Org),
|
||||
('org:events', orgEvents),
|
||||
('org:profile', orgProfile),
|
||||
('org:repos', orgRepos),
|
||||
('org:member', orgMember),
|
||||
('repo', Help.Repo),
|
||||
('repo:pathcontents', pathContents),
|
||||
('repo:profile', repoProfile),
|
||||
('repo:contributors', repoContributors),
|
||||
('repo:stargazers', repoStargazers),
|
||||
('repo:forks', repoForks),
|
||||
('repo:issues', repoIssues),
|
||||
('repo:releases', repoReleases),
|
||||
('user', Help.User),
|
||||
('user:repos', userRepos),
|
||||
('user:gists', userGists),
|
||||
('user:orgs', userOrgs),
|
||||
('user:profile', userProfile),
|
||||
('user:events', userEvents),
|
||||
('user:followers', userFollowers),
|
||||
('user:follows', userFollows),
|
||||
('user:following', userFollowing),
|
||||
('user:subscriptions', userSubscriptions),
|
||||
('search', Help.Search),
|
||||
('search:users', userSearch),
|
||||
('search:repos', repoSearch),
|
||||
('search:topics', topicSearch),
|
||||
('search:issues', issueSearch),
|
||||
('search:commits', commitsSearch),
|
||||
('source', Help.Source),
|
||||
('source:tarball', downloadTarball),
|
||||
('source:zipball', downloadZipball),
|
||||
('logs', Help.Logs),
|
||||
('logs:view',viewLogs),
|
||||
('logs:read',readLog),
|
||||
('logs:delete',deleteLog),
|
||||
('help', Help.helpCommand),
|
||||
('help:version', Help.versionCommand),
|
||||
('help:source', Help.sourceCommand),
|
||||
('help:search', Help.searchCommand),
|
||||
('help:user', Help.userCommand),
|
||||
('help:repo', Help.repoCommand),
|
||||
('help:logs', Help.logsCommand),
|
||||
('help:org', Help.orgCommand),
|
||||
('author', author),
|
||||
('about', about),
|
||||
('clear',clearScreen),
|
||||
('version', Help.Version),
|
||||
('version:info', versionInfo),
|
||||
('version:check', versionCheck),
|
||||
('exit', exitSession)]
|
||||
|
||||
|
||||
print(Banner.nameLogo)
|
||||
'''
|
||||
Main loop keeps octosuite running, this will break if Octosuite detects a KeyboardInterrupt (Ctrl+C)
|
||||
or if the 'exit' command is entered.
|
||||
'''
|
||||
while True:
|
||||
try:
|
||||
command_input = input(f'''{Color.white}┌──({Color.red}{getpass.getuser()}{Color.white}@{Color.red}octosuite{Color.white})\n├──[{Color.green}~{os.getcwd()}{Color.white}]\n└╼{Color.reset} ''').lower()
|
||||
print('\n')
|
||||
'''
|
||||
Iterating over the command_map and check if the user input matches any command in it [command_map],
|
||||
if there's a match, we return its function. If no match is found, we ignore it.
|
||||
'''
|
||||
for command, function in command_map:
|
||||
if command_input == command:
|
||||
function()
|
||||
print('\n')
|
||||
def octosuite():
|
||||
try:
|
||||
run = Octosuite()
|
||||
path_finder()
|
||||
configure_logging()
|
||||
check_updates()
|
||||
if args.method:
|
||||
"""
|
||||
Iterate over the argument_map and check if the passed command line argument matches any argument in it [argument_map],
|
||||
if there's a match, we return its method. If no match is found, we do nothing (which will return the usage).
|
||||
"""
|
||||
for argument, method in run.argument_map:
|
||||
if args.method == argument:
|
||||
method()
|
||||
print("\n")
|
||||
else:
|
||||
pass
|
||||
else:
|
||||
"""
|
||||
Main loop keeps octosuite running, this will break if Octosuite detects a KeyboardInterrupt (Ctrl+C)
|
||||
or if the 'exit' command is entered.
|
||||
"""
|
||||
xprint(banner()[0], banner()[1])
|
||||
while True:
|
||||
command_input = Prompt.ask(f"{white}┌──({red}{getpass.getuser()}{white}@{red}octosuite{white})\n├──[~{green}{os.getcwd()}{white}]\n└╼{reset}")
|
||||
"""
|
||||
Iterate over the command_map and check if the user input matches any command in it [command_map],
|
||||
if there's a match, we return its method. If no match is found, we ignore it.
|
||||
"""
|
||||
if command_input[:2] == 'cd':
|
||||
os.chdir(command_input[3:])
|
||||
elif command_input[:2] == 'ls':
|
||||
os.system(f'dir {command_input[3:]}' if os.name == 'nt' else f'ls {command_input[3:]}')
|
||||
else:
|
||||
for command, method in run.command_map:
|
||||
if command_input == command:
|
||||
method()
|
||||
print("\n")
|
||||
else:
|
||||
pass
|
||||
|
||||
# This catches the KeyboardInterrupt exception (Ctrl+C)
|
||||
except KeyboardInterrupt:
|
||||
logging.warning(logRoller.Ctrl.format('Ctrl+C'))
|
||||
sys.stdout.write(f"{SignVar.warning} {logRoller.Ctrl}".format(f"{Color.red}Ctrl{Color.reset}+{Color.red}C{Color.reset}")+'\n');break
|
||||
|
||||
# This initially catches all exceptions (except the KeyboardInterrupt)
|
||||
except Exception as e:
|
||||
logging.error(logRoller.Error.format(e))
|
||||
sys.stderr.write(f"{SignVar.error} {logRoller.Error}".format(f'{Color.red}{e}{Color.reset}')+'\n')
|
||||
|
||||
|
||||
# Fetching organization info
|
||||
def orgProfile():
|
||||
organization = input(f'{Color.white}--> @{Color.green}Organization{Color.white} (username){Color.reset} ')
|
||||
response = requests.get(f'{endpoint}/orgs/{organization}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.orgNotFound.format(organization)}\n")
|
||||
elif response.status_code == 200:
|
||||
print(f"\n{Color.white}{response.json()['name']}{Color.reset}")
|
||||
for attr in org_attrs:
|
||||
print(f'{Color.white}├─ {org_attr_dict[attr]}: {Color.green}{response.json()[attr]}{Color.reset}')
|
||||
csvLogger.logOrgProfile(response)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# Fetching user information
|
||||
def userProfile():
|
||||
username = input(f'{Color.white}--> @{Color.green}Username{Color.reset} ')
|
||||
response = requests.get(f'{endpoint}/users/{username}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.userNotFound.format(username)}\n")
|
||||
elif response.status_code == 200:
|
||||
print(f"\n{Color.white}{response.json()['name']}{Color.reset}")
|
||||
for attr in profile_attrs:
|
||||
print(f'{Color.white}├─ {profile_attr_dict[attr]}: {Color.green}{response.json()[attr]}{Color.reset}')
|
||||
csvLogger.logUserProfile(response)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# Fetching repository information
|
||||
def repoProfile():
|
||||
repo_name = input(f'{Color.white}--> %{Color.green}Repository{Color.reset} ')
|
||||
username = input(f'{Color.white}--> @{Color.green}Owner{Color.white} (username){Color.reset} ')
|
||||
response = requests.get(f'{endpoint}/repos/{username}/{repo_name}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.repoOrUserNotFound.format(repo_name, username)}\n")
|
||||
elif response.status_code == 200:
|
||||
print(f"\n{Color.white}{response.json()['full_name']}{Color.reset}")
|
||||
for attr in repo_attrs:
|
||||
print(f"{Color.white}├─ {repo_attr_dict[attr]}: {Color.green}{response.json()[attr]}{Color.reset}")
|
||||
csvLogger.logRepoProfile(response)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# Get path contents
|
||||
def pathContents():
|
||||
repo_name = input(f'{Color.white}--> %{Color.green}Repository{Color.reset} ')
|
||||
username = input(f'{Color.white}--> @{Color.green}Owner{Color.white} (username){Color.reset} ')
|
||||
path_name = input(f'{Color.white}--> ~{Color.green}/path/name{Color.reset} ')
|
||||
response = requests.get(f'{endpoint}/repos/{username}/{repo_name}/contents/{path_name}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.infoNotFound.format(repo_name, username, path_name)}\n")
|
||||
elif response.status_code == 200:
|
||||
for content in response.json():
|
||||
print(f"\n{Color.white}{content['name']}{Color.reset}")
|
||||
for attr in path_attrs:
|
||||
print(f'{Color.white}├─ {path_attr_dict[attr]}: {Color.green}{content[attr]}{Color.reset}')
|
||||
csvLogger.logRepoPathContents(content, repo_name)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# repo contributors
|
||||
def repoContributors():
|
||||
repo_name = input(f'{Color.white}--> %{Color.green}Repository{Color.reset} ')
|
||||
username = input(f'{Color.white}--> @{Color.green}Owner{Color.white} (username){Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('contributors'))
|
||||
response = requests.get(f'{endpoint}/repos/{username}/{repo_name}/contributors?per_page={limit}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.repoOrUserNotFound.format(repo_name, username)}\n")
|
||||
elif response.status_code == 200:
|
||||
for contributor in response.json():
|
||||
print(f"\n{Color.white}{contributor['login']}{Color.reset}")
|
||||
for attr in user_attrs:
|
||||
print(f'{Color.white}├─ {user_attr_dict[attr]}: {Color.green}{contributor[attr]}{Color.reset}')
|
||||
csvLogger.logRepoContributors(contributor, repo_name)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# repo stargazers
|
||||
def repoStargazers():
|
||||
repo_name = input(f'{Color.white}--> %{Color.green}Repository{Color.reset} ')
|
||||
username = input(f'{Color.white}--> @{Color.green}Owner{Color.white} (username){Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('repository stargazers'))
|
||||
response = requests.get(f'{endpoint}/repos/{username}/{repo_name}/stargazers?per_page={limit}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.repoOrUserNotFound.format(repo_name, username)}\n")
|
||||
elif response.json() == {}:
|
||||
sys.stdout.write(f'{SignVar.negative} Repository ({repo_name}) does not have any stargazers.{Color.reset}\n')
|
||||
elif response.status_code == 200:
|
||||
for stargazer in response.json():
|
||||
print(f"\n{Color.white}{stargazer['login']}{Color.reset}")
|
||||
for attr in user_attrs:
|
||||
print(f'{Color.white}├─ {user_attr_dict[attr]}: {Color.green}{stargazer[attr]}{Color.reset}')
|
||||
csvLogger.logRepoStargazers(stargazer, repo_name)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# repo forks
|
||||
def repoForks():
|
||||
repo_name = input(f'{Color.white}--> %{Color.green}Repository{Color.reset} ')
|
||||
username = input(f'{Color.white}--> @{Color.green}Owner{Color.white} (username){Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('repository forks'))
|
||||
response = requests.get(f'{endpoint}/repos/{username}/{repo_name}/forks?per_page={limit}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.repoOrUserNotFound.format(repo_name, username)}\n")
|
||||
elif response.json() == {}:
|
||||
sys.stdout.write(f'{SignVar.negative} Repository ({repo_name}) does not have forks.{Color.reset}\n')
|
||||
elif response.status_code == 200:
|
||||
count = 0
|
||||
for fork in response.json():
|
||||
count += 1
|
||||
print(f"\n{Color.white}{fork['full_name']}{Color.reset}")
|
||||
for attr in repo_attrs:
|
||||
print(f'{Color.white}├─ {repo_attr_dict[attr]}: {Color.green}{fork[attr]}{Color.reset}')
|
||||
csvLogger.logRepoForks(fork, count)
|
||||
else:
|
||||
pprint(response.json())
|
||||
except KeyboardInterrupt:
|
||||
logging.warning(ctrl_c)
|
||||
xprint(f"\n{WARNING} {ctrl_c}")
|
||||
|
||||
|
||||
# Repo issues
|
||||
def repoIssues():
|
||||
repo_name = input(f'{Color.white}--> %{Color.green}Repository{Color.reset} ')
|
||||
username = input(f'{Color.white}--> @{Color.green}Owner{Color.white} (username){Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('repository issues'))
|
||||
response = requests.get(f'{endpoint}/repos/{username}/{repo_name}/issues?per_page={limit}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.repoOrUserNotFound.format(repo_name, username)}\n")
|
||||
elif response.json() == []:
|
||||
sys.stdout.write(f'{SignVar.negative} Repository ({repo_name}) does not have open issues.{Color.reset}\n')
|
||||
elif response.status_code == 200:
|
||||
for issue in response.json():
|
||||
print(f"\n{Color.white}{issue['title']}{Color.reset}")
|
||||
for attr in repo_issues_attrs:
|
||||
print(f'{Color.white}├─ {repo_issues_attr_dict[attr]}: {Color.green}{issue[attr]}{Color.reset}')
|
||||
print(issue['body'])
|
||||
csvLogger.logRepoIssues(issue, repo_name)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# Repo releases
|
||||
def repoReleases():
|
||||
repo_name = input(f'{Color.white}--> %{Color.green}Repository{Color.reset} ')
|
||||
username = input(f'{Color.white}--> @{Color.green}Owner{Color.white} (username){Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('repository releases'))
|
||||
response = requests.get(f'{endpoint}/repos/{username}/{repo_name}/releases?per_page={limit}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.repoOrUserNotFound.format(repo_name, username)}\n")
|
||||
elif response.json() == []:
|
||||
sys.stdout.write(f"{SignVar.negative} Repository ({repo_name}) does not have releases.{Color.reset}\n")
|
||||
elif response.status_code == 200:
|
||||
for release in response.json():
|
||||
print(f"\n{Color.white}{release['name']}{Color.reset}")
|
||||
for attr in repo_releases_attrs:
|
||||
print(f'{Color.white}├─ {repo_releases_attr_dict[attr]}: {Color.green}{release[attr]}{Color.reset}')
|
||||
print(release['body'])
|
||||
csvLogger.logRepoReleases(release, repo_name)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# Fetching organization repositories
|
||||
def orgRepos():
|
||||
organization = input(f'{Color.white}--> @{Color.green}Organization{Color.white} (username){Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('organization repositories'))
|
||||
response = requests.get(f'{endpoint}/orgs/{organization}/repos?per_page={limit}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.orgNotFound.format(organization)}\n")
|
||||
elif response.status_code == 200:
|
||||
for repository in response.json():
|
||||
print(f"\n{Color.white}{repository['full_name']}{Color.reset}")
|
||||
for attr in repo_attrs:
|
||||
print(f"{Color.white}├─ {repo_attr_dict[attr]}: {Color.green}{repository[attr]}{Color.reset}")
|
||||
csvLogger.logOrgRepos(repository, organization)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# organization events
|
||||
def orgEvents():
|
||||
organization = input(f"{Color.white}--> @{Color.green}Organization{Color.white} (username){Color.reset} ")
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('organization events'))
|
||||
response = requests.get(f'{endpoint}/orgs/{organization}/events?per_page={limit}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.orgNotFound.format(organization)}\n")
|
||||
elif response.status_code == 200:
|
||||
for event in response.json():
|
||||
print(f"\n{Color.white}{event['id']}{Color.reset}")
|
||||
print(f"{Color.white}├─ Type: {Color.green}{event['type']}{Color.reset}\n{Color.white}├─ Created at: {Color.green}{event['created_at']}{Color.reset}")
|
||||
pprint(event['payload'])
|
||||
csvLogger.logOrgEvents(event, organization)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# organization member
|
||||
def orgMember():
|
||||
organization = input(f"{Color.white}--> @{Color.green}Organization{Color.white} (username){Color.reset} ")
|
||||
username = input(f'{Color.white}--> @{Color.green}Username{Color.reset} ')
|
||||
response = requests.get(f'{endpoint}/orgs/{organization}/public_members/{username}')
|
||||
if response.status_code == 204:
|
||||
sys.stdout.write(f"{SignVar.positive} User ({username}) is a public member of the organization ({organization}){Color.reset}\n")
|
||||
else:
|
||||
sys.stdout.write(f"{SignVar.negative} {response.json()['message']}{Color.reset}\n")
|
||||
|
||||
|
||||
# Fetching user repositories
|
||||
def userRepos():
|
||||
username = input(f'{Color.white}--> @{Color.green}Username{Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('repositories'))
|
||||
response = requests.get(f'{endpoint}/users/{username}/repos?per_page={limit}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.userNotFound.format(username)}\n")
|
||||
elif response.status_code == 200:
|
||||
for repository in response.json():
|
||||
print(f"\n{Color.white}{repository['full_name']}{Color.reset}")
|
||||
for attr in repo_attrs:
|
||||
print(f"{Color.white}├─ {repo_attr_dict[attr]}: {Color.green}{repository[attr]}{Color.reset}")
|
||||
csvLogger.logUserRepos(repository, username)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# Fetching user's gists
|
||||
def userGists():
|
||||
username = input(f'{Color.white}--> @{Color.green}Username{Color.reset} ')
|
||||
limit = input(f'{SignVar.prompt+logRoller.limitInput.format("gists")}')
|
||||
response = requests.get(f'{endpoint}/users/{username}/gists?per_page={limit}')
|
||||
#pprint(response.json())
|
||||
if response.json() == []:
|
||||
sys.stdout.write(f'{SignVar.negative} User does not have gists.{Color.reset}\n')
|
||||
elif response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.userNotFound.format(username)}\n")
|
||||
elif response.status_code == 200:
|
||||
for gist in response.json():
|
||||
print(f"\n{Color.white}{gist['id']}{Color.reset}")
|
||||
for attr in gists_attrs:
|
||||
print(f"{Color.white}├─ {gists_attr_dict[attr]}: {Color.green}{gist[attr]}{Color.reset}")
|
||||
csvLogger.logUserGists(gist)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
|
||||
# Fetching a list of organizations that a user owns or belongs to
|
||||
def userOrgs():
|
||||
username = input(f'{Color.white}--> @{Color.green}Username{Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('user organizations'))
|
||||
response = requests.get(f'{endpoint}/users/{username}/orgs?per_page={limit}')
|
||||
if response.json() == []:
|
||||
sys.stdout.write(f'{SignVar.negative} User ({username}) does not (belong to/own) any organizations.{Color.reset}\n')
|
||||
elif response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.userNotFound.format(username)}\n")
|
||||
elif response.status_code == 200:
|
||||
for organization in response.json():
|
||||
print(f'\n{Color.white}{organization["login"]}{Color.reset}')
|
||||
for attr in user_orgs_attrs:
|
||||
print(f'{Color.white}├─ {user_orgs_attr_dict[attr]}: {Color.green}{organization[attr]}{Color.reset}')
|
||||
csvLogger.logUserOrgs(organization, username)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# Fetching a users events
|
||||
def userEvents():
|
||||
username = input(f'{Color.white}--> @{Color.green}Username{Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('events'))
|
||||
response = requests.get(f'{endpoint}/users/{username}/events/public?per_page={limit}')
|
||||
if response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.userNotFound.format(username)}\n")
|
||||
elif response.status_code == 200:
|
||||
for event in response.json():
|
||||
print(f"\n{Color.white}{event['id']}{Color.reset}")
|
||||
print(f"{Color.white}├─ Actor: {Color.green}{event['actor']['login']}{Color.reset}")
|
||||
print(f"{Color.white}├─ Type: {Color.green}{event['type']}{Color.green}")
|
||||
print(f"{Color.white}├─ Repository: {Color.green}{event['repo']['name']}{Color.reset}")
|
||||
print(f"{Color.white}├─ Created at: {Color.green}{event['created_at']}{Color.reset}")
|
||||
pprint(event['payload'])
|
||||
csvLogger.logUserEvents(event)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# Fetching a target user's subscriptions
|
||||
def userSubscriptions():
|
||||
username = input(f'{Color.white}--> @{Color.green}Username{Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('user subscriptions'))
|
||||
response = requests.get(f'{endpoint}/users/{username}/subscriptions?per_page={limit}')
|
||||
if response.json() == []:
|
||||
print(f"{SignVar.negative} User does not have any subscriptions.{Color.reset}\n")
|
||||
elif response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.userNotFound.format(username)}\n")
|
||||
elif response.status_code == 200:
|
||||
for repository in response.json():
|
||||
print(f"\n{Color.white}{repository['full_name']}{Color.reset}")
|
||||
for attr in repo_attrs:
|
||||
print(f"{Color.white}├─ {repo_attr_dict[attr]}: {Color.green}{repository[attr]}{Color.reset}")
|
||||
csvLogger.logUserSubscriptions(repository, username)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# Fetching a list of users the target follows
|
||||
def userFollowing():
|
||||
username = input(f'{Color.white}--> @{Color.green}Username{Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('user\' following'))
|
||||
response = requests.get(f'{endpoint}/users/{username}/following?per_page={limit}')
|
||||
if response.json() == []:
|
||||
sys.stdout.write(f'{SignVar.negative} User ({username})does not follow anyone.{Color.reset}')
|
||||
elif response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.userNotFound.format(username)}\n")
|
||||
elif response.status_code == 200:
|
||||
for user in response.json():
|
||||
print(f"\n{Color.white}@{user['login']}{Color.reset}")
|
||||
for attr in user_attrs:
|
||||
print(f"{Color.white}├─ {user_attr_dict[attr]}: {Color.green}{user[attr]}{Color.reset}")
|
||||
csvLogger.logUserFollowing(user, username)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# Fetching user's followera'
|
||||
def userFollowers():
|
||||
username = input(f'{Color.white}--> @{Color.green}Username{Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('user followers'))
|
||||
response = requests.get(f'{endpoint}/users/{username}/followers?per_page={limit}')
|
||||
if response.json() == []:
|
||||
sys.stdout.write(f'{SignVar.negative} User ({username})does not have followers.{Color.reset}')
|
||||
elif response.status_code == 404:
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.userNotFound.format(username)}\n")
|
||||
elif response.status_code == 200:
|
||||
for follower in response.json():
|
||||
print(f"\n{Color.white}@{follower['login']}{Color.reset}")
|
||||
for attr in user_attrs:
|
||||
print(f"{Color.white}├─ {user_attr_dict[attr]}: {Color.green}{follower[attr]}{Color.reset}")
|
||||
csvLogger.logUserFollowers(follower, username)
|
||||
else:
|
||||
pprint(response.json())
|
||||
|
||||
|
||||
# Checking whether or not user[A] follows user[B]
|
||||
def userFollows():
|
||||
user_a = input(f'{Color.white}--> @{Color.green}user{Color.white}(A) (username){Color.reset} ')
|
||||
user_b = input(f'{Color.white}--> @{Color.green}user{Color.white}(B) (username){Color.reset} ')
|
||||
response = requests.get(f'{endpoint}/users/{user_a}/following/{user_b}')
|
||||
if response.status_code == 204:
|
||||
sys.stdout.write(f'{SignVar.positive} @{user_a} FOLLOWS @{user_b}{Color.reset}\n')
|
||||
else:
|
||||
sys.stdout.write(f'{SignVar.negative} @{user_a} DOES NOT FOLLOW @{user_b}{Color.reset}\n')
|
||||
|
||||
|
||||
# User search
|
||||
def userSearch():
|
||||
query = input(f'{Color.white}--> @{Color.green}Query{Color.white} (eg. john){Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('user search'))
|
||||
response = requests.get(f'{endpoint}/search/users?q={query}&per_page={limit}').json()
|
||||
for user in response['items']:
|
||||
print(f"\n{Color.white}@{user['login']}{Color.reset}")
|
||||
for attr in user_attrs:
|
||||
print(f"{Color.white}├─ {user_attr_dict[attr]}: {Color.green}{user[attr]}{Color.reset}")
|
||||
csvLogger.logUserSearch(user, query)
|
||||
|
||||
|
||||
# Repository search
|
||||
def repoSearch():
|
||||
query = input(f'{Color.white}--> %{Color.green}Query{Color.white} (eg. git){Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('repositor[y][ies] search'))
|
||||
response = requests.get(f'{endpoint}/search/repositories?q={query}&per_page={limit}').json()
|
||||
for repository in response['items']:
|
||||
print(f"\n{Color.white}{repository['full_name']}{Color.reset}")
|
||||
for attr in repo_attrs:
|
||||
print(f"{Color.white}├─ {repo_attr_dict[attr]}: {Color.green}{repository[attr]}{Color.reset}")
|
||||
csvLogger.logRepoSearch(repository, query)
|
||||
|
||||
|
||||
# Topics search
|
||||
def topicSearch():
|
||||
query = input(f'{Color.white}--> #{Color.green}Query{Color.white} (eg. osint){Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('topic(s) search'))
|
||||
response = requests.get(f'{endpoint}/search/topics?q={query}&per_page={limit}').json()
|
||||
for topic in response['items']:
|
||||
print(f"\n{Color.white}{topic['name']}{Color.reset}")
|
||||
for attr in topic_attrs:
|
||||
print(f"{Color.white}├─ {topic_attr_dict[attr]}: {Color.green}{topic[attr]}{Color.reset}")
|
||||
csvLogger.logTopicSearch(topic, query)
|
||||
|
||||
|
||||
# Issue search
|
||||
def issueSearch():
|
||||
query = input(f'{Color.white}--> !{Color.green}Query{Color.white} (eg. error){Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('issue(s) search'))
|
||||
response = requests.get(f'{endpoint}/search/issues?q={query}&per_page={limit}').json()
|
||||
for issue in response['items']:
|
||||
print(f"\n\n{Color.white}{issue['title']}{Color.reset}")
|
||||
for attr in repo_issues_attrs:
|
||||
print(f"{Color.white}├─ {repo_issues_attr_dict[attr]}: {Color.green}{issue[attr]}{Color.reset}")
|
||||
print(issue['body'])
|
||||
csvLogger.logIssueSearch(issue, query)
|
||||
|
||||
|
||||
# Commits search
|
||||
def commitsSearch():
|
||||
query = input(f'{Color.white}--> :{Color.green}Query{Color.white} (eg. filename:index.php){Color.reset} ')
|
||||
limit = input(SignVar.prompt+logRoller.limitInput.format('commit(s) search'))
|
||||
response = requests.get(f'{endpoint}/search/commits?q={query}&per_page={limit}').json()
|
||||
for commit in response['items']:
|
||||
print(f"\n{Color.white}{commit['commit']['tree']['sha']}{Color.reset}")
|
||||
print(f"{Color.white}├─ Author: {commit['commit']['author']['name']}{Color.reset}")
|
||||
print(f"{Color.white}├─ Username: {Color.green}{commit['author']['login']}{Color.reset}")
|
||||
print(f"{Color.white}├─ Email: {Color.green}{commit['commit']['author']['email']}{Color.reset}")
|
||||
print(f"{Color.white}├─ Commiter: {Color.green}{commit['commit']['committer']['name']}{Color.reset}")
|
||||
print(f"{Color.white}├─ Repository: {Color.green}{commit['repository']['full_name']}{Color.reset}")
|
||||
print(f"{Color.white}├─ URL: {Color.green}{commit['html_url']}{Color.reset}")
|
||||
pprint(commit['commit']['message'])
|
||||
csvLogger.logCommitsSearch(commit, query)
|
||||
|
||||
|
||||
# View octosuite log files
|
||||
def viewLogs():
|
||||
logging.info(logRoller.viewingLogs)
|
||||
logs = os.listdir('.logs')
|
||||
print(f'''{Color.white}
|
||||
Log Size{Color.reset}
|
||||
--- ---------''')
|
||||
for log in logs:
|
||||
print(f"{log}\t ",os.path.getsize(".logs/"+log),"bytes")
|
||||
|
||||
|
||||
# Read a specified log file
|
||||
def readLog():
|
||||
log_file = input(f"{Color.white}--> .log date (eg. 2022-04-27 10:09:36AM){Color.reset} ")
|
||||
with open(f'.logs/{log_file}.log', 'r') as log:
|
||||
logging.info(logRoller.readingLog.format(log_file))
|
||||
print("\n"+log.read())
|
||||
|
||||
|
||||
# Delete a specified log file
|
||||
def deleteLog():
|
||||
log_file = input(f"{Color.white}--> .log date (eg. 2022-04-27 10:09:36AM){Color.reset} ")
|
||||
if sys.platform.lower().startswith(('win','darwin')):
|
||||
subprocess.run(['del',f'.logs\{log_file}.log'])
|
||||
else:
|
||||
subprocess.run(['sudo','rm',f'.logs/{log_file}.log'],shell=False)
|
||||
|
||||
logging.info(logRoller.deletedLog.format(log_file))
|
||||
sys.stdout.write(f"{SignVar.positive} {logRoller.deletedLog.format(log_file)}\n")
|
||||
|
||||
|
||||
# Downloading release tarball
|
||||
def downloadTarball():
|
||||
logging.info(logRoller.fileDownloading.format(f'octosuite.vBanner.versionTag.tar'))
|
||||
sys.stdout.write(f"{SignVar.info} {logRoller.fileDownloading.format(octosuite.vBanner.versionTag.tar)}\n")
|
||||
data = requests.get(f'{endpoint}/repos/rly0nheart/octosuite/tarball/{Banner.versionTag}')
|
||||
if data.status_code == 404:
|
||||
logging.info(logRoller.tagNotFound.format(Banner.versionTag))
|
||||
sys.stdout.write(SignVar.negative+' '+logRoller.tagNotFound.format(Banner.versionTag))
|
||||
else:
|
||||
with open(f'downloads/octosuite.v{Banner.versionTag}.tar', 'wb') as file:
|
||||
file.write(data.content)
|
||||
file.close()
|
||||
|
||||
logging.info(logRoller.fileDownloaded.format(f'octosuite.v{Banner.versionTag}.tar'))
|
||||
sys.stdout.write(SignVar.positive+' '+logRoller.fileDownloaded.format(f'octosuite.v{Banner.versionTag}.tar')+'\n')
|
||||
|
||||
|
||||
# Downloading release zipball
|
||||
def downloadZipball():
|
||||
logging.info(logRoller.fileDownloading.format(f'octosuite.v{Banner.versionTag}.zip'))
|
||||
sys.stdout.write(f"{SignVar.info} {logRoller.fileDownloading.format(octosuite.vBanner.versionTag.zip)}\n")
|
||||
data = requests.get(f'{endpoint}/repos/rly0nheart/octosuite/zipball/{Banner.versionTag}')
|
||||
if data.status_code == 404:
|
||||
logging.info(logRoller.tagNotFound.format(Banner.versionTag))
|
||||
sys.stdout.write(f"{SignVar.negative} {logRoller.tagNotFound.format(Banner.versionTag)}\n")
|
||||
else:
|
||||
with open(f'downloads/octosuite.v{Banner.versionTag}.tar', 'wb') as file:
|
||||
file.write(data.content)
|
||||
file.close()
|
||||
|
||||
logging.info(logRoller.fileDownloaded.format(f'octosuite.v{Banner.versionTag}.zip'))
|
||||
sys.stdout.write(SignVar.positive+' '+logRoller.fileDownloaded.format(f'octosuite.v{Banner.versionTag}.zip'))
|
||||
|
||||
|
||||
def versionCheck():
|
||||
response = requests.get(f"{endpoint}/repos/rly0nheart/octosuite/releases/latest")
|
||||
if response.json()['tag_name'] == Banner.versionTag:
|
||||
sys.stdout.write(f"{SignVar.positive} Octosuite is up to date. Check again soon :)\n")
|
||||
else:
|
||||
sys.stdout.write(f"{SignVar.info} A new release is available (octosuite.v{response.json()['tag_name']}). Exit Octosuite and run '{Color.green}pip install --upgrade octosuite{Color.white}' to download and install the update.{Color.reset}\n")
|
||||
|
||||
|
||||
# Author info
|
||||
def author():
|
||||
print(f'{Color.white}Richard Mwewa (Ritchie){Color.reset}')
|
||||
for key,value in author_dict.items():
|
||||
print(f'{Color.white}├─ {key}: {Color.green}{value}{Color.reset}')
|
||||
|
||||
|
||||
def about():
|
||||
sys.stdout.write('''
|
||||
OCTOSUITE © 2022 Richard Mwewa
|
||||
|
||||
An advanced and lightning fast framework for gathering open-source intelligence on GitHub users and organizations.
|
||||
|
||||
Read the wiki: https://github.com/rly0nheart/octosuite/wiki
|
||||
GitHub REST API documentation: https://docs.github.com/rest
|
||||
''')
|
||||
|
||||
|
||||
# Close session
|
||||
def exitSession():
|
||||
prompt = input(f'{SignVar.prompt} This will close the current session, continue? (Y/n) ').lower()
|
||||
if prompt == 'y':
|
||||
logging.info(logRoller.sessionClosed.format('exit'))
|
||||
sys.stdout.write(f"{SignVar.info} {logRoller.sessionClosed.format(datetime.now())}\n");exit()
|
||||
else:
|
||||
pass
|
||||
|
||||
|
||||
# Clear screen
|
||||
def clearScreen():
|
||||
'''
|
||||
We use 'cls' on Windows machines to clear the screen,
|
||||
otherwise, we use 'clear'
|
||||
'''
|
||||
if sys.platform.lower().startswith(('win','darwin')):
|
||||
subprocess.run(['cls'])
|
||||
else:
|
||||
subprocess.run(['clear'],shell=False)
|
||||
|
||||
|
||||
# Show version information
|
||||
def versionInfo():
|
||||
'''
|
||||
Yes... the changelog is hard coded
|
||||
It's actually frustrating having to change this everytime I publish a new release lol
|
||||
'''
|
||||
sys.stdout.write(f'''
|
||||
OCTOSUITE.v{Banner.versionTag}
|
||||
|
||||
What's changed?
|
||||
{'='*15}
|
||||
[✓] Fixed session terminating on error
|
||||
[✓] Added a csv logger: users will get to choose whether they wish to log output to a .csv file or not.
|
||||
[✓] For output that comes in bulk, users will get to specify how many result they wish to see
|
||||
[✓] Added a prompt for the 'exit' command
|
||||
[✓] Added 1 subcommand to the 'user' command: [user:follows] will now be used to check if user(A) follows user(B). [user:following] will now be used to return a list of user that the target is following
|
||||
[✓] Added 2 subcommands to the 'repo' command: [repo:issues] used for getting issues of a repository. [repo:releases] for getting releases of a repository
|
||||
[✓] Added 2 subcommands to the 'version' command: [version:check] will be used to check for new releases of octosuite. [version:info] will be used to see version information
|
||||
[✓] Added command 'source' (for developers): [source:tarball] for downloading a tarball of the octosuite source code. [source:zipball] for downloading a zipball of the octosuite source code.
|
||||
[✓] Will now be installing updates from pypi via 'pip install --upgrade octosuite' (As a result, all update commands have been deprecated)
|
||||
[✓] Properly formatted output in commits search results
|
||||
[✓] Perfomance improvements
|
||||
''')
|
||||
except Exception as e:
|
||||
logging.error(error.format(e))
|
||||
xprint(f"{ERROR} {error.format(e)}")
|
||||
|
||||
13
octosuite/message_prefixes.py
Normal file
@@ -0,0 +1,13 @@
|
||||
from octosuite.config import red, white, green, yellow, reset
|
||||
|
||||
"""
|
||||
message prefixes that show what
|
||||
a notification in OctoSuite might be all about. This might not be very important or necessary in some cases,
|
||||
but I think it's better to know the severity of the notifications you get in a program.
|
||||
"""
|
||||
PROMPT = f"{white}[{green}PROMPT{white}]{reset}"
|
||||
WARNING = f"{white}[{yellow}WARNING{white}]{reset}"
|
||||
ERROR = f"{white}[{red}ERROR{white}]{reset}"
|
||||
POSITIVE = f"{white}[{green}POSITIVE{white}]{reset}"
|
||||
NEGATIVE = f"{white}[{red}NEGATIVE{white}]{reset}"
|
||||
INFO = f"{white}[{green}INFO{white}]{reset}"
|
||||
1103
octosuite/octosuite.py
Normal file
@@ -1,15 +0,0 @@
|
||||
from octosuite.colors import Color
|
||||
|
||||
'''
|
||||
Attributes
|
||||
*Even here, I couldn't think of a good name.*
|
||||
The Attributes class holds the signs/symbols that show what a notification in OctoSuite might be all about.
|
||||
This might not be very important or necessary in some cases, but I think it's better to know the severerity of the notifications you get in a program.
|
||||
'''
|
||||
class SignVar:
|
||||
prompt = f'{Color.white}[{Color.green} ? {Color.white}]{Color.reset}'
|
||||
warning = f'{Color.white}[{Color.red} ! {Color.white}]{Color.reset}'
|
||||
error = f'{Color.white}[{Color.red} x {Color.white}]{Color.reset}'
|
||||
positive = f'{Color.white}[{Color.green} + {Color.white}]{Color.reset}'
|
||||
negative = f'{Color.white}[{Color.red} - {Color.white}]{Color.reset}'
|
||||
info = f'{Color.white}[{Color.green} * {Color.white}]{Color.reset}'
|
||||
10
setup.py
@@ -5,16 +5,16 @@ with open("README.md", "r", encoding="utf-8") as file:
|
||||
|
||||
setuptools.setup(
|
||||
name="octosuite",
|
||||
version="2.1.0",
|
||||
version="3.0.1",
|
||||
author="Richard Mwewa",
|
||||
author_email="richardmwewa@duck.com",
|
||||
author_email="rly0nheart@duck.com",
|
||||
packages=["octosuite"],
|
||||
description="Advanced Github OSINT Framework",
|
||||
long_description=long_description,
|
||||
long_description_content_type="text/markdown",
|
||||
url="https://github.com/rly0nheart/octosuite",
|
||||
url="https://github.com/bellingcat/octosuite",
|
||||
license="GNU General Public License v3 (GPLv3)",
|
||||
install_requires=["requests"],
|
||||
install_requires=["requests", "rich", "psutil", "pyreadline3"],
|
||||
classifiers=[
|
||||
'Development Status :: 5 - Production/Stable',
|
||||
'Intended Audience :: Information Technology',
|
||||
@@ -25,7 +25,7 @@ setuptools.setup(
|
||||
],
|
||||
entry_points={
|
||||
"console_scripts": [
|
||||
"octosuite=octosuite.main:onStart",
|
||||
"octosuite=octosuite.main:octosuite",
|
||||
]
|
||||
},
|
||||
)
|
||||
|
||||