Setting up a local development environment¶
Get source code¶
The Kiwi TCMS source code is available at: https://github.com/kiwitcms/Kiwi:
git clone https://github.com/kiwitcms/Kiwi.git
Install Python 3¶
Kiwi TCMS is a Python 3 project! On CentOS 7 this is available via SoftwareCollections.org. All further instructions assume that you have Python 3 enabled. If you are using software collections then execute:
scl enable rh-python36 /bin/bash
If you are using a different Linux distribution then consult its documentation for more details on how to install and enable Python 3!
Note
At the time of writing Kiwi TCMS has been tested with Python 3.6. You can always consult
Dockerfile to find out the latest version which we use!
Dependencies¶
First install RPM packages which are needed to compile some of the Python dependencies:
sudo yum install gcc python-devel mysql-devel libxml2-devel libxslt-devel graphviz
Note
Graphviz is only used to build model diagrams from source code!
Then install dependencies for development:
. ~/virtualenvs/kiwi/bin/activate
pip install -r requirements/mysql.txt
pip install -r requirements/devel.txt
Note
Alternatively you can use requirements/postgres.txt for PostgreSQL!
The user interface needs the PatternFly library so:
npm install
inside the project directory.
Initialize database¶
Note
In development mode Kiwi TCMS is configured to use SQLite!
You may want to adjust the database and/or other configuration settings.
Override them in ./tcms/settings/devel.py if necessary.
Warning
At the moment Kiwi TCMS is not 100% portable between database backends! We recommend either MySQL or MariaDB for running Kiwi TCMS!
Load database schema and create initial user:
./manage.py migrate
./manage.py createsuperuser
Let’s run Kiwi TCMS¶
You’re now ready to start the server:
./manage.py runserver
Now, open http://127.0.0.1:8000/ and should be presented with your brand new Kiwi TCMS homepage!