Skip to main content

Installation

This guide will walk you through the process of installing Astonish on your system.

Prerequisites​

Before installing Astonish, ensure you have the following prerequisites:

  • Python: Version 3.8 or higher
  • Pip: The Python package installer

You can check your Python version by running:

python --version

Installation Methods​

There are two ways to install Astonish:

  1. Using pip (recommended)
  2. From source code

The easiest way to install Astonish is using pip:

pip install astonish

This will install Astonish and all its dependencies.

Install from source code​

To install Astonish from source code, follow these steps:

  1. Clone the repository:
git clone https://github.com/schardosin/astonish.git
cd astonish
  1. Build and install the package:
make install

This command will build the package as a wheel and install it.

  1. For development purposes, you can install in editable mode:
make installdev

Verifying the Installation​

To verify that Astonish has been installed correctly, run:

astonish --version

This should display the version information for Astonish.

Next Steps​

After installing Astonish, you should:

  1. Configure Astonish by setting up an AI provider
  2. Try the Quick Start Guide to create your first agent

Troubleshooting​

Common Issues​

Package Not Found​

If you encounter a "Package not found" error when installing with pip, try upgrading pip:

pip install --upgrade pip

Permission Errors​

If you encounter permission errors when installing, you may need to use sudo (on Linux/macOS) or run as administrator (on Windows), or use a virtual environment:

# Create a virtual environment
python -m venv venv

# Activate the virtual environment
# On Windows:
venv\Scripts\activate
# On Linux/macOS:
source venv/bin/activate

# Install Astonish in the virtual environment
pip install astonish

Dependency Conflicts​

If you encounter dependency conflicts, consider using a virtual environment as described above.

For other issues, please check the GitHub issues or create a new issue if your problem is not already reported.