<commit_before># timekeeper package

A short description of your package.

![A screenshot of your spankin' package](https://f.cloud.github.com/assets/69169/2290250/c35d867a-a017-11e3-86be-cd7c5bf3ff9b.gif)
<commit_msg>Updated the README prior to v0.1.0 release<commit_after># Timekeeper

Timekeeper allows you to track time spent on projects, and provides (or rather will provide) ways to view the data in different ways as well as the ability to export and integrate this data with external endpoints.

##### Default Status Bar View

![Timekeeper](https://github.com/skulled/timekeeper/raw/master/docs/assets/images/timekeeper-status-bar-view.png)

##### Active & Tracking Time

![Timekeeper Active](https://github.com/skulled/timekeeper/raw/master/docs/assets/images/timekeeper-status-bar-view-active.png)

##### Paused State

![Timekeeper Paused](https://github.com/skulled/timekeeper/raw/master/docs/assets/images/timekeeper-status-bar-view-paused.png)

As of `v0.1.0`, it can only save the time tracking data but does not provide any convenient ways of viewing or exporting this data yet. This data will subsequently be used for viewing/generating reports as and when those features are available.

> _Although every effort is made to keep things as stable as possible, please do note that the package is under constant development so there might be occasional bugs. If you run across any issues, please [add an issue](https://github.com/skulled/timekeeper/issues/new) with the details._

## Migration from Protons

If you had installed [Protons](https://atom.io/packages/protons) earlier, and were tracking time on projects, this data is **lost permanently** unless you manually wish to copy over the data in to the new package.

The reason behind the loss of data is that the data persistence API has been modified since the package was extracted separately from Protons and it did not make sense to spend a lot of time in trying to migrate the older data in to the newer format.

If you absolutely depend on the data saved by Protons, and will need that data migrated, post an issue and we will try resolve it.

## Installation

### Command Line

```bash
apm install timekeeper
```

### Atom

```
Command Palette ➔ Settings View: Install Packages ➔ Timekeeper
```

## Features

Timekeeper currently supports the core basic functionality of being able to track time spent on projects, and persists this data to its internal data store.

Reposting, external services integration & other features are currently in development and will be released gradually.

### Current Features

- [x] Displays timer in the status bar with the time being tracked, with occasional status messages
- [x] Saves tracked time data (to be used with features currently under development)
- [x] Automatically handle saving of time tracking data from previous session, even if the `Finish` command was not issued manually before exiting from Atom

## Commands

**_Start_**

```
ctrl-alt-s
```

> Starts tracking time on this project
>
> _Issuing this command when time tracking is paused, will continue from where it left off_

**_Pause_**

```
ctrl-alt-p
```

> Pause time tracking temporarily without loosing already tracked time
>
> _Issuing this command when time tracking is paused, will continue from where it left off_

**_Finish_**

```
ctrl-alt-f
```

> Stops tracking time, and saves the tracked time data

**_Reset_**

```
ctrl-alt-r
```

> Discards current tracked time data (not saved), and starts fresh again

**_Abort_**

```
ctrl-alt-a
```

> Stop tracking time, and discard the tracked time up to this point
>
> **Action is permanent and tracked time data will be lost forever prior to save!**

## Feedback & Issues

Any feedback is appreciated!

There are a number of features that are under development, but if there are specific features you would like to see added, please [add an issue](https://github.com/skulled/timekeeper/issues/new) and tag it as "feature".

If you encounter any bugs or cannot get something working, please check the current [open issues](https://github.com/skulled/timekeeper/issues) to see if it has already been raised, before adding a new issue with the problem you are facing.
{'fraction_non_alphanumeric': 0.07917261055634807, 'fraction_numerical': 0.008321445553970519, 'mean_word_length': 4.5795755968169765, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 15, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, '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': '4054772', 'n_tokens_mistral': 1169, 'n_tokens_neox': 1098, 'n_words': 551}