Skip to main content

Installation

ReqSmith can be installed in several ways depending on your needs and preferences.

Prerequisites​

  • Python 3.9 or higher
  • pip (Python package installer)
  • Network connectivity for API testing

Installation Methods​

The easiest way to install ReqSmith is from PyPI:

pip install reqsmith

For YAML configuration support:

pip install reqsmith[yaml]

For all optional features including AI:

pip install reqsmith[all]

2. Install from Source​

Clone and Install​

git clone https://github.com/VesperAkshay/reqsmith.git
cd reqsmith
pip install .

Development Installation​

For development or contributing:

git clone https://github.com/VesperAkshay/reqsmith.git
cd reqsmith
pip install -e .[dev]

3. Install with pipx (Isolated Installation)​

Install ReqSmith in an isolated environment while making it available globally:

pipx install reqsmith

This is recommended if you want to avoid dependency conflicts with other Python packages.

Verify Installation​

After installation, verify that ReqSmith is working correctly:

# Check version
reqsmith --version

# Show help
reqsmith --help

# Test with a simple request
reqsmith request get https://httpbin.org/get

Optional Dependencies​

AI Features (Gemini Integration)​

For AI-powered features, install the Google Generative AI package:

pip install google-generativeai

Then configure your API key:

reqsmith config set ai.gemini_api_key "your-api-key-here"

YAML Support​

For YAML configuration file support:

pip install PyYAML

Environment Variables​

You can override configuration using environment variables:

export REQSMITH_DEBUG=true
export REQSMITH_TIMEOUT=60
export REQSMITH_GEMINI_API_KEY="your-api-key"

See reqsmith config env for a full list of available environment variables.

Troubleshooting​

Common Issues​

  1. Command not found: Make sure pip's bin directory is in your PATH
  2. Permission errors: Use pip install --user reqsmith for user-only installation
  3. Python version: Ensure you're using Python 3.9 or higher

Getting Help​

Uninstallation​

To remove ReqSmith:

pip uninstall reqsmith

To also remove configuration and data:

# On Unix/Linux/macOS
rm -rf ~/.reqsmith/

# On Windows
rmdir /s %USERPROFILE%\.reqsmith

Next Steps​