Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dependencies and prediction markets #596

Merged
merged 1 commit into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 149 additions & 0 deletions docs/dependencies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
# Install Dependencies

Before getting started, ensure you have the following tools installed:

- **Python >= 3.10**
- **Poetry** (for dependency management)
- **Git** (for version control)
- **GCP CLI** (optional, for deploying and monitoring agents)


## Installation Steps

### **1. Install Python >= 3.10**

#### **Check Python Version:**
```bash
python3 --version
```

#### **Install Python:**

- **On Ubuntu/Debian:**
```bash
sudo apt update
sudo apt install -y software-properties-common
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install -y python3.10 python3.10-venv python3.10-dev
```

- **On macOS (with Homebrew):**
```bash
brew install [email protected]
```

- **On Windows:**
1. Download Python from the [official Python website](https://www.python.org/downloads/).
2. Run the installer and ensure "Add Python to PATH" is checked.

#### **Verify Installation:**
```bash
python3 --version
```

---

### **2. Install Poetry (Dependency Management)**

#### **Check if Poetry is Already Installed:**
```bash
poetry --version
```

#### **Install Poetry:**
- Run the following command:
```bash
curl -sSL https://install.python-poetry.org | python3 -
```

#### **Add Poetry to PATH (if not already added):**
- **Linux/macOS:**
```bash
export PATH="$HOME/.local/bin:$PATH"
```
Add the above line to your shell configuration file (`~/.bashrc`, `~/.zshrc`, or similar).

- **Windows:**
Poetry is added to PATH during installation, but you may need to restart your terminal.

#### **Verify Installation:**
```bash
poetry --version
```

---

### **3. Install Git (Version Control)**

#### **Check if Git is Already Installed:**
```bash
git --version
```

#### **Install Git:**
- **On Ubuntu/Debian:**
```bash
sudo apt update
sudo apt install -y git
```

- **On macOS (with Homebrew):**
```bash
brew install git
```

- **On Windows:**
1. Download Git from the [official Git website](https://git-scm.com/).
2. Run the installer and follow the setup wizard.

#### **Verify Installation:**
```bash
git --version
```

---

### **4. Install GCP CLI (Google Cloud CLI)** *(Optional)*

#### **Check if GCP CLI is Already Installed:**
```bash
gcloud --version
```

#### **Install GCP CLI:**

- **On Ubuntu/Debian:**
```bash
sudo apt update
sudo apt install -y apt-transport-https ca-certificates gnupg
echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
sudo apt install -y google-cloud-sdk
```

- **On macOS (with Homebrew):**
```bash
brew install --cask google-cloud-sdk
```

- **On Windows:**
1. Download the installer from the [GCP CLI website](https://cloud.google.com/sdk/docs/install).
2. Run the installer and follow the setup wizard.

#### **Initialize GCP CLI:**
After installation, run the following to set up the CLI:
```bash
gcloud init
```

#### **Verify Installation:**
```bash
gcloud --version
```

---

By completing these steps, you'll have Python, Poetry, Git, and optionally GCP CLI installed and ready to use.



1 change: 1 addition & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Install and Run
3 changes: 2 additions & 1 deletion docs/predictionmarkets.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Prediction markets are decentralized platforms that allow participants to speculate on the outcomes of future events by trading tokens or assets tied to specific events. It leverages blockchain technology and smart contracts to create transparent, trustless, and immutable environments for this type of speculation.

![](/docs/images/predictionmarket.png)
![predictionmarket](/docs/images/predictionmarket.png)
## Key Components of Prediction Markets in Web3

- Event-Based Contracts:
Expand Down Expand Up @@ -39,3 +39,4 @@ Anyone with internet access and a Web3 wallet can participate, removing geograph
- Accurate Market Sentiment:
Prediction markets often provide a more accurate reflection of the probability of events because participants have financial incentives to base their trades on real information or beliefs.


8 changes: 6 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
site_name: Prediction Market Agent Tooling
nav:
- Home: index.md
- Prediction Markets: predictionmarkets.md
- Quickstart
- Dependencies: dependencies.md
- Install and Configure: install.md
- Contributing: contributing.md
theme:
name: material

theme:
name: material
Loading