### Set up XRSS Development Environment

Source: https://github.com/thytu/xrss/blob/main/CONTRIBUTING.md

Commands to set up a virtual environment and install XRSS with development dependencies.

```bash
# Create and activate virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: .\venv\Scripts\activate

# Install development dependencies
pip install .
```

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

### XRSS Testing and Development Setup

Source: https://github.com/thytu/xrss/blob/main/README.md

Commands to set up the development environment for XRSS, install necessary dependencies, and run the test suite. Coverage is included by default when running tests.

```python
# Get the dev goodies
pip install ".[dev]"

# Run the test suite
pytest

# Check the coverage
pytest  # Coverage included by default
```

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

### Manual Python Setup for XRSS

Source: https://github.com/thytu/xrss/blob/main/README.md

Steps for manually setting up XRSS using Python's virtual environment and pip.

```bash
# Create your virtual environment
python -m venv venv
source venv/bin/activate  # Windows: .\venv\Scripts\activate

# Install what you need
pip install .            # Basic setup
# OR
pip install ".[dev]"    # Developer setup with testing goodies

# Launch!
python main.py
```

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

### Docker Compose Setup for XRSS

Source: https://github.com/thytu/xrss/blob/main/README.md

Instructions for setting up and running XRSS using Docker Compose.

```bash
# Using Docker Compose (recommended)
curl -O https://raw.githubusercontent.com/thytu/xrss/main/docker-compose.yml
docker compose up -d
```

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

### Clone & Configure XRSS

Source: https://github.com/thytu/xrss/blob/main/README.md

Steps to clone the XRSS repository and configure environment variables using the provided example.

```bash
# Get the example config
curl -O https://raw.githubusercontent.com/thytu/xrss/main/.env.example
mv .env.example .env
# Edit .env with your Twitter credentials
```

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

### Two-Factor Authentication (TOTP) Setup

Source: https://github.com/thytu/xrss/blob/main/README.md

Instructions for setting up two-factor authentication (TOTP) for your Twitter/X account and exporting the secret key as an environment variable. This is optional and only required if 2FA is enabled.

```bash
export TWITTER_TOTP_SECRET=your_totp_secret_here
```

```bash
# Add to your .env file
TWITTER_TOTP_SECRET=your_totp_secret_here
```

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

### XRSS RSS Feed Endpoint

Source: https://github.com/thytu/xrss/blob/main/README.md

API documentation for the GET /feed.xml endpoint, which provides Twitter feeds in RSS format. It allows filtering by usernames and content types.

```APIDOC
GET /feed.xml?usernames=ylecun&usernames=karpathy&include_replies=false

| Parameter | Type | Default | Description |
|:----------|:-----|:---------|:------------|
| `usernames` | `List[str]` | `["ylecun"]` | Twitter handles to follow |
| `include_posts` | `bool` | `true` | Include regular tweets |
| `include_replies` | `bool` | `true` | Include reply tweets |
| `include_retweets` | `bool` | `true` | Include retweets |
| `include_quotes` | `bool` | `true` | Include quote tweets |
```

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

### Run XRSS Tests

Source: https://github.com/thytu/xrss/blob/main/CONTRIBUTING.md

Commands to execute the test suite for XRSS, including options for code coverage.

```bash
pytest
pytest --cov=xrss tests/  # For coverage report
```

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

### Direct Docker Run for XRSS

Source: https://github.com/thytu/xrss/blob/main/README.md

Instructions for running XRSS directly using a Docker container.

```bash
docker run -d \
  --name xrss \
  -p 8000:8000 \
  --env-file .env \
  vdematos/xrss:latest
```

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

### Format XRSS Code

Source: https://github.com/thytu/xrss/blob/main/CONTRIBUTING.md

Commands to format the XRSS codebase using Black and isort.

```bash
black .
isort .
```

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

### XRSS Contribution Workflow

Source: https://github.com/thytu/xrss/blob/main/README.md

Steps for contributing to the XRSS project, including forking the repository, creating a new branch, committing changes, and opening a pull request.

```bash
# Get the dev goodies
pip install ".[dev]"

# Run the test suite
pytest

# Check the coverage
pytest  # Coverage included by default
```

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

### XRSS Development Workflow

Source: https://github.com/thytu/xrss/blob/main/CONTRIBUTING.md

Steps involved in the XRSS development process, including making changes, testing, and formatting.

```python
# Write meaningful commit messages
# Add tests for new functionality
# Update documentation as needed
```

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

### XRSS Required Environment Variables

Source: https://github.com/thytu/xrss/blob/main/README.md

Lists the essential environment variables required for configuring XRSS, including Twitter API credentials and Redis connection details.

```APIDOC
| Variable | Description |
|:---------|:------------|
| `TWITTER_USERNAME` | Your Twitter handle |
| `TWITTER_EMAIL` | Your Twitter email |
| `TWITTER_PASSWORD` | Your Twitter password |
| `TWITTER_TOTP_SECRET` | TOTP secret key (required if 2FA is enabled) |
| `REDIS_URL` | Redis connection string |
```

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

### XRSS Configuration Variables

Source: https://github.com/thytu/xrss/blob/main/README.md

Lists optional configuration variables for XRSS, including their default values and purpose. These variables control caching behavior, refresh intervals, and cookie storage paths.

```bash
# Store in your config directory
export COOKIES_FILE=~/.config/xrss/cookies.json

# Or in a local data directory
export COOKIES_FILE=./data/cookies/cookies.json
```

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

### XRSS Raw API Endpoint

Source: https://github.com/thytu/xrss/blob/main/README.md

API documentation for the POST / endpoint, which accepts a JSON payload for advanced feed generation.

```APIDOC
POST /

```json
{
  "usernames": ["user1", "user2"],
  "include_posts": true,
  "include_replies": true,
  "include_retweets": true,
  "include_quotes": true
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.