Skip to content

installation.md

Latest commit

 

History

History
executable file
·
191 lines (129 loc) · 3.29 KB

installation.md

File metadata and controls

executable file
·
191 lines (129 loc) · 3.29 KB

📥 DoMD Installation Guide

Prerequisites

  • Python 3.8 or newer
  • pip (Python package manager)
  • Git (optional, for installation from repository)
  • Docker (optional, for containerized execution)

Installation Methods

1. Using pip (Recommended)

The easiest way to install DoMD:

pip install domd

2. From Source (for latest development version)

If you want to use the latest development version:

# Clone the repository
git clone https://github.com/wronai/domd.git
cd domd

# Install in development mode
pip install -e .

3. With Optional Dependencies

DoMD supports optional dependencies for extended functionality:

# With Ansible support
pip install "domd[ansible]"

# With development tools
pip install "domd[dev]"

# All optional dependencies
pip install "domd[all]"

# Using Poetry (optional)
poetry add domd

4. Using Docker

You can also use DoMD via Docker without installing it locally:

docker run --rm -v $(pwd):/app ghcr.io/wronai/domd domd

Verifying Installation

Check if DoMD is installed correctly:

domd --version

You should see the version number, e.g., domd 1.0.0.

Updating

To update DoMD to the latest version:

pip install --upgrade domd

Uninstalling

To uninstall DoMD:

pip uninstall domd

Troubleshooting

Permission Errors

If you encounter permission errors during installation:

pip install --user domd

Or on Linux/macOS:

sudo pip install domd

Dependency Issues

If you have dependency conflicts:

pip install --upgrade pip setuptools wheel
pip install --no-cache-dir domd

Common Issues

1. Błąd: "Command not found"

# Sprawdź czy narzędzie jest zainstalowane
which npm  # lub yarn, make, docker, itp.

# Zainstaluj brakujące narzędzia
sudo apt install make  # Ubuntu/Debian
brew install make      # macOS

2. Błąd: "Permission denied"

# Sprawdź uprawnienia
ls -la Makefile
chmod +x scripts/build.sh

# Może wymagane sudo dla niektórych komend

3. Błędy timeout

# Zwiększ timeout dla wolnych komend
domd --timeout 300  # 5 minut

4. Problemy z kodowaniem

# Ustaw poprawne kodowanie
export LANG=pl_PL.UTF-8
export LC_ALL=pl_PL.UTF-8

Tryb debugowania

# Szczegółowe informacje o wykonaniu
domd --verbose

# Tylko podgląd bez wykonywania komend
domd --dry-run

Aktualizacja do nowszej wersji

Sprawdzanie wersji

domd --version
poetry show domd  # jeśli zainstalowane przez Poetry
pip show domd     # jeśli zainstalowane przez pip

Aktualizacja

# Aktualizacja przez pip
pip install --upgrade domd

# Aktualizacja z repozytorium (dla instalacji deweloperskiej)
git pull origin main
pip install -e .

📞 Wsparcie

🎯 Następne kroki

Po zainstalowaniu:

  1. Przejdź do przewodnika użytkownika aby poznać możliwości DoMD
  2. Sprawdź dokumentację funkcji aby poznać wszystkie opcje
  3. Dołącz do społeczności na GitHub Discussions

Gotowe do użycia! 🚀