Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rprouse/guppi
A command line utility to start my day with the info I need.
https://github.com/rprouse/guppi
assistant dotnet dotnet-tool hacktoberfest nuget personal-assistant
Last synced: 7 days ago
JSON representation
A command line utility to start my day with the info I need.
- Host: GitHub
- URL: https://github.com/rprouse/guppi
- Owner: rprouse
- License: mit
- Created: 2020-04-09T13:38:21.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T20:23:03.000Z (11 days ago)
- Last Synced: 2024-10-28T04:26:37.970Z (11 days ago)
- Topics: assistant, dotnet, dotnet-tool, hacktoberfest, nuget, personal-assistant
- Language: C#
- Homepage:
- Size: 806 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GUPPI
GUPPI (or General Unit Primary Peripheral Interface) Is a semi-sentient software
being that helps Replicants interact with the many systems they have at their
disposal. This is an early implementation of the interface and as this is not
the year 2133 in the fictional [Bobverse](https://bobiverse.fandom.com/wiki/We_Are_Legion_(We_Are_Bob)_Wiki),
GUPPI is not actually semi-sentient and is only a command line utility to provide
me with the information I need.
## Skills
### Advent of Code
Views the AoC leaderboard, adds a new day to my AoC Visual Studio solution and runs the tests.
To configure:
1. Log in to [Advent of Code](https://adventofcode.com/)
2. Go to the private leaderboard, click on API and view the JSON for the board
3. Take the leaderboard number from the JSON filename
4. In the browser dev tools, copy the session cookie minus the `session=`
5. Set the `src` directory for the Visual Studio AoC solution
### Bills
Downloads the last years worth of bills from Alectra and Enbridge. The account numbers for each utility
are hard coded at the moment.
You will need to install [Playwright](https://playwright.dev/dotnet/) to use this skill. To install, run
```sh
guppi bills install
```
### Sync Todo.txt to Google Tasks
Syncs the [Todo.txt](https://github.com/rprouse/dotnet-todo) tasks to/from Google Tasks.
To get the information to configure, follow the instructions at:
1. [Enable the Google Tasks API](https://developers.google.com/tasks/reference/rest)
2. Configure the API as a Desktop App
3. Download client configuration and save to `C:\Users\rob\AppData\Local\Guppi\task_credentials.json`
4. Run and log in using OAuth2.
To check your API information, see the [API Console](https://console.developers.google.com/).
### Calendar
Displays your next calendar event or today's agenda from Google Calendar and Office 365. Right
now it gets both and both must be configured.
#### Google Calendar
To get the information to configure, follow the instructions at:
1. [Enable the Google Calendar API](https://developers.google.com/calendar/quickstart/dotnet)
2. Configure the API as a Desktop App
3. Download client configuration and save to `C:\Users\rob\AppData\Local\Guppi\calendar_credentials.json`
4. Run and log in using OAuth2.
To check your API information, see the [API Console](https://console.developers.google.com/).
### Dictionary and Thesaurus
Displays the definition of a word or the synonyms of a word. You must supply a
dictionary and thesaurus API key from [Merriam-Webster](https://dictionaryapi.com/).
### Git
Useful git aliases like `ammend`, `undo`, `unstage` and `update` which switches to the
master branch, does a fetch and a pull.
### Hue Lights
Control Philip's Hue lights. On first run, it will search for and connect to the first Hue Bridge
it finds. If there are more than one bridge, list the bridges and register using the IP.
You can have one default light which is set using the configure command.
### IP Address
Displays your local and public IP addresses.
### Notes
I keep all of my notes as Markdown files. I used to use VS Code, but recently switched to
[Obsidian](https://obsidian.md/) for better linking and formatting. This opens my notes
in Obsidian, adds new notes and optionally opens the notes directory in VS Code.
### OpenAI
Adds some true intelligence to Guppi. Allows you to chat with Guppi using the OpenAI API.
### RC2014
Allows you to interact with a [RC2014](https://rc2014.co.uk/) computer. `Convert` converts
a binary file to Intel Hex format. Upload it to the RC2014 using Grante Searle's `DOWNLOAD.COM`.
### Serial Ports Skill
Lists the available serial ports and allows you to send data to them.
### Strava
Displays Strava fitness activities.
1. Get the [client id and secret](https://www.strava.com/settings/api) for the api.
### Utilities
Displays the date, the time or creates a new Guid.
### Voice
On Windows, you can list the installed voices and set the default voice. To install additional
voices,
1. Click on the Start button (the Windows icon) at the bottom left corner of your screen.
2. Click on the "Settings" (gear icon) to open the Settings app.
3. In the Settings app, click on "Time & language" in the left-hand menu.
4. Click on "Speech" in the left-hand submenu under "Time & language."
5. On the right side, click on "Speech"
6. Click "Add voices"
### Weather
Displays today's weather information.
To get the information to configure;
1. Sign up to [OpenWeatherMap](https://openweathermap.org/) and get an API Key.
2. Use [Google Maps](https://google.ca/maps) to get your Latitude and Longitude.
3. Once you've configured an initial location, you can use the `--location` option to find the weather for additional locations and to use their latitude and longitude for the configuration.
## Installation
This program is a [dotnet tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools) and requires the latest version of
the [.NET SDK](https://dotnet.microsoft.com/download) to be installed. .NET 5.0 or newer is recommended.
### Testing Locally
Build it, then package it using the **Pack** command in Visual Studio or `dotnet pack`
on the command line. Until this package is published, install it using the following
command line from the solution root;
```sh
dotnet tool install -g --add-source ./Guppi.Console/nupkg dotnet-guppi
```
To update from a previous version,
```sh
dotnet tool update -g --add-source ./Guppi.Console/nupkg dotnet-guppi
```
### Installing from GitHub Packages
Whenever the version is updated in `Guppi/Guppi.csproj`, a merge to master will publish the NuGet package
to [GitHub Packages](https://github.com/rprouse?tab=packages). You can install or update from there.
First you must update your global NuGet configuration to add the package registry and include the GitHub Personal
Access Token (PAT). This file is in `%appdata%\NuGet\NuGet.Config` on Windows and in `~/.config/NuGet/NuGet.Config`
or `~/.nuget/NuGet/NuGet.Config` on Linux/Mac.
```xml
```
Once that is done, to install,
```sh
dotnet tool install -g dotnet-guppi
```
And to update from a previous version,
```sh
dotnet tool update -g dotnet-guppi
```
## Enabling Tab Completion
This program supports tab completion using `dotnet-suggest`. To enable, for each shell
you must install the `dotnet-suggest` global tool and adding a shim to your profile. This
only needs to be done once and work for all applications built using `System.CommandLine`.
Follow the [setup instructions](https://github.com/dotnet/command-line-api/blob/main/docs/dotnet-suggest.md)
for your shell.