Skip to content

giovannicoppola/alfred-hubHub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

alfred-hubHub 🖥️

A customizable Alfred 5 hub for your GitHub repositories

Downloads

Motivation ✅

  • Quickly check the status of your Github repositories (downloads, issues, forks, etc)
  • Save download data over time to generate plots

Setting up ⚙️

  • Alfred 5 with Powerpack license
  • Python3 (howto here)
  • a GitHub account
  • a GitHub API token (Instructions on how to obtain one are here
  • Optional: matplotlib and pandas libraries (python3 -m pip install -U matplotlib and python3 -m pip install -U pandas) are needed to get download charts.

Default settings

  • In Alfred, open the 'Configure Workflow' menu in alfred-hubHub preferences
    • set GitHub username and token (required)
    • select the relevant checkbox, if you want to show:
      • Downloads ⬇️ (across all versions)
      • Issues 🚨
      • Stars ⭐
      • Forks 🌿
      • Watchers 👀
    • Optional: Change the database refresh frequency in days (default: 1 day)
    • Optional: Change the location of the database (default: workflow cache folder)
    • Optional: Change the Quicklook behavior (Repo main page, Repo Issues, Downloads chart). Default: download charts, or repo main page if charts disables. When sorted by issues (--i tag) Quicklook and Enter go to repo issues page.
    • Optional: Disable chart generation
    • Optional: Set to show only changed items upon launching (--a to override)
    • Optional: Change workflow keywords

Basic Usage 📖

  • launch with keyword (default: hubhub), or custom hotkey
  • use the tag --i to sort by number of issues
  • --c will only show changed repositories from previous save
  • enter ↩️ will open the repository on github.com/, unless the --i tag is used, in which case it open repo issues
  • shift ⇧ will show a preview based on user's preferences (default: download charts, or repo page if no charts)
  • every time you use the workflow, the counts are stored in a JSON file, which can then be used to create plots of downloads

Refreshing the database 🔄

  • database will refresh as indicated by the UPDATE_DAYS variable.
  • launch hubhub:refresh to force database refresh

Limitations & known issues ⚠️

  • None for now, but I have not done extensive testing, let me know if you see anything!
  • It looks like GitHub counts together issues and pull requests?
  • tested with Python 3.9.13

Acknowledgments 😀

Changelog 🧰

  • 09-28-2023: version 0.9.6, fixed watchers count again (API change?)
  • 09-09-2023: version 0.9.5, fixed watchers count, matplotlib style
  • 08-07-2023: version 0.9.4, added option to show changed items only upon opening (--a to override), hidden issues with 0 counts for --i tag
  • 06-11-2023: version 0.9.3, added --c tag to show changed repositories only
  • 12-03-2022: version 0.9

Feedback 🧐

Feedback welcome! If you notice a bug, or have ideas for new features, please feel free to get in touch either here, or on the Alfred forum.