<commit_before>#Sprintly-GitHub

[Sprint.ly](http://sprint.ly/ 'Sprint.ly') is a great tool for managing work items; [GitHub](http://github.com 'GitHub') is a great tool for managing your code. The tools in this repository will help you take advantage of the integration with GitHub that Sprint.ly offers without drawing your attention away from the terminal. Use the `sprintly` command line tool to get a list of all items assigned to you. Install the `commit-msg` hook to facilitate Sprint.ly's GitHub integration.

#How to use `sprintly`

	Usage: sprintly [options]

	By default, your sprintly items will be shown.

	Options:
	  -h, --help        show this help message and exit
	  --install         install this tool
	  --update          update this tool
	  --install-hook    install commit-msg hook in current directory (must be a
						git repository)
	  --uninstall-hook  uninstall commit-msg hook in current directory (must be a
						git repository)
	  --update-config   edit configuration

#Installing `sprintly`

The `sprintly` tool can now install itself. Follow the instructions below to get started:

	# download the latest version of the tool
	git clone https://github.com/nextbigsoundinc/Sprintly-GitHub.git

	# change to the repo directory
	cd Sprintly-GitHub

	# install
	sudo python sprintly --install

	# clean up
	cd ../
    sudo rm -R Sprintly-Github

Once the installation is complete, run `sprintly` from any directory to get started. If you have never used the tool before, it will walk you through adding your Sprint.ly credentials:

	$ sprintly
	Creating config...
	Enter sprint.ly username (email): <EMAIL>
	Enter sprint.ly API Key: 3536bae19bacd16831fb5100b13e34d2
	Enter default sprint.ly product id (117 - Company, 129 - Secret): 117
	Configuration successfully created.

*Note: (1) your Sprint.ly API Key can be found [here](https://sprint.ly/account/profile/). (2) you will only be asked to enter a sprint.ly product id if you have more than one product.*

To update `sprintly`, type `sudo sprintly --update`. When updating, you will see a warning:

	$ sudo sprintly --update<commit_msg>Updating README to include curl and git install.<commit_after>#Sprintly-GitHub

[Sprint.ly](http://sprint.ly/ 'Sprint.ly') is a great tool for managing work items; [GitHub](http://github.com 'GitHub') is a great tool for managing your code. The tools in this repository will help you take advantage of the integration with GitHub that Sprint.ly offers without drawing your attention away from the terminal. Use the `sprintly` command line tool to get a list of all items assigned to you. Install the `commit-msg` hook to facilitate Sprint.ly's GitHub integration.

#How to use `sprintly`

	Usage: sprintly [options]

	By default, your sprintly items will be shown.

	Options:
	  -h, --help        show this help message and exit
	  --install         install this tool
	  --update          update this tool
	  --install-hook    install commit-msg hook in current directory (must be a
						git repository)
	  --uninstall-hook  uninstall commit-msg hook in current directory (must be a
						git repository)
	  --update-config   edit configuration

#Installing `sprintly`

The `sprintly` tool can now install itself. Follow the instructions below to get started:

Install with Curl

```bash
# download the latest version of the tool
curl -L -O https://raw.githubusercontent.com/sprintly/Sprintly-GitHub/master/sprintly

# install
sudo python sprintly --install

# clean up
rm sprintly
```

Install with Git

```bash
# download the latest version of the tool
git clone https://github.com/nextbigsoundinc/Sprintly-GitHub.git

# change to the repo directory
cd Sprintly-GitHub

# install
sudo python sprintly --install

# clean up
cd ../
sudo rm -R Sprintly-Github
```

Once the installation is complete, run `sprintly` from any directory to get started. If you have never used the tool before, it will walk you through adding your Sprint.ly credentials:

	$ sprintly
	Creating config...
	Enter sprint.ly username (email): <EMAIL>
	Enter sprint.ly API Key: 3536bae19bacd16831fb5100b13e34d2
	Enter default sprint.ly product id (117 - Company, 129 - Secret): 117
	Configuration successfully created.

*Note: (1) your Sprint.ly API Key can be found [here](https://sprint.ly/account/profile/). (2) you will only be asked to enter a sprint.ly product id if you have more than one product.*

To update `sprintly`, type `sudo sprintly --update`. When updating, you will see a warning:

	$ sudo sprintly --update
{'fraction_non_alphanumeric': 0.07833591502544811, 'fraction_numerical': 0.013719849524231024, 'mean_word_length': 3.6502057613168724, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 5, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 3, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1709293', 'n_tokens_mistral': 1385, 'n_tokens_neox': 1251, 'n_words': 590}