RedSample

RedSample aims at trying to make sample management using the the popular Redmine project management software.

The idea is to try and keep all samples within a single project inside of a Redmine instance. Each sample being represented as an Issue within redmine.

Since Redmine is highly configurable in that you can easily create custom fields for almost any resource it makes it a comfy home to put your sample data.

RedSample utilizes the very useful python-redmine project and thus most functionality you find in python-redmine should work with RedSample.

Contents:

Installation

Installation is quite simple at this point

Setup Redmine Configuration

  1. Copy redsample.config.example to ~/.redsample.config

    You will edit this as we go filling in the variables with values from your redmine installation.

  2. Create a new project in Redmine that will host your sample issues

    Remember the Identifier you choose for later For this tutorial, we will assume the Identifier you pick is samples

  3. Create a new tracker in Redmine to assign to all of your samples

    Make sure to assign it to the project you created above

  4. You will then need to get the tracker’s id you created manually by

    selecting it from the Trackers menu and looking at the url The id is the number in the url that should look like the following:

    https://yourredmine.com/trackers/1/edit

    Here the number 1 is the tracker id you will need for later

  5. Head over to the My account link inside of Redmine and get your API access key

  6. Edit your ~/.redsample.config and replace the variables with your information

Install Project

git clone https://github.com/necrolyte2/redsample
cd redsample
python setup.py install

Configuration

Configuration is based on your redmine api key as well as a few other variables all within your local .redsample.config inside your home directory.

redsample.config

The redsample.config is simply a yaml formatted file. There is an example file you can copy to your home directory as follows

cp redsample.config.example ~/.redsample.config

Then you can edit that file and change the variables to reflect your setup

Samples

Indices and tables