Package Health Score

51 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Sustainable

Popularity

Small

GitHub Stars: 10.59K
Forks: 872
Contributors: 80

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package howdoi, we found that it has been starred 10,589 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Oct 3, 2022
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
4
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like howdoi is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 16
Open PR: 10
Last Release: 2 years ago
Last Commit: 16 days ago

Further analysis of the maintenance status of howdoi based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for howdoi is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 80
Funding: No

With more than 10 contributors for the howdoi repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like howdoi is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==3.10.*, ==3.6.*, ==3.7.*, ==3.8.*, ==3.9.*

Age: 12 years
Latest Release: 2 years ago
Dependencies: N/A
Versions: 39
Maintainers: 1
Wheels: No

Not sure how to use howdoi?

To help you get started, we've collected the most common ways that howdoi is being used within popular public projects.

gleitz / howdoi / test_howdoi.py View on Github

def call_howdoi(self, query):
        parser = howdoi.get_parser()
        args = vars(parser.parse_args(query.split(' ')))
        return howdoi.howdoi(args)

View more ways to use howdoi

howdoi

Instant coding answers via the command line

⚡ Never open your browser to look for help again ⚡

Introduction to howdoi

Are you a hack programmer? Do you find yourself constantly Googling for how to do basic programming tasks?

Suppose you want to know how to format a date in bash. Why open your browser and read through blogs (risking major distraction) when you can simply stay in the console and ask howdoi:

$ howdoi format date bash
&gt; DATE=`date +%Y-%m-%d`

howdoi will answer all sorts of queries:

$ howdoi print stack trace python
&gt; import traceback
&gt;
&gt; try:
&gt;     1/0
&gt; except:
&gt;     print '&gt;&gt;&gt; traceback &lt;&lt;&lt;'
&gt;     traceback.print_exc()
&gt;     print '&gt;&gt;&gt; end of traceback &lt;&lt;&lt;'
&gt; traceback.print_exc()

$ howdoi convert mp4 to animated gif
&gt; video=/path/to/video.avi
&gt; outdir=/path/to/output.gif
&gt; mplayer "$video" \
&gt;         -ao null \
&gt;         -ss "00:01:00" \  # starting point
&gt;         -endpos 10 \ # duration in second
&gt;         -vo gif89a:fps=13:output=$outdir \
&gt;         -vf scale=240:180

$ howdoi create tar archive
&gt; tar -cf backup.tar --exclude "www/subf3" www

Installation

pip install howdoi

Usage

New to howdoi?

howdoi howdoi

RTFM

Commands

usage: howdoi [-h] [-p POS] [-n NUM] [-a] [-l] [-c] [-x] [-C] [-j] [-v] [-e [ENGINE]]
[--save] [--view] [--remove] [--empty] [QUERY ...]

instant coding answers via the command line

positional arguments:
  QUERY                 the question to answer

optional arguments:
  -h, --help            show this help message and exit
  -p POS, --pos POS     select answer in specified position (default: 1)
  -n NUM, --num NUM     number of answers to return (default: 1)
  -a, --all             display the full text of the answer
  -l, --link            display only the answer link
  -c, --color           enable colorized output
  -x, --explain         explain how answer was chosen
  -C, --clear-cache     clear the cache
  -j, --json            return answers in raw json format
  -v, --version         display the current version of howdoi
  -e [ENGINE], --engine [ENGINE]
                        search engine for this query (google, bing, duckduckgo)
  --save, --stash       stash a howdoi answer
  --view                view your stash
  --remove              remove an entry in your stash
  --empty               empty your stash

environment variable examples:
  HOWDOI_COLORIZE=1
  HOWDOI_DISABLE_CACHE=1
  HOWDOI_DISABLE_SSL=1
  HOWDOI_SEARCH_ENGINE=google
  HOWDOI_URL=serverfault.com

Using the howdoi stashing feature (for more advanced features view the keep documentation).

stashing: howdoi --save QUERY
viewing:  howdoi --view
removing: howdoi --remove (will be prompted which answer to delete)
emptying: howdoi --empty (empties entire stash, will be prompted to confirm)

As a shortcut, if you commonly use the same parameters each time and don't want to type them, add something similar to your .bash_profile (or otherwise). This example gives you 5 colored results each time.

alias h='function hdi(){ howdoi $* -c -n 5; }; hdi'

And then to run it from the command line simply type:

$ h format date bash

You can also search other StackExchange properties for answers:

HOWDOI_URL=cooking.stackexchange.com howdoi make pesto

or as an alias:

alias hcook='function hcook(){ HOWDOI_URL=cooking.stackexchange.com howdoi $* ; }; hcook'
hcook make pesto

Other useful aliases:

alias hless='function hdi(){ howdoi $* -c | less --raw-control-chars --quit-if-one-screen --no-init; }; hdi'

Contributors

Benjamin Gleitzman (@gleitz)
Yanlam Ko (@YKo20010)
Diana Arreola (@diarreola)
Eyitayo Ogunbiyi (@tayoogunbiyi)
Chris Nguyen (@chrisngyn)
Shageldi Ovezov (@ovezovs)
Mwiza Simbeye (@mwizasimbeye11)
Shantanu Verma (@SaurusXI)
Sheza Munir (@ShezaMunir)
Jyoti Bisht (@joeyouss)
And more!

