adding setup and html docs

Author: nathfavour

Diff for: README.md

@@ -29,3 +29,10 @@ N.B: I am constantly working to make this better, and your suggestions are inval
 - [ ] create pip package
 - [ ] add other ebook formats like epub, etc
 - [ ] optimise code/ reduce processing time
+
+
+## EDIT
+
+1. You can optionally run 'setup.sh' if you're on MacOs or linux.
+2. If you're on windows, you can also run 'setup.ps1'
+3. The aim of these setup scripts is to ease the complexity of setting up bionicpython.

Diff for: bionicpython/bionicpython.py

@@ -43,6 +43,10 @@ def process_document(doc_path, ratio):
         try:
             # Run the conversion script as a subprocess
             subprocess.run([sys.executable, 'converter.py', '--pdf', doc_path, '--docx', docx_path])
+
+            # Modify this command to run in the absolute path (with relation to this script) to converter.py
+            subprocess.run([sys.executable, 'converter.py', '--pdf', doc_path, '--docx', docx_path])
+            
             # Replace '.pdf' with '.docx' in the file path
             doc_path = docx_path
         except subprocess.CalledProcessError as e:

Diff for: docs/index.html

@@ -0,0 +1,70 @@
+# Check if a command exists
+function Test-CommandExists {
+    param (
+        [string]$Command
+    )
+    $exists = $null -ne (Get-Command $Command -ErrorAction SilentlyContinue)
+    return $exists
+}
+
+# Install Python on Windows
+function Install-PythonWindows {
+    Write-Host "Attempting to install Python 3.11..."
+    # Python installation on Windows should be done manually or through an installer
+    Write-Host "Please install Python 3.11 manually from the official website."
+    exit
+}
+
+# 1. Check if Python is installed
+if (-not (Test-CommandExists "python") -and -not (Test-CommandExists "python3")) {
+    Write-Host "Python is not installed. Attempting to install..."
+    Install-PythonWindows
+    # Recheck if Python is installed
+    if (-not (Test-CommandExists "python") -and -not (Test-CommandExists "python3")) {
+        Write-Host "Python installation failed. Please install Python manually."
+        exit
+    }
+} else {
+    Write-Host "Python is already installed."
+}
+
+# 2. Check if Flutter is installed
+if (-not (Test-CommandExists "flutter")) {
+    Write-Host "Warning: If you want to build the GUI, you might need Flutter (optionally)."
+}
+
+# 3. Install requirements using pip
+try {
+    pip install -r requirements.txt -ErrorAction Stop
+} catch {
+    try {
+        pip3 install -r requirements.txt -ErrorAction Stop
+    } catch {
+        Write-Host "Failed to install requirements with pip and pip3. Attempting to install pip..."
+        python -m ensurepip
+        if ($LASTEXITCODE -ne 0) {
+            python3 -m ensurepip
+        }
+        if ($LASTEXITCODE -ne 0) {
+            Write-Host "Failed to install pip. Please reinstall Python manually."
+            exit
+        }
+        pip install -r requirements.txt
+    }
+}
+
+# 4. Download spacy model
+try {
+    python -m spacy download en_core_web_sm -ErrorAction Stop
+} catch {
+    python3 -m spacy download en_core_web_sm
+    if ($LASTEXITCODE -ne 0) {
+        Write-Host "Failed to download spacy model. Please check your Python installation."
+        exit
+    }
+}
+
+# 5. Inform the user about the next steps
+Write-Host "To use the CLI, run the following command from the current directory:"
+Write-Host "python bionicpython/bionicpython.py '<path to your pdf/docx file>'"
+Write-Host "Remember to insert the path in quotes if it isn't already."

Diff for: setup.ps1

@@ -0,0 +1,73 @@
+#!/bin/bash
+
+# Function to check if command exists
+command_exists() {
+  command -v "$1" >/dev/null 2>&1
+}
+
+# Function to install Python on macOS
+install_python_macos() {
+  echo "Installing Python 3.11 using Homebrew..."
+  brew install [email protected]
+}
+
+# Function to install Python on Linux
+install_python_linux() {
+  echo "Installing Python 3.11 using apt..."
+  sudo apt update
+  sudo apt install python3.11 -y
+}
+
+# 1. Check if Python is installed
+if ! command_exists python && ! command_exists python3; then
+  echo "Python is not installed. Attempting to install..."
+  if [[ "$OSTYPE" == "darwin"* ]]; then
+    install_python_macos
+  else
+    install_python_linux
+  fi
+  # Open a new terminal to check if installation was successful
+  if ! command_exists python && ! command_exists python3; then
+    echo "Python installation failed. Please install Python manually."
+    exit 1
+  fi
+else
+  echo "Python is already installed."
+fi
+
+# 2. Check if Flutter is installed
+if ! command_exists flutter; then
+  echo "Warning: If you want to build the GUI, you might need Flutter (optionally)."
+fi
+
+# 3. Install requirements using pip
+open_new_terminal_and_run() {
+  if [[ "$OSTYPE" == "darwin"* ]]; then
+    osascript -e 'tell app "Terminal" to do script "'"$1"'"'
+  else
+    x-terminal-emulator -e $1
+  fi
+}
+
+open_new_terminal_and_run "
+if ! pip install -r requirements.txt && ! pip3 install -r requirements.txt; then
+  if ! command_exists pip; then
+    python -m ensurepip || python3 -m ensurepip
+  fi
+  if ! pip install -r requirements.txt && ! pip3 install -r requirements.txt; then
+    echo 'Failed to install requirements. Please reinstall Python manually.'
+    exit 1
+  fi
+fi
+"
+
+# 4. Download spacy model
+if ! python -m spacy download en_core_web_sm && ! python3 -m spacy download en_core_web_sm; then
+  echo "Failed to download spacy model. Please check your Python installation."
+  exit 1
+fi
+
+# 5. Inform the user about the next steps
+echo "To use the CLI, run the following command from the current directory:"
+echo "python bionicpython/bionicpython.py '<path to your pdf/docx file>'"
+echo "Remember to insert the path in quotes if it isn't already."