Data

Tools

Indexes

Applications

Experiments

Open Source Science

HelpMe Command Line Helper Utility

HelpMe Command Line Helper Utility - Published in JOSS (2018)

https://github.com/vsoch/helpme

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: joss.theoj.org
  • ✓
    Committers with academic emails
    1 of 3 committers (33.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (20.4%) to scientific vocabulary

Keywords

command-line containers docker github helper research-tool singularity uservoice
Last synced: 4 months ago · JSON representation ·

Repository

command line daemon for helping you out

Basic Info
Statistics
  • Stars: 9
  • Watchers: 4
  • Forks: 1
  • Open Issues: 5
  • Releases: 2
Topics
command-line containers docker github helper research-tool singularity uservoice
Created about 9 years ago · Last pushed over 4 years ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

HelpMe

A command line helper when you need it.

DOI GitHub actions status

Overview

HelpMe is a general tool that can support the addition of helpers, or different modules that have a set of metadata to collect for the user, and based on an internal configuration file to define these metadata, and (if needed) an external config file for user variables, we send help requests to the various helpers. For example:

  • helpme github posts an issue on a Github board
  • helpme uservoice creates a ticket on uservoice
  • helpme discourse creates a post on a discourse board

Please post issues with questions, feedback, or just to say hello, and see our complete documentation here.

Background

Asking for help is a standard need for research software users, and needing to perform this function from a command line is common given the headless environments provided on shared cluster resources. While interactive web interfaces are the main avenue to submit help tickets and issues to get help, they are many steps away from the original command line where the issue arose, meaning that the user must interrupt a workflow, navigate to another program, and perform several clicks before needing to try to manually capture the problem at hand. At best, the user might copy an error message and the support staff then needs to ask or use internal resources to collect more information. This reality is not ideal because the user often presents a limited summary of the issue, and valuable information about the system, environment, or even a recording of the actual issue are lost. Extra time is spent on further communication and effort to obtain this information. HelpMe resolves these issues by recording information about the issue directly from the source, and allowing users to ask for help without leaving the working environment.

HelpMe is a free to use, open source command line tool that serves one purpose: to connect a user on a command line to a a resource to get help. The software provides a general framework for developers to add "helpers," or different support endpoints to work with "recorders," each a specific way of capturing information like messages, terminal recordings (asciinema), and environment, to easily submit to the endpoint. Importantly, the complex interaction of various application programming interfaces (APIs) with the user's terminal is presented in a simple and intuitive way that puts the user in control of the interaction. By default, the software comes ready to use for interaction with Github and the UserVoice ticketing softwarecommonly used in Research Computing. The HelpMe documentation base is rendered from the same repository and open for contribution. It provides ample detail for developers to add new helpers, recorders, and for users to install the software.

Installation

Local

bash pip install helpme[all] pip install helpme[github] pip install helpme[uservoice]

Docker

Current images are provided on quay.io at vanessa/helpme. Older versions can be found on Docker hub.

You can use the image built on Docker Hub directory

bash $ docker run -it --entrypoint bash quay.io/vanessa/helpme

or you can build it from this repository!

bash $ docker build -t quay.io/vanessa/helpme .

Usage

```bash

Post an issue to a Github Repo.

$ helpme github vsoch/helpme

Post a question to a discourse board

$ helpme discourse

Post a ticket to UserVoice

$ helpme uservoice ```

This is a very brief summary of usage. For complete details, see our documentation.

Contributing

If you'd like to contribute, we welcome pull requests, feature requests, and any form of help you might offer! Please see our contributing guidelines for more details. Do you have a question, or did you find a bug? You can submit an issue and we will help you out.

Examples

  • rseng-support an example issue submission system with helpme and GitHub

License

This code is licensed under the Mozilla version 2.0 LICENSE.

Owner

  • Name: Vanessasaurus
  • Login: vsoch
  • Kind: user

I'm the Vanessasaurus!

Citation (CITATION.cff) 

cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Sochat
    given-names: Vanessa
    orcid: https://orcid.org/0000-0002-4387-3819
title: "HelpMe Command Line Helper Utility"
version: 0.0.43
doi: 10.21105/joss.00775
date-released: 2018-06-20

GitHub Events

Total
Last Year

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 115
  • Total Committers: 3
  • Avg Commits per committer: 38.333
  • Development Distribution Score (DDS): 0.017
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Vanessa Sochat v****t@s****u 113
Radovan Bast b****t 1
A. Karl Kornel k****l@k****s 1
Committer Domains (Top 20 + Academic)
kornel.us: 1 stanford.edu: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 39
  • Total pull requests: 19
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 3 days
  • Total issue authors: 5
  • Total pull request authors: 2
  • Average comments per issue: 1.82
  • Average comments per pull request: 0.37
  • Merged pull requests: 19
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • vsoch (28)
  • iljah (6)
  • pdurbin (2)
  • rougier (2)
  • yarikoptic (1)
Pull Request Authors
  • vsoch (18)
  • bast (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
conda-forge.org: helpme
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Average: 48.4%
Stargazers count: 50.9%
Dependent packages count: 51.2%
Forks count: 57.4%
Last synced: 4 months ago

Dependencies

requirements.txt pypi
  • requests *
docs/Gemfile rubygems
  • github-pages = 193 development
  • faraday = 0.15.4
  • jekyll-paginate >= 0