<commit_before># Index Card Generator for AgileZen

A quick and - yes - dirty hook towards [AgileZen](http://www.agilezen.com) to extract stories from a specified project generating index cards with story contents.

## Installation

Fire up your favourite command line tool and run following commands:

1. Clone the repository (i.e. `git clone ...`)
2. Run `npm install`
3. Run `npm start`
4. Voilá!

## Requirements

1. Node.js is mandatory for this to even work and you'll need to have an account at [AgileZen](http://www.agilezen.com).
2. You'll need to get an API key from AgileZen to be able to make requests to your projects.
3. You'll need a project id (int) wich you can retrieve from the URL of the project in AgileZen.

## Recognitions

This tool is inspired by the [Index card generator](http://blog.crisp.se/2007/12/18/henrikkniberg/1197973740000).<commit_msg>Updated installation section in readme.md<commit_after># Index Card Generator for AgileZen

A quick and - yes - dirty hook towards [AgileZen](http://www.agilezen.com) to extract stories from a specified project generating index cards with story contents.

## Installation

1. Clone the repository (i.e. `git clone ...`)
2. Configure config.js with project id and API-key
2. Run `npm install` in your favourite command line tool
3. Run `npm start` in the same favourite command line tool
4. Voilá!

## Requirements

1. Node.js is mandatory for this to even work and you'll need to have an account at [AgileZen](http://www.agilezen.com).
2. You'll need to get an API key from AgileZen to be able to make requests to your projects.
3. You'll need a project id (int) wich you can retrieve from the URL of the project in AgileZen.

## Recognitions

This tool is inspired by the [Index card generator](http://blog.crisp.se/2007/12/18/henrikkniberg/1197973740000).
{'fraction_non_alphanumeric': 0.08583925642427556, 'fraction_numerical': 0.03116457080371788, 'mean_word_length': 4.027472527472527, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4343681', 'n_tokens_mistral': 590, 'n_tokens_neox': 549, 'n_words': 259}