Skip to main content

A GitHub simulation shell with automatic update feature

Project description

GitHub Simulation Shell

A feature-rich GitHub simulation shell that provides a command-line interface for GitHub operations.

Features

Repository Operations

  • repos - List current user's repositories
  • repo <owner>/<repo> - View specified repository information
  • issues <repo> - View repository Issues
  • branches <repo> - View repository branches
  • commits <repo> - View recent repository commits
  • contributors <repo> - View repository contributors
  • prs <repo> - View repository Pull Requests
  • gists <username> - View user's Gists

Search Functionality

  • search <query> - Search GitHub repositories

Organization Operations

  • org <orgname> - View specified organization information

User Operations

  • user <username> - View specified user information
  • followers - View current user's followers
  • following - View current user's following

System Commands

  • help - Display help information
  • clear - Clear the screen
  • exit - Exit the simulation shell
  • update - Check and update to the latest version
  • version - Display current version

Installation

Install from PyPI

pip install github-shell

Install from Source

git clone https://github.com/wjr-2015/wjr-2015-github_shell.git
cd wjr-2015-github_shell
pip install -e .

Usage

Basic Usage

github-shell

Command Examples

# List current user's repositories
github-shell:wjr-2015$ repos

# View specified repository information
github-shell:wjr-2015$ repo octocat/Hello-World

# Search repositories
github-shell:wjr-2015$ search python github

# Check for updates
github-shell:wjr-2015$ update

Configuration

Set GitHub Token

To access private repositories, you can set your GitHub token in the script:

# Set in github_shell/config.py
TOKEN = "your_github_token"

Auto Update

The script includes an auto-update feature. Run the update command to check and update to the latest version.

Version History

  • v1.1.0 - Added contributors view, PR view, Gists view, repository search, organization information view, etc.
  • v1.0.0 - Initial version with basic repository and user operations

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github_shell-1.3.0.tar.gz (37.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

github_shell-1.3.0-py3-none-any.whl (48.9 kB view details)

Uploaded Python 3

File details

Details for the file github_shell-1.3.0.tar.gz.

File metadata

  • Download URL: github_shell-1.3.0.tar.gz
  • Upload date:
  • Size: 37.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for github_shell-1.3.0.tar.gz
Algorithm Hash digest
SHA256 b16c2e21c0b78ae19b8c4cf770a4cc0f8cd657f73ae63c00f01abb6438fb723b
MD5 ee7d2b9d66fdeb06ddaca081dcf3bbff
BLAKE2b-256 b310dc4fbe98b3377d101351c1849fab682db0b4d3a8e8e3a48080c3ba33422a

See more details on using hashes here.

File details

Details for the file github_shell-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: github_shell-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 48.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for github_shell-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 43245ec67b27153d409eaea69c48e861afc1cc2e4d7e6d184c9b94dbea9ab564
MD5 267d53db8b4bb97aa57b1799431fa6b2
BLAKE2b-256 58f14bf66f6779629457f9553050f2db5cb09592e073f509483054ba47e98ae2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page