A command line program that will output helpful reminders based on parameters
Project description
Eh
Eh is a tool to give quick help on a particular subject
The source code can be found at:
https://github.com/roaet/eh
Installing
Install with pip install eh. You may want to use sudo if you want it
available everywhere.
With some versions of linux it will install it into ~/.local/bin when you
do not use sudo. Ensure that this directory is in your PATH if you want to
run eh.
Eh Configuration File
The Eh configuration file is located at ~/.eh/eh.ini. This location cannot be changed.
Selected topics
You can select topics from a store, at the cost of removing the unselected
topics, by adding a section in the configuration with the name of the store.
In this configuration section you need to add an attribute called topics and
then add the keys of the topics you wish to keep in a comma-separated list.
An example configuration follows:
[topic_stores]
eh_default = https://github.com/roaet/eh_subjects
[eh_default]
topics = eh/about,eh/future,eh/help
In the above example the name of the store is eh_default, as seen in the
topic_stores section. This name should be used in the selected topic section
and then keys added there as shown.
Making an eh topic
You can make a new eh topic by:
- contributing to the subject repo at
https://github.com/roaet/eh_subjects - creating your own repo and including it in your eh.ini
Creating a new subject repo
When you add it to your eh.ini you must provide the entire URI. The value on
the left-hand side of the = does not matter as long as it is unique to your
configuration file.
Auto Complete
(shoutout to https://github.com/CarvellScott/completion_utils for the help)
After installing you can add eh bash completion by running: complete -C eh_autocomplete eh
Future features
- Config from home for color options
- Adding support for
https://github.com/rstacruz/cheatsheetsformat
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.
Source Distribution
File details
Details for the file eh-1.3.5.tar.gz.
File metadata
- Download URL: eh-1.3.5.tar.gz
- Upload date:
- Size: 23.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 55a0a68d2d6cfad0b349c0b81df9442408bddf1afcc193e11055b491f095a605 |
|
| MD5 | e6eba9bbcc924aa546041a7e93ca1021 |
|
| BLAKE2b-256 | 5eaf9d41d381fbcc7cddba9acc233f5277eeae8737080938cbe631ef8e9bfdf6 |
