diff --git a/README.md b/README.md index 4ff37a1..ccbf4a1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![octosuite](img/octosuite.png) +![octosuite](https://raw.githubusercontent.com/bellingcat/octosuite/refs/heads/master/img/octosuite.png) TUI-based toolkit for GitHub data analysis. @@ -7,6 +7,7 @@ TUI-based toolkit for GitHub data analysis. ![Code Size](https://img.shields.io/github/languages/code-size/bellingcat/octosuite) ![Release Date](https://img.shields.io/github/release-date/bellingcat/octosuite) ![Build Status](https://img.shields.io/github/actions/workflow/status/bellingcat/octosuite/python-publish.yml) +[![CodeQL Advanced](https://github.com/bellingcat/octosuite/actions/workflows/codeql.yml/badge.svg)](https://github.com/bellingcat/octosuite/actions/workflows/codeql.yml) ![License](https://img.shields.io/github/license/bellingcat/octosuite) ## Overview @@ -16,11 +17,56 @@ repositories, organizations, and search across GitHub's platform. ## Features -- **User Data** - View profiles, repositories, followers, organizations, and activity, e.t.c. -- **Repository Data** - Access repository details, commits, issues, releases, and contributors -- **Organisation Data** - Explore organisation profiles, members, and repositories -- **Search** - Search across repositories, users, commits, issues, and topics -- **Export** - Save data in JSON, CSV, or HTML formats +
+See details + +- **User** - Get user data + - Profile + - Repositories + - Subscriptions + - Starred + - Followers + - Following + - Organizations + - Gists + - Events + - Received Events +- **Repository** - Get repository data + - Profile + - Forks + - Issues + - Issue Events + - Events + - Assignees + - Branches + - Tags + - Languages + - Stargazers + - Subscribers + - Commits + - Comments + - Releases + - Deployments + - Labels +- **Organisation** - Get organisation data + - Profile + - Repositories + - Events + - Hooks + - Issues + - Members +- **Search** - Search GitHub + - Repositories + - Users + - Commits + - Issues + - Topics +- **Export** - Export data + - JSON + - CSV + - HTML + +
## Installation @@ -50,17 +96,20 @@ octosuite ``` > [!Note] -> You can run octosuite with commands `octosuite`, or `ocs` +> You can then run octosuite with command `octosuite` ## Usage -Navigate using UPDOWN and ENTER to select options. The interface guides you through +Navigate using UPDOWN and ENTER to select options. In the export menu, you should +use SPACE to check the format you want. + +The interface guides you through selecting a data source and choosing what information to retrieve. Preview the results and optionally export them in your preferred format. -![home](img/menu.png) +![home](https://raw.githubusercontent.com/bellingcat/octosuite/refs/heads/master/img/menu.png) ## License diff --git a/pyproject.toml b/pyproject.toml index 0bb03c1..5bde0b0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "octosuite" -version = "4.0.0-beta" +version = "4.0.0beta1" description = "TUI-based toolkit for GitHub data analysis." readme = "README.md" license = "MIT" @@ -33,5 +33,4 @@ dev = [ ] [project.scripts] -octosuite = "octosuite.app:start" -ocs = "octosuite.app:start" \ No newline at end of file +octosuite = "octosuite.app:start" \ No newline at end of file diff --git a/src/octosuite/__init__.py b/src/octosuite/__init__.py index da6d8df..9bbbd90 100644 --- a/src/octosuite/__init__.py +++ b/src/octosuite/__init__.py @@ -1,2 +1,2 @@ __pkg__ = "octosuite" -__version__ = "4.0.0" +__version__ = "4.0.0beta1"