CLI utility for detecting weak spots in GitHub profiles
Project description
GitHub profile checker
CLI utility written in Python for detecting weak spots in GitHub profiles
Installation
Since the CLI is written in Python you will have to first install python itself and then run
python -m pip install gpc-cli
After the installation you should have a gpc
namespace available in your currently running user.
Usage
This CLI implies 3 main types of commands:
Authorization
To be able to fully scan your GitHub account, make sure to authorize through GitHub OAuth using
gpc login
Profiles
You can also locally save and remove GitHub profiles you are willing to scan.
Use
gpc profile add <username>
to locally save a profile. You can also remove, list all and remove all profiles. Use
gpc profile --help
to further explore this.
Analysis
The analyzation command itself, that scans through the given profile and creates a summary that is stored in user's home directory in the gpc-data folder. To create this summary, run
gpc analyze <username>
NOTE: You can omit the username argument if you are already authorized and want to deep-analyze your own profile.
You can also use this command with the --fl
flag to generate summaries for all the locally saved profiles.
Motivation
The CLI was created with a purpose of helping developers on GitHub to clean up their possibly 'messy' profiles and organize
their projects.
If you are applying for any IT related job, make sure to tidy your profile and this CLI will make it a way easier and
pleasant process.
P.S.
the CLI initializer word gpc
is just an abbreviation for
github-profile-checker
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.