Iguana is a mixture of a ticket system, an issue tracker and an issue management system, heavily based on basic functions being easy to use. So Iguana can help you to plan the next schedule and to always have a nice overview about your current tasks depending on your needs, especially for working in groups. There is a kanban board to keep an eye on the progress until the end of the next planning stage and also a backlog to have the ability for scheduling of long-term tasks. In combination with a mechanism to log time spent on different tasks individually those are the essential functionalities.
For more detailed documentation including a list of features see our github documentation page at https://iguana-project.github.io.
- Sprintboard
Provides possibility for short-term scheduling. - Backlog
Provides possibility for long-term scheduling. - Olea-bar
A command line tool to create and edit existing issues. - Time-logging
For both issues and projects, where the value for the later one is simply the sum of relative issue-time-logs. - Activity charts
To keep an eye on the progress of a specific project in both aspects, for time management and amount of activities (e.g. commits). There is an activity overview for a project and a different chart for the proportion of issues on a single project. - Notifications
Present multiple ways to notify you for different events. In the future it will be customizable which notifications shall be shown with which feature.- Activity stream
show the latest actions in multiple streams. - Discussion App
Get notifications on changes or comments on a specific issue you set a watchpoint for. - Email notifications
Sends notifications via email.
- Activity stream
- Search function
Search any type of a specific data with regex support. - Integrations
To simplify your workflow- Git
- Slack
- REST-API
To extend your possibilities on how to use iguana. - Markdown support
For nicer formatting of comments and descriptions. - Ansible
Easy and fast start due to the usage of ansible - Docker
Alternatively an even easier and faster start with Docker
If you want to manually install Iguana, there are some dependencies and actions that must be installed and done before:
TODO: more dependencies required
We generally try to avoid any non-python dependencies but this doesn't always work well. The test cases need the Exempi library so for the development environment this is required and can be installed like this:
apt-get install libexempi3 # Ubuntu/Debian
pacman -S exempi # Arch Linux
brew install exempi # OS XIguana is currently tested against Python 3.8.
It may be also run on higher versions. But if you run into any problems, please test first if they also occur with Python 3.8.
To install Python 3.8 locally (independent from your current system version), you can use pyenv. For installation and setting up pyenv please stick to their documentation: https://github.com/pyenv/pyenv/wiki
Once you've got pyenv running execute the following command in the main iguana directory:
pyenv install -v $(cat .python-version)If everything is correctly setup and if you simply run python in your command shell, the python interpreter with the version specified in the .python-version file should be started. If you already created a virtualenv previously you should delete it and recreate it with the specified python version.
Common problems using pyenv: Since pyenv is compiling every python version other than your system one directly on your PC, it can happen that after some time this version won't work any more. Often there are errors of missing shared libraries, when you try to start Iguana or the Python interpreter installed by pyenv. This can happen e.g. after a system update/upgrade. To solve this issue simply reinstall the Python version with the above pyenv command.
To setup Iguana in a production environment you simply have to call:
make productionThis command runs the following Makefile targets:
setup-virtualenvdjango makemigrationsdjango migratecss
To setup Iguana in a staging environment you simply have to call:
make stagingThis does the same as the production target but it creates the staging virtual environment.
To setup Iguana in a development you simply have to call:
make development ++webdriver [<webdriver>]The <webdriver> option the driver for the setup-webriver target can be specified ("chrome" is used as default). Beside that the following targets are executed:
productionsetup-webdriver <webdriver>
Currently Iguana supports only Nginx as web server backend. For configuring Nginx and using Gunicorn together with Django please stick to the official documentation: https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/gunicorn/
To start the local Django web server simply run:
make runThree images can be built with the Dockerfile:
-
development (default)
docker build -f Dockerfile . -
staging/production
docker build -f Dockerfile . --build-arg VARIANT=[staging|production] [--build-arg USE_NGINX=[false|true]]The
USE_NGINXvariable indicates if a (basic) Nginx server should be included in the image. The default value isfalse!
Each Iguana docker image can be started with the following command:
docker run -d \
-p 80:8000 \
-v <data_directory>:/files \
-e TZ=<time zone> \
-e PUID=<user ID> \
-e PGID=<group ID> \
<Iguana image ID>| Environment variable | Default value | Description |
|---|---|---|
| TZ | UTC | Set the time zone for the container, e.g. Europe/Berlin |
| PUID | 1000 | The ID of the user running Iguana in the container |
| PGID | 1000 | The group ID of the above user |
But in staging/production environment more configuration should be done by the user! Therefore a settings.json file is placed in the Docker volume after the first run. You can edit this file to your needs (see Configuration section -> settings.json). To apply the changes simply restart the container. Please look especially at the SECRET_KEY and HOST/ALLOWED_HOSTS settings!
If a Nginx server was included in the image (with USE_NGINX=true), the nginx.conf file can also be found on the Docker volume. But for real production environments, a separate Nginx container is recommended!
All files uploaded to Iguana are placed in the media directory on the Docker volume.
TODO: add DockerHub badges and links
TODO: write Ansible instructions
- TODO: write instructions for git integration
- TODO: write instructions for slack integration
These targets can be run with:
make <target> [++option]Note that options have to begin with + or ++ instead of - or --. This is due to a bug that prevents passing options to make targets.
-
help
Prints a short description for each Makefile target. -
production
See subsection Production. -
staging
See subsection Staging. -
development
[+w <webdriver>]
See subsection Development.
-
django
<command> [<args>]
Any command and its arguments gets directly passed to Django'smanage.pyscript. Please have a look at the official Django documentation for a list of supported commands: https://docs.djangoproject.com/en/dev/ref/django-admin/ -
test
[+a <appname>|+f|+c] [+i]
Run the Django unit tests. If an application name is provided with+a, only that app is tested. To run the functional tests use the+foption. If all tests should be run, use option+c. With the option+ithe warnings and errors from imported packages get suppressed. -
run
Run the default django server.
-
setup-virtualenv
This target prepares the virtual python environment in which this project is executed. The packages for the virtual environment are defined in the file production.req or development.req. This depends on which main target you have chosen before. -
css
See section Styling. -
set-webdriver
<webdriver>
This target configures the webdriver for the functional tests. You can replace<webdriver>withchrome,firefoxorsafari. -
requirements
- install
Reinstall all packages in the virtual environment. Which packages are installed depend on what main target you have run in the initialization process. - check
Check whether the used requirements are up to date or not.
- install
-
coverage
[+a <appname>|+f|+c] {report,html,xml,erase}
Run the coverage tool on the Django tests. With argument+aan app for which the coverage should be measured can be specified.+fmeasures the coverage for all functional tests and+cperforms a measurement across all tests. To get a better output you can run one of the following commands:- report
Get the coverage in text form. - html
Get the coverage as a html website. - xml
Get the coverage as a xml file. - erase
Delete the last coverage report.
- report
-
list
- bugs
List all occurrence of the tagTODO BUG. - missing_testcases
List all occurrence of the tagTODO TESTCASE.
- bugs
-
add-license
Insert the license header into all source files. -
new-release
Tag the current commit as a production release.
Currently the style is stored in src/common/scss/iguana/iguana.scss. To build it run
make css. For Selenium tests use StaticLiveServerTestcase instead of
LiveServerTestcase to make sure static files (like css) are served.
Documentation on Sass and SCSS: sass-lang guide
I propose we use SCSS, as it is a superset of CSS and the default Sass syntax. If we change our mind, there are tools to convert between the two syntaxes.
Please use translation hooks in templates (see _base.html for an example)
and code (ugettext as _).
You can create/update the *.po in the locale directory by running make django makemessages +l <lang-code>. The default language is English (code: en). This file is where the actual translations go. It should be checked
in after updating. This uses the GNU gettext toolset.
For new translations to be usable by django, run make django compilemessages.
To see a page in a different language, open it with a different language prefix
in the url. For example /de/login instead of /en/login.
Iguana has a lot of settings that can be changed by the user. The settings files are stored in the src/common/settings package. The package structure is:
common/settings
|- __init__.py
|- common.py
|- global_conf.py
|- local_conf.pyA default init-file gets created by the Makefile target initialize-settings (see section Makefile targets).
For the development process this file can contain additional settings that should not be published in the repository. Mainly the Django-SECRET_KEY = '...' setting is defined here, when the project is in the development environment.
Important: The file must start with the line:
from <site_config> import *You can replace <site_config> with (don't forget the '.'):
.local_conf: the development settings are loaded.global_conf: the production and staging settings are loaded
This file contains the basic settings that are the same for the other two configuration files.
This file should not be changed by the user! It contains basic settings for the Django framework. Changing these settings without knowing what you do could lead to unexpected behaviour.
Basically this file contains all settings that are required to run Iguana in an staging or production environment.
But the settings that should be changed by the user are loaded from the file settings.json. See section settings.json.
This file contains all settings that are required to run Iguana in a development environment.
Normally there's no need to change these settings.
TODO: describe settings.json
For short and long term plans see the official documentation.
For questions and answers please also stick to the official documentation. In case you have any other questions don't hesitate to hit us up.
Iguana was mainly developed with the Django framework (https://www.djangoproject.com).
Iguana is licensed under the BSD-2-Clause license
This work is licensed under a BSD-2-Clause License. Previous versions of this software used to be licensed under CC-BY-SA 4.0, which is not that suitable for source code.
Besides the following plug-ins were used:
