README.md

BitBar-Plugins-Custom

Collection of BitBar plugins I wrote myself or tweaked to my liking.

Report Bug · Request Feature

Table of Contents

• About The Project
  • Plugins I am currently using
  • Plugins I wrote
    • Yahoo Stock Ticker
    • Social Media Stats
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Acknowledgements

About The Project

This repo contains scripts, programs and command-line tools that add functionality to BitBar.

Plugins I am currently using

• Yahoo Stock Ticker
• Clipboard History
• Countdown Timer 2
• Colorful Battery Indicator
  • Added the remaining time to show in the menu bar, when the battery is discharging
• Yahoo Weather
  • Simplified to only show the temperature in the menu bar
  • Added weather forecast for the next days in the dropdown view

• Clock with calendar
  • Tweaked the format of the date displayed in the menu bar

Plugins I wrote

Yahoo Stock Ticker

Dependencies: Python3 (there is also a version of this in Bash, but without the price alarm functionality)

• Pulls stock information from the Yahoo Finance API v7
• Shows major stock indices in the menu bar
• Shows stock symbols in the dropdown menu with additional information in the submenus
• Orders stock symbols by user configuration (alphabetically, market change by value ascending or descending or by absolute value)

• Able to set price alarms for BUY or SELL limits for each stock in the watchlist
• Notifies you if current stock price is lower than your set BUY limit
• Notifies you if current stock price is greater than your set SELL limit
• Remove one of your price limits by clicking on it
• Clear all price limits

Social Media Stats

Dependencies: Python3, beautifulsoup4, requests

• Shows YouTube subscribers, Facebook likes, Instagram and Twitter followers.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• BitBar

# Install via brew on macOS
brew cask install bitbar

Or download .app file directly: Get the latest version of BitBar. Then copy it to your Applications folder.

Installation

1: Fork the repository (using the Fork button at the top)

2: Clone the repository

# Replace {YOUR_USERNAME} with your actual username
git clone https://github.com/{YOUR_USERNAME}/bitbar-plugins-custom.git

3: Change directory to bitbar-plugins-custom

cd bitbar-plugins-custom

4: Install python requirements

pip3 install -r requirements.txt

Usage

Run BitBar.app - it will ask you to select a plugins folder, choose the bitbar-plugins-custom/plugins folder

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

• BitBar
• BitBar Plugins