Skip to content

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

Optional Tools

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

# Install project dependencies
just install

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

# View all available commands
just --list

# Run tests to verify everything is working
just test

Platform-Specific Instructions

Windows

# Activate virtual environment on Windows
.\.venv\Scripts\activate

# Install dependencies
just install

macOS/Linux

# Activate virtual environment
source .venv/bin/activate

# Install dependencies
just install

Development Tools Setup

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:

# Install pre-commit hooks
pre-commit install

# Run manually (optional)
pre-commit run --all-files

Troubleshooting

Common Issues

Poetry Installation Issues

If Poetry installation fails:

# Clear Poetry cache
poetry cache clear pypi --all

# Try installing again
poetry install

Python Version Issues

Ensure you're using Python 3.10 or higher:

python --version
# Should show Python 3.10.x or higher

Virtual Environment Issues

If virtual environment activation fails:

# Recreate virtual environment
rm -rf .venv
uv venv
source .venv/bin/activate

Getting Help

If you encounter issues during installation:

  1. Review the error messages carefully
  2. Ensure all prerequisites are installed correctly
  3. Check that all prerequisites are properly installed
  4. Contact the development team for support

Next Steps

After successful installation:

  1. Set up your development environment
  2. Configure your services
  3. Start local development

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)