<commit_before># Starbot - An Open-Source Discord Bot [![Build Status](https://travis-ci.org/StarbotDiscord/Starbot.svg?branch=master)](https://travis-ci.org/StarbotDiscord/Starbot) [![Doc Status](https://readthedocs.org/projects/starbot/badge/?version=latest)](http://starbot.readthedocs.io/en/latest/)

## Project Overview

Welcome to the Starbot project! This project is intended as a complete overhaul of [CorpNewt's CorpBot.py](https://github.com/corpnewt/CorpBot.py) project. The bot includes many features, silly and useful. A list of commands will be posted soon(tm), since the bot is under very active development.

## Why should I use this bot?

Most people probably won't find the bot too useful in it's current state. It's in the very early stages and is composed of mostly developer and debug commands. Your welcome to run it if you'd like a toy to mess with though.

## I've encountered an issue!

If you've found a problem with Starbot, please report it to the [JIRA](https://sydstudios.atlassian.net/projects/SB/issues/?filter=allopenissues) - it's free to make an account and helps us keep track of the problems in the bot!

## How can I contribute?

### Documentation

[You may read the docs here](http://starbot.readthedocs.io/en/latest/)

### Making plugins

This is very easy! Go ahead and [take the template and hack it up to your hearts content.](http://starbot.readthedocs.io/en/latest/getstarted.html#a-basic-plugin-text-manipulation) This can be in your own repo, no need to clone the bot. Third party plugins are welcomed, and the bot doesn't need any modifications to run them. Plugins would go into the `plugins` folder.

### Working on the core

If your feeling particularly adventurous you may find working on the core of the bot appealing. This would include all the very core features and APIs. Start by looking through the [JIRA](https://sydstudios.atlassian.net/projects/SB/issues/?filter=allopenissues) for open issues and reading through the [documentation](http://starbot.readthedocs.io/en/latest/).

## Installing and running Starbot

_There may be a build of the [StarBot Runtime](https://github.com/StarbotDiscord/BuildScript) available that works on your system if you're feeling adventurous._

1. Make sure you have Python 3.5 or 3.6 installed, as well as git

2. Run `pip install discord.py pluginbase psutil pyparsing pyspeedtest tqdm` in a terminal session to install the dependancies

3. Run `git clone https://github.com/1byte2bytes/Starbot.git` to copy the code to your local system

4. Run `echo [my token here] > token.txt` to create a file for the bots token

5. Run `./run.sh` to run the bot!
<commit_msg>Entirely new README<commit_after># ![StarIcon](https://68.media.tumblr.com/avatar_129c75279689_128.png) Starbot - an open source Discord bot

![TravisIcon](https://avatars.githubusercontent.com/u/6227399?size=100)|![ReadthedocsIcon](https://avatars2.githubusercontent.com/u/366329?v=3&s=100)|![JiraIcon](https://www.clearvision-cm.com/wp-content/themes/clearvision_v3/img/menu/atlassian.png)
:-----:|:-----:|:-----:
[![Build Status](https://travis-ci.org/StarbotDiscord/Starbot.svg?branch=master)](https://travis-ci.org/StarbotDiscord/Starbot)|[![Doc Status](https://readthedocs.org/projects/starbot/badge/?version=latest)](http://starbot.readthedocs.io/en/latest/)|[Jira Tracker](https://sydstudios.atlassian.net/projects/SB/issues/)

## About Starbot
Starbot is a plugin based bot for Discord. You should never have to edit the core of the bot or other plugins to add your awesome features! Due to the nature of the plugin system you can choose exactly what features the bot has.

## How to install Starbot
Installing Starbot is pretty simple.

1. Use your package manager (or otherwise obtain) a copy of Python >=3.5, Git and Pip for Python 3
2. `git clone https://github.com/1byte2bytes/Starbot.git`
3. `pip install discord.py pluginbase psutil pyparsing pyspeedtest tqdm`
4. Git a bot token from the [Discord Developers page](https://discordapp.com/developers/applications/me)
5. Paste the token for the bot user into a file called `token.txt` in the folder with the bots code
6. `./run.sh` to start the bot!

## I'd like to contribute!
Contributing to Starbot is always welcome and pretty simple.
If you encounter a bug, have a suggestion, etc then visit the Jira tracker using the link above and write out a ticket.
If you want to write a plugin, check out the documentation above.
If you'd like to contribute to the core of the bot or have your plugin merged into the main bot, create a fork on GitHub and then pull request when you've made your changes.
{'fraction_non_alphanumeric': 0.10173160173160173, 'fraction_numerical': 0.012987012987012988, 'mean_word_length': 4.594430992736077, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 18, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5022629', 'n_tokens_mistral': 1436, 'n_tokens_neox': 1361, 'n_words': 555}