Installing

DigitalFate is designed to be easy to install and quick to get started, whether you're working locally, deploying on the cloud, or running it inside a Docker container. The system supports major LLM providers like OpenAI, Anthropic, DeepSeek, and AWS Bedrock out of the box.

---

✅ Prerequisites

Before you begin, ensure you have the following installed and configured:

• Python 3.10+

• Pip (latest version)

• API keys from one or more of the following:

  • OpenAI

  • Anthropic

  • DeepSeek

  • AWS Bedrock

  • Azure OpenAI (optional)

You may also optionally want:

• Docker (for containerized deployments)

• Git (for development version)

---

📦 Installation via Pip

The easiest way to install DigitalFate is through PyPI:

bashCopyEditpip install digitalfate

This installs the core DigitalFate package and its dependencies.

---

🐍 Installing from Source (Development)

If you're contributing to DigitalFate or want the latest updates:

bashCopyEditgit clone https://github.com/DigitalFateSol/DigitalFate.git
cd DigitalFate
pip install -e .

This installs the library in "editable" mode, allowing live updates as you modify the code.

---

🐳 Docker Installation (Optional)

DigitalFate supports Docker-based deployment for both development and production environments.

1. Clone the repo:

bashCopyEditgit clone https://github.com/DigitalFateSol/DigitalFate.git
cd DigitalFate

1. Build the Docker image:

bashCopyEditdocker build -t digitalfate .

1. Run the container:

bashCopyEditdocker run -p 8000:8000 digitalfate

You can configure API keys and environment variables inside the Docker container for secure deployment.

---

🔑 Environment Variables

Set your API keys using the DigitalFate client or environment variables. Example:

bashCopyEditexport OPENAI_API_KEY="your_openai_key"
export ANTHROPIC_API_KEY="your_anthropic_key"
export DEEPSEEK_API_KEY="your_deepseek_key"

---

🧪 Verifying the Installation

Once installed, run a quick test:

pythonCopyEditfrom digitalfate import digitalfateClient

client = digitalfateClient("localserver")
client.set_config("OPENAI_API_KEY", "your_key")
print("DigitalFate installed and configured successfully.")

You’re now ready to start building powerful AI agents.

---

📁 Project Structure (After Clone)

bashCopyEditDigitalFate/
├── digitalfate/             # Core framework
├── examples/                # Sample scripts
├── client/                  # Client utilities (tools, agent configs)
├── server/                  # Tool server and MCP server (optional)
├── tests/                   # Unit and integration tests
├── setup.py
└── README.md

---

🔧 Optional Dependencies

Some tools and environments may require additional packages:

bashCopyEditpip install beautifulsoup4 pdfminer.six

These are useful for scraping, parsing PDFs, and handling custom tools.

---

Once you’ve installed DigitalFate, you can proceed to setting up your first task and agent.