Installation
This guide will help you set up the digitalNXT Agency development environment.
Prerequisites
Before installing digitalNXT Agency, ensure you have the following prerequisites installed:
Required Tools
- Python 3.10 or higher - Download Python
- uv - Fast Python package installer Install uv
- Poetry - Python dependency management Install Poetry
- Git - Version control Download Git
Optional Tools
- Azure CLI - For Azure deployment Install Azure CLI
- just - Command runner Install just
Installation Steps
1. Clone the Repository
git clone https://dev.azure.com/ictnv/digitalNXT%20Product%20Libraries/_git/DigitalNXT.Agency
cd DigitalNXT.Agency
2. Set Up Python Environment
Using uv (recommended for speed):
# Create and activate virtual environment
uv venv
source .venv/bin/activate # On Windows: .\.venv\Scripts\activate
3. Install Dependencies
4. Environment Configuration
# Copy environment template
cp .env.example .env
# Edit .env file with your configuration
# Add your Azure resource names and API keys
5. Verify Installation
Platform-Specific Instructions
Windows
# Activate virtual environment on Windows
.\.venv\Scripts\activate
# Install dependencies
just install
macOS/Linux
Development Tools Setup
VS Code Extensions (Recommended)
If using Visual Studio Code, install these extensions:
- Python
- Pylance
- Python Docstring Generator
- Azure Tools
- GitLens
Pre-commit Hooks
Set up pre-commit hooks for code quality:
Troubleshooting
Common Issues
Poetry Installation Issues
If Poetry installation fails:
Python Version Issues
Ensure you're using Python 3.10 or higher:
Virtual Environment Issues
If virtual environment activation fails:
Getting Help
If you encounter issues during installation:
- Review the error messages carefully
- Ensure all prerequisites are installed correctly
- Check that all prerequisites are properly installed
- Contact the development team for support
Next Steps
After successful installation:
Verification Checklist
- [ ] Python 3.10+ installed
- [ ] Virtual environment created and activated
- [ ] Dependencies installed via Poetry
- [ ] Environment variables configured
- [ ] Tests pass successfully
- [ ] Pre-commit hooks installed (optional)