How to contribute

We welcome contributions that make howdoi better and improve the existing functionalities of the project. We have created a separate guide to contributing to howdoi that explains how to get up and running with your first pull request.

Notes

Works with Python 3.5 and newer. Unfortunately Python 2.7 support has been discontinued 😦
There is a GUI that wraps howdoi
There is a Flask webapp that wraps howdoi
An Alfred Workflow for howdoi
Slack integration available through slack-howdoi
Telegram integration available through howdoi-telegram
Special thanks to Rich Jones (@miserlou) for the idea
More thanks to Ben Bronstein for the logo

Visual Studio Code Extension Installation

Head over to the MarketPlace to install the extension.

News

2.0.20

Update dependency versions
Add support for Python 3.10

2.0.19

Fix typo

2.0.18

Fixed issue with howdoi cache where cache misses would be printed to the console

2.0.17

New documentation and mkdocs
Fixed issue with how howdoi chooses the proper search engine (command line flags now override environment variables)
Added a search engine fallback if one of the search engines fails
Fixed issue with howdoi cache

2.0.16

Fix GDPR issue for those using howdoi in countries outside the US
Better support for using HOWDOI_URL

2.0.15

Add explainability with -x or --explain options
Better error checking for when search engines block queries
Using improved DuckDuckGo endpoint
Answer pages now fetched in parallel for speed improvement

2.0.14

Fix a number of bugs by switching from parsing Google links to looking for URLs instead

2.0.13

More permanent fix for extracting Google links

2.0.12

Hotfix for Google link formatting

2.0.11

Hotfix for Google link formatting

2.0.10

Hotfix for new Google classnames
Separate requirements.txt files for prod and dev

2.0.9

Cleaner command line options that also include environment variables
README updates

2.0.8

Fix issue for answers that have no code in the answer but code in the comments
Add range checks for -n and -p flags
Moved from Travis to Github Actions
Dropped Python 2.7 support

2.0.7

Update for new Google CSS style

2.0.6

Fix issue where -a would not return a proper response due to updated CSS on StackOverflow

2.0.5

New logo and colors!

2.0.4

Cachelib rollback to support Python 2.7
Better error message when Google is being blocked (for example in China)

2.0.3

Bring back Python 2.7 support (for now)

2.0.2

Fixed keep support for stashing and viewing answers

2.0.1

Added JSON output with the -j flag (great for consuming howdoi results for use in other apps)
Added stashing ability for saving useful answer for later (based on https://github.com/OrkoHunter/keep)
Added caching for tests to prevent being rate limited by Google while developing
Added easier method for calling howdoi when imported (howdoi.howdoi)

1.2.1

Fix dependency issue

1.2.0

Massive speed improvements of startup, answer fetching, and caching
Command line flags for alternate search engines
Remove duplicate answers

1.1.14

Links displayed with markdown syntax
Improved performance and caching (again)

1.1.13

Improved performance and caching
More friendly answer display
Added support for Python 3.6
Removed support for Python 2.6

1.1.12

Add additional search engine support

1.1.11

Fix issue with UTF-8 encoding

1.1.10

Include the link in output when asking for >1 answer
Compatibility with linuxbrew

1.1.9

Fix issue with upload to PyPI

1.1.8

Fix colorization when HOWDOI_COLORIZE env variable is enabled
Fix certificate validation when SSL disabled

1.1.7

Add Localization support with HOWDOI_LOCALIZATION env variable (Currently only pt-br and en)

1.1.6

Updates for Python3
Updates for caching

1.1.5

Updates for Python3
Fix issues with cache
Allow disabling SSL when accessing Google

1.1.4

Added caching

1.1.3

Added fix to handle change in Google search page HTML
Updated Travis CI tests

1.1.2

Compatibility fixes for Python3.2
Travis CI tests now being run for Python 2.6, 2.7, 3.2, and 3.3

1.1.1

Added message when question has no answer

1.1

Added multiple answers with -n/--num-answers flag
Added colorized output with -c/--color flag
Added answer link to the bottom of questions with -a/--all flag
Unit tests now managed through Travis CI

1.0

Added support for Python3
Switched to the requests library instead of urllib2
Project status changed to Production/Stable
Added troubleshooting steps to the README

0.2

Added sane flags
Now using /usr/bin/env python instead of /usr/bin/python
Updated README for brew installation instructions

0.1.2

Added Windows executable
Updated README for pip installation instructions

0.1.1

Added to PyPI

0.1

We're doing it live!

FAQs

What is howdoi?

Instant coding answers via the command line. Visit Snyk Advisor to see a full health score report for howdoi, including popularity, security, maintenance & community analysis.

Is howdoi popular?

The python package howdoi receives a total of 592 weekly downloads. As such, howdoi popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is howdoi well maintained?

We found indications that howdoi is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is howdoi safe to use?

While scanning the latest version of howdoi, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 5 November-2024, at 19:59 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP