Skip to content

Releases: DaDevMikey/Wikipedia-Command-Line-Interface

1.0.0 (HotFix 1)

09 Feb 11:15
f515f96
Compare
Choose a tag to compare

Release Notes - Installer Fix Attempt

We've made some changes to the installer (attached) and related files in an attempt to resolve previous issues. This release focuses specifically on addressing installer functionality.

What's Changed?

This update includes modifications to the installer and supporting files to improve stability and reliability. We've targeted CLI errors that python gave whenever you started via CMD or via the homescreen shortcut, and attempted to fix the python not installed when installed bug (not functioning fully yet).

Next Steps & Feedback Requested

We need your help! We're eager to hear about your experience with this updated installer. Please test it out and let us know if you encounter any problems or if the issues you were experiencing have been resolved.

Your feedback is crucial for further improvements. Please share your thoughts, bug reports, and suggestions by creating an issue on GitHub: https://github.com/DaDevMikey/Wikipedia-Command-Line-Interface/issues

We appreciate your contributions!

1.0.0

07 Feb 21:30
237a65c
Compare
Choose a tag to compare
Before you install with the attached executable

The attached installer is a test version. It may incorrectly report that Python is not installed, even if it is. If you encounter this issue, simply choose "No" or "Continue Anyways" to proceed with the installation. We are working to resolve this in future releases. It's still recommended to install the software trough the commands provided bellow and in the readme, since the installer currently contains isseus that will make the software install incorrectly right now

Wiki-CLI Release Notes - Version 1.0.0

We are thrilled to announce the initial release of Wiki-CLI, a command-line interface that brings the power of Wikipedia to your terminal! This version marks a significant milestone, offering a robust and user-friendly experience for searching, reading, and even visualizing Wikipedia content.

Key Features

  • Search: Easily search Wikipedia articles using keywords.
  • Read: View full articles directly within your terminal.
  • ASCII Art Images: Experience a unique way to view article images converted to ASCII art.
  • External Links: Browse and explore external links referenced in articles.
  • Command History: Navigate and reuse previous commands for efficient interaction.
  • Tab Completion: Enjoy seamless command completion for a smoother workflow.
  • Global Installation: Use the wiki command from anywhere in your system.

Installation Instructions

  1. Clone the Repository:

    git clone [https://github.com/DaDevMikey/Wikipedia-Command-Line-Interface/.git](https://github.com/DaDevMikey/Wikipedia-Command-Line-Interface/.git)
    cd wiki-cli
  2. Virtual Environment (Recommended):

    # Windows
    python -m venv .venv
    .venv\Scripts\activate
    
    # Linux/macOS
    python3 -m venv .venv
    source .venv/bin/activate
  3. Install the Package:

    pip install .  # For global installation (recommended)
    # OR
    pip install -e . # For editable install (if you plan to develop on the cli)
  4. Global Installation (Windows):

    • Ensure your Python Scripts directory is in your system PATH. This is typically:
      • System Python: C:\Users\<username>\AppData\Local\Programs\Python\Python3x\Scripts
      • Virtual Environment: C:\Users\<username>\Downloads\Wikipedia Command Line Interface\.venv\Scripts
    • To add to PATH:
      1. Open System Properties (Win + Pause/Break)
      2. Advanced system settings -> Environment Variables -> System Variables -> Path -> Edit -> New -> Add the path.
    • Open a new command prompt for changes to take effect.
  5. Global Installation (Linux/macOS):
    The wiki command should be automatically available after installation. If not, use which wiki to verify the installation path.

  6. Verify Installation:

    wiki --help

Usage

Run the CLI with:

wiki

Available Commands

  • search <query>: Search Wikipedia articles.
  • view <title>: View a specific article.
  • <number>: View article from search results.
  • images: List images in the current article.
  • image <number>: View ASCII art of an image.
  • links: Show external links for the current article.
  • clear: Clear the screen.
  • help: Show help message.
  • exit: Exit the application.

Examples

wiki> search Python programming
wiki> view Python (programming language)
wiki> images
wiki> image 1
wiki> links
wiki> help

Requirements

  • Python 3.7+
  • Packages (automatically installed): requests, aiohttp, pillow, rich, prompt_toolkit, click, python-dotenv

License

MIT

Contributing

Contributions are welcome! Please see the repository for guidelines.

Full Changelog: https://github.com/DaDevMikey/Wikipedia-Command-Line-Interface/commits/1.0.0