<commit_before># Scribe
Automatically create pages and upload images to a conflunce page.


## Setup
1. Copy `settings.py-dist` to `settings.py` and fill out the settings.
2. Run `./scribe.py` to start the server.

<commit_msg>Add more details about how it works<commit_after># Scribe
Automatically create pages and upload images to a conflunce page.

## Setup
1. Copy `settings.py-dist` to `settings.py` and fill out the settings.
2. Run `./scribe.py` to start the server.

## How it works
* Watch a directory for new image files
* Find the Confluence page for the current Sprint based on date
* Find the page for the current day in the sprint(Design Day ?), or create it if it doesn't exist
* Attach the image to the page
* Edit the page to embed the attachment with a thumbnail

### Assumptions
In confluence, it is assumed that you have a master page that holds all of your sprints.  Each sprint is assumed to be 2 weeks long, and starts on a configurable date.

Each sprint will have its own page, named "Sprint #".  Somewhere on this page should be a link to all subpages.

Each day in a sprint will have its own page that contains uploaded images, for example of a design drawn on a whiteboard.  This program than takes those images, and creates the correct pages in Confluence and uploads them.

The hierarchy ends up looking something like this:

    Sprints
    |________Sprint 1
    |        |--------Design Day 1(Monday 1/1/2013)    - Contains uploaded pictures
    |        |--------Design Day 2(Tuesday 1/2/2013)   - Contains uploaded pictures
    |        |--------Design Day 3(Wednesday 1/3/2013) - Contains uploaded pictures
    |________Sprint 2
             |--------Design Day 1(Monday 2/1/2013)
             |--------Design Day 2(Tuesday 2/2/2013)
             |--------Design Day 3(Wednesday 2/3/2013)

{'fraction_non_alphanumeric': 0.08881578947368421, 'fraction_numerical': 0.0268640350877193, 'mean_word_length': 2.882978723404255, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 2, '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': '6827875', 'n_tokens_mistral': 547, 'n_tokens_neox': 489, 'n_words': 259}