Skip to main content

A lightweight CLI tool to get quick information about any topic using DuckDuckGo search

Project description

whatiz 🔍

A lightweight CLI tool to get quick information about any topic right from your terminal using DuckDuckGo search.

Features

Lightning-fast information retrieval - Get answers in one line
Uses DuckDuckGo - No ads, no tracking (respects privacy)

Installation

Using pip (Recommended)

pip install whatiz

The whatiz command will be automatically added to your PATH!

Using pipx (For isolated environments)

pipx install whatiz

Usage

Get quick information about anything:

whatiz python
whatiz climate change
whatiz quantum computing
whatiz "machine learning"

Examples

$ whatiz blockchain
Blockchain is a distributed ledger technology that underlies cryptocurrencies like Bitcoin...

$ whatiz photosynthesis
Photosynthesis is the process by which plants convert light energy into chemical energy...

$ whatiz "dark matter"
Dark matter is a form of matter composed of particles that neither emit nor absorb light...

How It Works

  1. Takes your query from the command line
  2. Searches using DuckDuckGo API (via ddgs library)
  3. Returns the first result as a one-line summary
  4. Displays it in your terminal

Requirements

  • Python 3.8+
  • Internet connection (for search)

Development

Clone and setup

git clone https://github.com/yourusername/whatiz.git
cd whatiz
pip install -e ".[dev]"

Install from source

pip install .

Dependencies

  • ddgs - DuckDuckGo search
  • requests - HTTP library
  • beautifulsoup4 - HTML parsing
  • sumy - Text summarization
  • nltk - Natural language processing
  • numpy - Numerical computing

Troubleshooting

Command not found after installation?

# Try this
python -m whatiz.main "your query"

# Or reinstall
pip install --force-reinstall whatiz

Connection errors?

  • Check your internet connection
  • DuckDuckGo servers might be temporarily down

License

MIT License - see LICENSE file for details

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Author

Your Name - GitHub Profile


Made with ❤️ for the terminal enthusiasts

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

whatiz-0.1.0.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

whatiz-0.1.0-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file whatiz-0.1.0.tar.gz.

File metadata

  • Download URL: whatiz-0.1.0.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for whatiz-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a27df52ef0efeef6b3527256c007dee7c53e32ce77f34f376bb0f70614c22d77
MD5 bb88bf26093ecbaa7748728e4919b44a
BLAKE2b-256 e38e323d2ff0e0b3d3c729c9527ac9744a0f2419c70d277b417cdbce942345de

See more details on using hashes here.

Provenance

The following attestation bundles were made for whatiz-0.1.0.tar.gz:

Publisher: publish.yml on shivam-salkar/whatiz

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file whatiz-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: whatiz-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for whatiz-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6c605396a55fce87d559897d14b7d0d942832de4f79cba8d785ce7579f8b9657
MD5 87a91a0eaba367a4e1083480b6c9d5fd
BLAKE2b-256 45b9f633eac61ab1854b090323766b101c968e00d338bbb42547239d2deaec76

See more details on using hashes here.

Provenance

The following attestation bundles were made for whatiz-0.1.0-py3-none-any.whl:

Publisher: publish.yml on shivam-salkar/whatiz

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page