Installation Guide¶
Requirements¶
- Python 3.8 or higher
- pip (Python package installer)
Installation Options¶
Option 1: Install from Source (Recommended)¶
# Clone the repository
git clone https://github.com/aihint/aihint-standard.git
cd aihint-standard
# Install in development mode
pip install -e .
Option 2: Install Dependencies Only¶
Option 3: Install from PyPI (Future)¶
Dependencies¶
The following packages are required:
cryptography>=41.0.0
- Cryptographic operationsrequests>=2.31.0
- HTTP requests for key fetchingjsonschema>=4.19.0
- JSON schema validationclick>=8.1.0
- CLI frameworkpydantic>=2.4.0
- Data validationpytest>=7.0.0
- Testing framework
Verification¶
After installation, verify that AiHint is working:
# Check CLI is available
aihint --help
# Run tests
python -m pytest tests/ -v
# Run example
python examples/create_hint.py
Development Setup¶
For contributors:
# Install development dependencies
pip install -r requirements.txt
pip install -r docs-requirements.txt
# Install in development mode
pip install -e .
# Run tests
pytest tests/ -v
# Build documentation
mkdocs build
Troubleshooting¶
Common Issues¶
- Import Error: Make sure you're in the correct directory and have installed the package
- Permission Error: Use
pip install --user
or create a virtual environment - Missing Dependencies: Run
pip install -r requirements.txt