Agile-Diamond¶

Agile-Diamond helps initiate and manage a software development project.

Overview¶

Agile-Diamond contains everything needed to start and control an Agile software project. These files expand into a template with sensible defaults for a small team to start building something. An Agile-Diamond project compiles into PDFs, DOCX, presentations, and a website.

Installation¶

pip install Agile-Diamond

Documentation¶

http://agile-diamond.readthedocs.org

Introduction¶

Quick Start¶

Agile-Diamond contains everything needed to start and control an Agile software project.

Prerequisites¶

See the System Requirements for help installing prerequisites.

Install¶

mkvirtualenv agile-diamond
pip install Agile-Diamond

Scaffold¶

Scaffold into a new directory

mkdir my-agile-project
agile-new.sh software my-agile-project

Use it¶

Edit the files to capture your work and then render a Project document.

make

Flask-Diamond¶

Agile-Diamond is well suited to application development using the Flask-Diamond framework. Flask-Diamond is a batteries-included Flask framework. Easily scaffold a working application with sensible defaults, then override the defaults to customize it for your goals.

System Requirements¶

Agile-Diamond requires some software to be installed in order to function. Once you have installed these requirements, you can follow the Quick Start to start your first project. The following packages should be installed globally, as the superuser, for all users on the system to access.

Python 2.7.x.
Python development libraries (i.e. header files for compiling C code)
pip
virtualenv
virtualenvwrapper

The following sections describe the process for installing these requirements on various systems. In each of the following examples, it is assumed you will be using a root account (or some other privileged account).

If you do not have root access, then refer to the section Unprivileged Installation for information about creating a virtualenv in your user account.

Debian/Ubuntu¶

Agile-Diamond installs cleanly on Debian and Ubuntu systems released after 2011.

apt-get install python python-dev python-pip build-essential
apt-get install sqlite-dev
pip install --upgrade pip
pip install --upgrade virtualenv
pip install virtualenvwrapper

Redhat¶

Agile-Diamond can be installed on RedHat, but ensure your package manager is installing Python 2.7; as of August 2015, RHEL provides an older version.

yum install python python-devel python-pip
yum install sqlite-devel
pip install --upgrade pip
pip install --upgrade virtualenv
pip install virtualenvwrapper

OSX with Homebrew¶

Agile-Diamond installs pretty easily on OSX with Homebrew. Make sure you are using the admin user for this process, just like a normal Homebrew operation.

brew install python --universal --framework
brew install pyenv-virtualenv
brew install pyenv-virtualenvwrapper
brew install sqlite
pip install --upgrade pip

Windows with Cygwin¶

Here are a few resources to get you started:

Note: Have you done this install successfully? Let us know!

Unprivileged Installation¶

Sometimes, you do not have root access to the system. It is still possible to use Agile-Diamond, but the installation process is slightly different because it does not use virtualenvwrapper. Instead, you will create your virtualenv directly and use the activate macro to work on it.

curl -O https://raw.github.com/pypa/virtualenv/master/virtualenv.py
python virtualenv.py my-diamond-app
. my-diamond-app/bin/activate
pip install Agile-Diamond

About¶

Agile-Diamond License¶

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.