Installation Guide

Install from PyPI (Recommended)

For most users, installing Synthora from PyPI is the simplest and most recommended approach. You can get started with just one command:

pip install synthora

This will install the core components of synthora.

Optional Add-ons:

• Pre-built Toolkits: To include Synthora’s pre-built tools, use:

  pip install "synthora[toolkits]"
  

• Pre-built Services: For pre-configured services, use:

  pip install "synthora[services]"
  

• All Dependencies: To install all optional dependencies, use:

  pip install "synthora[all]"
  

---

Install from Source

Installing from source is ideal for developers. It allows full customization and the freedom to modify components to meet specific needs. This aligns with Synthora’s design philosophy: we aim to provide a flexible core without overloading pre-built components. By leveraging inheritance, you can easily implement your desired features (trust us, Synthora takes care of the tricky parts).

Steps to Install from Source:

Install with poetry (Recommended):

1. Clone the GitHub repository:

   git clone https://github.com/syntropix-ai/synthora.git
   

2. Navigate to the project directory:

   cd synthora
   

3. Install Poetry (if not already installed):

   pip install poetry
   

4. Activate the Poetry environment:

   poetry shell
   

5. Install the core components:

   poetry install
   

6. Alternatively, install all optional components:

   poetry install -E all
   

---

Install with pip

If you prefer to install Synthora in an editable mode for development purposes, you can use the following method:

1. Clone the repository (if not done already):

   git clone https://github.com/syntropix-ai/synthora.git
   

2. Navigate to the project directory:

   cd synthora
   

3. Use pip to install in editable mode:

   pip install -e .
   

4. Optional: If you need all optional dependencies, use:

   pip install -e .[all]
   

This method is particularly useful if you plan to make changes to Synthora’s codebase, as it reflects changes instantly without the need for reinstallation.