Developer Installation Instructions

Note

This page is for developers who want to customize or extend OpenWISP Users, whether for bug fixes, new features, or contributions.

For user guides and general information, please see:

Installing for Development

Install sqlite:

sudo apt-get install sqlite3 libsqlite3-dev openssl libssl-dev

Install your forked repo:

git clone git://github.com/<your_fork>/openwisp-users
cd openwisp-users/
pip install -e .[rest]

Install test requirements:

pip install -r requirements-test.txt

Start Redis

docker-compose up -d

Create database:

cd tests/
./manage.py migrate
./manage.py createsuperuser

Run celery and celery-beat with the following commands (separate terminal windows are needed):

cd tests/
celery -A openwisp2 worker -l info
celery -A openwisp2 beat -l info

Launch development server:

./manage.py runserver

You can access the admin interface at http://127.0.0.1:8000/admin/.

Run tests with:

# --parallel and --keepdb are optional but help to speed up the operation
./runtests.py --parallel --keepdb

To install the latest Pypi:

pip install openwisp-users

To install the latest development version tarball via HTTPs:

pip install https://github.com/openwisp/openwisp-users/tarball/master

Alternatively you can use the git protocol:

pip install -e git+git://github.com/openwisp/openwisp-users#egg=openwisp_users