# Installation

## Install the client from PyPI

The python-designateclient package is published on PyPI and so can be installed using the pip tool, which will manage installing all python dependencies:

    pip install python-designateclient

Warning: the packages on PyPI may lag behind the git repo in functionality.

## Setup the client from source

If you want the latest version, straight from github:

    git clone git@github.com:openstack/python-designateclient.git
    cd python-designateclient
    virtualenv .venv
    . .venv/bin/activate
    pip install -r requirements.txt -r test-requirements.txt
    python setup.py install

## Setup the client in development mode

Installing in development mode allows your to make changes to the source code & test directly without having to re-run the “python setup.py install” step. You can find out more about Development Mode

    git clone git@github.com:openstack/python-designateclient.git
    cd python-designateclient
    virtualenv .venv
    . .venv/bin/activate
    pip install -r requirements.txt -r test-requirements.txt
    python setup.py develop

this page last updated: 2026-07-15 16:40:58

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug