Installation
Get started with Voxin by following our installation guide. Learn how to install the framework and set up your development environment.
Prerequisites
- ✓ Python 3.8 or higher
- ✓ pip or another package manager
- ✓ Virtual environment (recommended)
- ✓ API key from the Voxin dashboard
Installation Methods
Choose your preferred installation method:
install.sh
12345678
# Using pippip install voxin# Using poetrypoetry add voxin# Using condaconda install -c conda-forge voxin
Basic Setup
Initialize the framework in your application:
setup.py
12345678
from voxin import init_voxin# Initialize the frameworkinit_voxin( api_key="your_api_key", environment="development", # or "production" log_level="INFO")
Dependencies
Required and optional dependencies:
requirements.txt
123456
# requirements.txtvoxin>=1.0.0python-dotenv>=0.19.0aiohttp>=3.8.0numpy>=1.21.0torch>=1.9.0 # Optional: for advanced ML features
Environment Configuration
Configure your environment variables:
.env
123456789
# .envVOXIN_API_KEY=your_api_key_hereVOXIN_ENVIRONMENT=developmentVOXIN_LOG_LEVEL=INFO# Optional configurationsVOXIN_CACHE_DIR=/path/to/cacheVOXIN_MAX_WORKERS=4VOXIN_TIMEOUT=30
Troubleshooting
Common Issues
- ImportError: Make sure all dependencies are installed
- API Key Error: Verify your API key in environment variables
- Version Conflicts: Use a virtual environment
- Permission Issues: Try installing with sudo/admin rights