EdGameClaw

https://github.com/yh2072/edgameclaw
Admin
EdGameClaw is a self-hosted AI studio that transforms educational notes and learning materials into...
Tokens:10,278
Snippets:89
Trust Score:7.2
License:AGPL-3.0
Update:3 days ago
Show doc for...
Tokens:
Raw
### Setup virtual environment and editable install

Source: https://github.com/yh2072/edgameclaw/blob/main/README.md

Commands to create a virtual environment, activate it, and install the package in editable mode.

```bash
python -m venv .venv
source .venv/bin/activate          # Windows: .venv\Scripts\activate
pip install -U pip
pip install -e .
```

--------------------------------

### Initialize environment file

Source: https://github.com/yh2072/edgameclaw/blob/main/README.md

Command to create the .env file from the provided example.

```bash
cp .env.example .env
```

--------------------------------

### Start the Server

Source: https://github.com/yh2072/edgameclaw/blob/main/README_PYPI.md

Launch the application server using uvicorn. The app will be accessible at http://127.0.0.1:8000.

```bash
uvicorn edgameclaw.server:app --host 127.0.0.1 --port 8000
```

--------------------------------

### Install the EdGameClaw package

Source: https://github.com/yh2072/edgameclaw/blob/main/README.md

Upgrade pip and install the edgameclaw package from PyPI.

```bash
pip install -U pip
pip install edgameclaw
```

--------------------------------

### Install EdGameClaw from source

Source: https://github.com/yh2072/edgameclaw/blob/main/README.md

Commands to upgrade pip and perform an editable install from the local repository.

```bash
pip install -U pip
pip install -e .
```

--------------------------------

### Install EdGameClaw

Source: https://github.com/yh2072/edgameclaw/blob/main/README_PYPI.md

Install the package using pip. Requires Python 3.10+ and Node.js 18+.

```bash
pip install edgameclaw
```

--------------------------------

### Build PyPI packages locally

Source: https://github.com/yh2072/edgameclaw/blob/main/REPO_AND_PYPI.md

Commands to install build tools, build the package, and verify the distribution files from the repository root.

```bash
cd /path/to/edgameclaw   # repo root with pyproject.toml

python -m pip install --upgrade build twine

# Bump version first in pyproject.toml and edgameclaw/__init__.py

python -m build          # creates dist/*.whl and dist/*.tar.gz
twine check dist/*
```

--------------------------------

### Test upload to TestPyPI

Source: https://github.com/yh2072/edgameclaw/blob/main/REPO_AND_PYPI.md

Commands to upload the built distribution to the TestPyPI repository and install it for verification.

```bash
twine upload --repository testpypi dist/*
pip install -i https://test.pypi.org/simple/ edgameclaw
```

--------------------------------

### Configure the .env file

Source: https://github.com/yh2072/edgameclaw/blob/main/README.md

Create a .env file in your project directory to store your API key.

```bash
API_KEY=sk-your-key-here
```

--------------------------------

### Create a virtual environment

Source: https://github.com/yh2072/edgameclaw/blob/main/README.md

Initialize a Python virtual environment to manage dependencies.

```bash
python -m venv .venv
```

--------------------------------

### Clone and enter the repository

Source: https://github.com/yh2072/edgameclaw/blob/main/README.md

Initial steps to clone the EdGameClaw repository and navigate into the directory.

```bash
git clone https://github.com/yh2072/edgameclaw.git
cd edgameclaw
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/yh2072/edgameclaw/blob/main/README_PYPI.md

Create a .env file in the directory where the server will run to provide the required API key.

```env
API_KEY=sk-your-openai-compatible-key
```

--------------------------------

### Production upload to PyPI

Source: https://github.com/yh2072/edgameclaw/blob/main/REPO_AND_PYPI.md

Command to upload the distribution to the production PyPI repository using an API token.

```bash
twine upload dist/*
```

--------------------------------

### Create and activate Conda environment with conda-forge

Source: https://github.com/yh2072/edgameclaw/blob/main/README.md

Optional commands to create and activate a Conda environment using the conda-forge channel.

```bash
conda create -n edgameclaw -c conda-forge python=3.12 -y
conda activate edgameclaw
```

--------------------------------

### Tag and push release

Source: https://github.com/yh2072/edgameclaw/blob/main/REPO_AND_PYPI.md

Commands to create a version tag and push it to the remote repository to trigger the publish workflow.

```bash
git tag v0.1.2
git push origin v0.1.2
```

--------------------------------

### Create and activate Conda environment

Source: https://github.com/yh2072/edgameclaw/blob/main/README.md

Standard commands to create and activate a Conda environment for EdGameClaw.

```bash
conda create -n edgameclaw python=3.12 -y
conda activate edgameclaw
```
Tokens:
Raw