Installation¶

Requirements¶

  • Python 3.8 or higher

  • pip (Python package installer)

Basic Installation¶

Install vein using pip:

pip install vein

Installation with AWS Support¶

To use vein with AWS services (AppConfig, Parameter Store, Secrets Manager):

pip install "vein[aws]"

Full Installation¶

To install vein with all optional dependencies:

pip install "vein[all]"

Development Installation¶

To contribute to vein or install from source:

# Clone the repository
git clone https://github.com/yourusername/vein.git
cd vein

# Install in development mode
pip install -e ".[dev]"

# Run tests
python -m pytest

Verify Installation¶

After installation, verify everything is working:

from vein import config

# Basic test
config.test = "Hello, vein!"
print(config.test)  # Should print: Hello, vein!

Next Steps¶