litesurf

A simple Python CLI tool to create a basic web browser.

Table of Contents

• Installation
  • Create and activate a virtual environment:
• Usage
  • Command Line Usage
• Building Standalone Executables with PyInstaller
  • 1. Install PyInstaller

Installation

• Clone the repository:

  git clone https://github.com/bhatishan2003/litesurf
  cd litesurf
  

Create and activate a virtual environment:

1. Create a Virtual Environment [Optional, but recommended]

   Run the following command to create a virtual environment:

   python3 -m venv .venv
   

• Activate:

  • Windows (PowerShell):

    .venv\Scripts\activate
    

  • Linux/Mac (Bash):

    source .venv/bin/activate
    

• Deactivate:

  deactivate
  

• Install the package:

  pip install .
  

• For development (editable mode):

  pip install -e .
  

Usage

Command Line Usage

• Following commands should be entered to get a pop-up browse.

  ```bash
  litesurf
  litesurf --file test.html
  ```
  

Building Standalone Executables with PyInstaller

You can generate platform-specific standalone executables for your litesurf project using PyInstaller.

1. Install PyInstaller

pip install pyinstaller

• Windows

  pyinstaller --name litesurf --onefile run_litesurf.py
  

• MacOS

  pyinstaller --name litesurf --onefile --windowed run_litesurf.py
  

  • Convert the .app into a .dmg for distribution:

    hdiutil create -volname litesurf -srcfolder dist/litesurf.app -ov -format UDZO litesurf.dmg
    

• Linux

  • You can create a cross-platform source distribution from Windows (or Linux):

    python setup.py sdist
    

  • Linux users can install it via:

    pip install litesurf-0.0.1.tar.gz