<commit_before>Timestrap
=========

[![Build Status](https://travis-ci.org/overshard/timestrap.svg?branch=master)](https://travis-ci.org/overshard/timestrap) [![Coverage Status](https://coveralls.io/repos/github/overshard/timestrap/badge.svg?branch=master)](https://coveralls.io/github/overshard/timestrap?branch=master)

Time tracking and invoicing you can host anywhere. Full export support in
multiple formats and easily extensible.


Quickstart
----------

Want to get up and running quickly?

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/overshard/timestrap)

We create a default username and password with superuser access to get you
started, please change it via the admin panel:

 + Username: `admin`
 + Password: `<PASSWORD>`


Example Website
---------------

I've setup an [instance on Heroku](https://timestrap.herokuapp.com/) of
Timestrap that resets every 10 minutes if you want to play with it. The
username and password are set to the same as the Quickstart ones. If someone
messes up the fun for everyone wait till the next reset or set the project up
yourself.


Installation
------------

Your system needs to have Python with virtualenv and pip installed.

    virtualenv .venv
    source .venv/bin/activate
    pip install -r requirements.txt


Testing
-------

I'm trying to push for 100% code coverage on this project! If you want to add
or change something and test that everything still works you can do so easily
with:

    python manage.py test

If you push code to our primary repository we test for style adherance and code
coverage. If you get a failed build to either of these we won't accept your
code till it's fixed.


Running Timestrap
-----------------

Always make sure you are in the virtual environment before running additional
commands by first running `source .venv/bin/activate`. If you have already done
this from the previous step and have not left the environment continue on!

If you have not yet migrated your database do so by running:

    python manage.py migrate

After this you can run Timestrap and access it from your browser at
`localhost:8000`.

    python manage.py runserver


Generate Fake Data
------------------

Want to see how Timestrap would look after being used a while? Run `fake` to
generate some data. Don't run this on a production database or you'll have to
do a lot of clean up.

    python manage.py fake


Screenshots
-----------

![Entries](https://raw.githubusercontent.com/overshard/timestrap/master/screenshots/entries.png)
![Dashboard](https://raw.githubusercontent.com/overshard/timestrap/master/screenshots/dashboard.png)
<commit_msg>Comment on creating a starting user<commit_after>Timestrap
=========

[![Build Status](https://travis-ci.org/overshard/timestrap.svg?branch=master)](https://travis-ci.org/overshard/timestrap) [![Coverage Status](https://coveralls.io/repos/github/overshard/timestrap/badge.svg?branch=master)](https://coveralls.io/github/overshard/timestrap?branch=master)

Time tracking and invoicing you can host anywhere. Full export support in
multiple formats and easily extensible.


Quickstart
----------

Want to get up and running quickly?

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/overshard/timestrap)

We create a default username and password with superuser access to get you
started, please change it via the admin panel:

 + Username: `admin`
 + Password: `<PASSWORD>`


Example Website
---------------

I've setup an [instance on Heroku](https://timestrap.herokuapp.com/) of
Timestrap that resets every 10 minutes if you want to play with it. The
username and password are set to the same as the Quickstart ones. If someone
messes up the fun for everyone wait till the next reset or set the project up
yourself.


Installation
------------

Your system needs to have Python with virtualenv and pip installed.

    virtualenv .venv
    source .venv/bin/activate
    pip install -r requirements.txt


Testing
-------

I'm trying to push for 100% code coverage on this project! If you want to add
or change something and test that everything still works you can do so easily
with:

    python manage.py test

If you push code to our primary repository we test for style adherance and code
coverage. If you get a failed build to either of these we won't accept your
code till it's fixed.


Running Timestrap
-----------------

Always make sure you are in the virtual environment before running additional
commands by first running `source .venv/bin/activate`. If you have already done
this from the previous step and have not left the environment continue on!

If you have not yet migrated your database do so by running:

    python manage.py migrate

You'll need to create your first user too:

    python manage.py createsuperuser

After this you can run Timestrap and access it from your browser at
`localhost:8000`.

    python manage.py runserver


Generate Fake Data
------------------

Want to see how Timestrap would look after being used a while? Run `fake` to
generate some data. Don't run this on a production database or you'll have to
do a lot of clean up.

    python manage.py fake


Screenshots
-----------

![Entries](https://raw.githubusercontent.com/overshard/timestrap/master/screenshots/entries.png)
![Dashboard](https://raw.githubusercontent.com/overshard/timestrap/master/screenshots/dashboard.png)

{'fraction_non_alphanumeric': 0.10552304316020483, 'fraction_numerical': 0.0032918800292611556, 'mean_word_length': 3.6903945111492282, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 20, 'lorem ipsum': 0, 'www.': 2, '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': '155471', 'n_tokens_mistral': 1581, 'n_tokens_neox': 1474, 'n_words': 642}