Jelle van der Waa 2e5be1e78f Add debug_toolbar support

Add support to use the Django debug toolbar with an easy setting in
local_settings.py.

Closes: #174

2019-02-05 21:03:43 +01:00

3.1 KiB

Raw Blame History

Archweb README

To get a pretty version of this document, run

$ markdown README > README.html

License

See LICENSE file.

Authors

See AUTHORS file.

Dependencies

python
python-virtualenv

Python dependencies

More detail in requirements.txt and requirements_prod.txt; it is best to use virtualenv and pip to handle these. But if you insist on (Arch Linux) packages, you will probably want the following:

python-django
python-psycopg2
python-markdown
python-memcached

Testing Installation

Run virtualenv3.

 cd /path/to/archweb && virtualenv3 ./env/

Activate the virtualenv.
```
 source ./env/bin/activate
```
Install dependencies through pip.
```
 pip install -r requirements.txt
```
Copy local_settings.py.example to local_settings.py and modify. Make sure to uncomment the appropriate database section (either sqlite or PostgreSQL).
Migrate changes.
```
 ./manage.py migrate
```

Load the fixtures to prepopulate some data. If you don't want some of the provided data, adjust the file glob accordingly.

 ./manage.py loaddata main/fixtures/*.json
 ./manage.py loaddata devel/fixtures/*.json
 ./manage.py loaddata mirrors/fixtures/*.json
 ./manage.py loaddata releng/fixtures/*.json

Use the following commands to start a service instance
```
 ./manage.py runserver
```

To optionally populate the database with real data:

 wget http://mirrors.kernel.org/archlinux/core/os/x86_64/core.db.tar.gz
 ./manage.py reporead x86_64 core.db.tar.gz
 # Package file listing
 wget http://mirrors.kernel.org/archlinux/core/os/x86_64/core.files.tar.gz
 ./manage.py reporead --filesonly x86_64 core.files.tar.gz

Alter architecture and repo to get x86_64 and packages from other repos if needed.

Database Updates for Added/Removed packages

 sqlite3 archweb.db < packages/sql/update.sqlite3.sql

For PostgreSQL use packages/sql/update.postgresql_psycopg2.sql

Testing SMTP server

To be able to create an account on your test environment an SMTP server is required. A simple debugging SMTP server can be setup using Python.

    python -m smtpd -n -c DebuggingServer localhost:1025

In local_settings.py add entries to set EMAIL_HOST to 'localhost' and EMAIL_PORT to 1025.

Running tests and coverage

To the unittests execute the following commands:

    ./manage.py collectstatic --noinput
    ./manage.py test

Running coverage:

    pip install coverage
    coverage run --omit='env*' --source='.' manage.py test
    coverage report

To use the Django Debug toolbar install django-debug-toolbar and in local_settings.py set DEBUG_TOOLBAR to True.

Production Installation

Arch Linux has an Ansible role for Archweb in their infrastructure repo.

vim: set syntax=markdown et:

3.1 KiB Raw Blame History