This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Getting Started 🤞

To start using this tool, simply follow one of the options below:

🚦 Getting Started

Prerequisites

Windows

• Python 3.10+ (3.12 recommended)
• Microsoft Visual C++ Build Tools 14.0 or greater
  • Install with: winget install Microsoft.VisualStudio.2022.BuildTools --silent --override "--wait --quiet --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended"
• Rust Compiler
  • Install with: Invoke-WebRequest -Uri https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe -OutFile rustup-init.exe; ./rustup-init.exe -y

Linux

• Python 3.10+ (3.12 recommended)
• C/C++ compiler and development tools
  • Install with: sudo apt update && sudo apt install build-essential python3-dev
• Rust Compiler
  • Install with: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y; source $HOME/.cargo/env

Installation

1. Clone the repository:

   git clone https://github.com/AJaySi/AI-Writer.git
   cd AI-Writer
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Run the application:

   streamlit run alwrity.py
   

4. Visit the Alwrity UI in your browser at http://localhost:8501

Configuration

Alwrity uses a configuration system that allows you to customize various aspects of the platform:

1. API Keys: Add your API keys for various services (OpenAI, Google, etc.)
2. Language Settings: Configure your preferred language and region
3. UI Preferences: Customize the user interface
4. Storage Settings: Configure where your content is stored

Configuration can be done through the UI sidebar or by editing the configuration files directly.

Option 1: 𝗙𝗼𝗹𝗹𝗼𝘄 𝗺𝗲 Local Laptop Install 💻 (Recommended)

Step 0️⃣: Pre-requisites: Git, Python3

Installing Python on Windows:🐍🪟

• Open PowerShell as admin: Press Windows Key + X, then select "Windows PowerShell (Admin)".

• Type python. If Python is not installed, Windows will prompt you to 'Get Python'.

• If Python is installed, you should see '>>>>>'.

ALwrity - AI Content Writing Assistant

Quick Start Guide for Non-Technical Users

Option 1: One-Click Installation (Recommended)

1. Download this project:

   • Click the green "Code" button above
   • Select "Download ZIP"
   • Extract the ZIP file to your desired location (e.g., Desktop)

2. Run the installer:

   • Navigate to Getting Started Folder
   • Double-click install.bat in the extracted folder
   • If Windows asks for permission, click "Yes"
   • Follow the on-screen instructions
   • Wait for the installation to complete

3. Start ALwrity:

   • Open Command Prompt (Windows + R, type "cmd", press Enter)
   • Navigate to the ALwrity folder:

     cd path\to\ALwrity
     

   • Type alwrity and press Enter

---

Option 2: Manual Installation

If the one-click installer doesn't work, follow these steps:

1. Install Python 3.11:

   • Visit Python 3.11.6 Download Page
   • Click "Windows installer (64-bit)"
   • Run the installer
   • ✅ IMPORTANT: Check "Add Python 3.11 to PATH"
   • Click "Install Now"
   • Wait for installation to complete

2. Install ALwrity:

   • Open Command Prompt (Windows + R, type "cmd", press Enter)
   • Navigate to the ALwrity folder:

     cd path\to\ALwrity
     

   • Run the installation:

     python setup.py install
     

   • Follow any on-screen instructions

3. Start ALwrity:

   • In the same Command Prompt window, type:

     alwrity
     

   • Press Enter

---

Troubleshooting Guide

---

Prerequisites

Windows

• Python 3.10+ (3.12 recommended)
• Microsoft Visual C++ Build Tools 14.0 or greater
  • Install with: winget install Microsoft.VisualStudio.2022.BuildTools --silent --override "--wait --quiet --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended"
• Rust Compiler
  • Install with: Invoke-WebRequest -Uri https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe -OutFile rustup-init.exe; ./rustup-init.exe -y

Linux

• Python 3.10+ (3.12 recommended)
• C/C++ compiler and development tools
  • Install with: sudo apt update && sudo apt install build-essential python3-dev
• Rust Compiler
  • Install with: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y; source $HOME/.cargo/env

1). git clone https://github.com/AJaySi/AI-Writer.git
2). pip install -r requirements.txt
3). streamlit run alwrity.py

4). Visit Alwrity UI in a Browser & Start generation AI personalized content.

System Dependencies

You can run the install_dependencies.py script to check for system dependencies and assist with installation:

python install_dependencies.py

This script will help verify that all necessary system dependencies are installed and guide you through the installation process.

Updating to latest Code: (Existing users)

1). Git pull
2). pip install -U -r requirements.txt
3). streamlit run alwrity.py

---

Still stuck, Open issue here & Someone will bail you out.

---

Common Issues and Solutions:

1. "Python is not recognized"

   • Solution: Restart your computer after installing Python
   • Make sure you checked "Add Python 3.11 to PATH" during installation

2. "Visual C++ Build Tools not found"

   • Solution: Run this command in an administrative PowerShell:

     winget install Microsoft.VisualStudio.2022.BuildTools --silent --override "--wait --quiet --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended"
     

3. "Rust compiler not found"

   • Solution: Run these commands in PowerShell:

     Invoke-WebRequest -Uri https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe -OutFile rustup-init.exe
     ./rustup-init.exe -y
     

4. Installation Errors

   • Check the install_errors.log file in the ALwrity folder
   • Share the error message with our support team

Need Help?

• Open an issue on GitHub
• Join our support community
• Contact our support team

System Requirements

• Windows 10 or later
• Python 3.11.x
• At least 4GB RAM
• 2GB free disk space

First-Time Setup

After installation:

1. The first time you run ALwrity, it will ask for your API keys
2. Follow the on-screen instructions to enter your keys
3. Your keys will be saved securely for future use

Updating ALwrity

To update to the latest version:

1. Download the latest release
2. Run install.bat again
3. Follow the on-screen instructions

---

Installing Git on Windows:🛺

• Open PowerShell or Windows Terminal: Press Windows Key + X, then select "Windows Terminal".

• Paste or type and press enter:⏎.⏎.
  winget install --id Git.Git -e --source winget

• Wait for download bars to finish

Note for Linux Users: If you're on Linux and can't install these, hmmmmmm 🧙♂️

---

Step 1️⃣: Clone this repository to your local machine.

To clone the repository to your local machine, perform the following steps:

1. **Open Windows PowerShell as Administrator:** Press `Windows Key + X` and select "Windows PowerShell (Admin)" from the menu.

2. **Navigate to the Desired Directory:** Use the `cd` command to move to the directory where you want to clone the repository. 

3. **Clone the Repository:** Run the following command in PowerShell to clone the repository:
`git clone https://github.com/AJaySi/AI-Writer.git`
This command will download all the files from the repository to your local machine.

4. **Verify the Clone:** After the cloning process is complete, navigate into the newly created directory using: 
`cd AI-Writer`

---

Once you've cloned the repository, you can proceed with the next steps for installation and setup.

Step 2️⃣: Install required dependencies:

• Open the command prompt on your local machine: Press Windows Key + R, type cmd, then press Enter.
• Navigate to the folder from Step 1
• Run: pip install -r requirements.txt

Step 3️⃣: Run the script:

• Execute: streamlit run alwrity.py

Step 4️⃣: The tool will guide you through setting up your APIs.

---

Option 2: Replit: Cloud Install ☁️☁️☁️ ☁️ ☁️ ....☁️

Step 1️⃣: Fork this repository to your own GitHub account.

Step 2️⃣: Follow this guide: Running GitHub Repositories on Replit 📖