Welcome to the REDmineMANager (redman) tool page.
This tool can save some of your time when doing repetitive actions such as copying stories and tasks from one sprint to a new one.
The target user-base for the redman tool is anybody using redmine in combination with the redmine backlogs plugin.
Currently there is no pip package for the redman tool, so please install python-dev packages before proceeding with the application installation.
sudo apt-get install python-dev
The redman tool was tested with python 2.7 only. Please create a virtual environment for python 2.7 if your computer setup uses python 3 by default. For more instructions on how to use virtual environments please got to https://virtualenv.pypa.io/en/latest/.
pip install virtualenv
Create a virtual environment and activate it, then install the python requirements:
git clone [email protected]:ctsit/redman.git
cd redman
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
- Create one or more template sprints in Redmine using the web interface.
Note: In the next steps we will assume that you already created a sprint
called TEMPLATE_SPRINT_GREEN and we will use it to run our tool.
-
Create the fabric.py file in which we configure the tool:
cp sample.fabric.py production/fabric.py
-
Edit the production/fabric.py file lines which contain information about redmine:
api_url: https://your_redmine_url.com api_key: some_long_string_you_can_get_from_my_account_page_under_api_access_key (see the screenshots section below) sprint_name_green: 'TEMPLATE_SPRINT_GREEN'
-
Run the redman tool:
fab production copy_sprint_template_green or make prod_green
Note: If you receive an error like
No need to copy the sprint since days passed [22] is not a multiple of [14]
specified in the `fabric.py` config file.
then please update the repeat_after parameter in the production/fabric.py
config file to match the value 22. The reason for this error is that
redman is configured to be run automatically every X days from a specific date
(in our case on day 14, 28, 42... and so on).
Obtaining the Redmine API access key:
An example of session using the redman tool:
The application was written by Andrei Sura with tremendous support and feedback from the entire CTS-IT team.