====== How to install an app (aider-chat as example) in a virtual environment ======

===== Introduction =====

This guide demonstrates how to install an app in a Python virtual environment, using aider-chat (an AI-powered coding assistant) as an example. We'll cover the process for both Windows and Linux systems.

===== Prerequisites =====

  * Python 3.7 or higher installed on your system
  * Basic familiarity with command-line operations

===== Step-by-Step Guide =====

==== 1. Create a virtual environment ====

Open your terminal (Command Prompt or PowerShell on Windows, Terminal on Linux) and run:

=== On Windows: ===
<code>
python -m venv aider-env
</code>

=== On Linux: ===
<code>
python3 -m venv aider-env
</code>

==== 2. Activate the virtual environment ====

=== On Windows (Command Prompt): ===
<code>
aider-env\Scripts\activate.bat
</code>

=== On Windows (PowerShell): ===
<code>
.\aider-env\Scripts\Activate.ps1
</code>

=== On Linux: ===
<code>
source aider-env/bin/activate
</code>

Your command prompt should now show ''(aider-env)'', indicating the virtual environment is active.

==== 3. Install the app (aider-chat) ====

With the virtual environment activated, install the app:

<code>
pip install aider-chat
</code>

==== 4. Verify the installation ====

Check if the app is installed correctly:

<code>
aider --version
</code>

This should display the version of aider-chat you've installed.

==== 5. Using the app ====

Now you can use the app within your virtual environment. For example:

<code>
aider --help
</code>

This will display the help information for aider-chat.

==== 6. Deactivate the virtual environment ====

When you're done, deactivate the virtual environment:

=== On both Windows and Linux: ===
<code>
deactivate
</code>

===== Making the app accessible from anywhere =====

To run the app from any directory without activating the virtual environment each time:

==== On Linux: ====

  - Create a wrapper script:
<code>
sudo tee /usr/local/bin/aider << EOF
#!/bin/bash
source /path/to/aider-env/bin/activate
/path/to/aider-env/bin/aider "\$@"
deactivate
EOF
</code>

  - Make the script executable:
<code>
sudo chmod +x /usr/local/bin/aider
</code>

Replace ''/path/to/'' with the actual path to your virtual environment.

==== On Windows: ====

  - Create a batch file named ''aider.bat'' in a directory that's in your system PATH (e.g., ''C:\Windows''):
<code>
@echo off
set VENV_PATH=C:\path\to\aider-env
call %VENV_PATH%\Scripts\activate.bat
%VENV_PATH%\Scripts\aider.exe %*
call %VENV_PATH%\Scripts\deactivate.bat
</code>

  - Save this file as ''C:\Windows\aider.bat'' (or another directory in your PATH)
  - Replace ''C:\path\to\'' with the actual path to your virtual environment

Now you can run ''aider'' from any command prompt or PowerShell window.

===== Conclusion =====

You've now successfully installed an app (aider-chat in this example) in a virtual environment and made it accessible from anywhere in your system. This setup allows you to use the app without affecting your system-wide Python installation and provides convenient access from any directory.

===== See Also =====

  * [[https://github.com/paul-gauthier/aider|Aider-chat GitHub repository]]
  * [[https://docs.python.org/3/tutorial/venv.html|Python venv documentation]]
  * [[https://pip.pypa.io/en/stable/|pip documentation]]