<commit_before># Augury

[![Maintainability](https://api.codeclimate.com/v1/badges/73443845cac0dadff540/maintainability)](https://codeclimate.com/github/claytron/augury/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/73443845cac0dadff540/test_coverage)](https://codeclimate.com/github/claytron/augury/test_coverage)
[![Tests](https://travis-ci.com/claytron/augury.svg?branch=master)](https://travis-ci.com/github/claytron/augury)

Have you ever wanted to turn a twitter account into a fortune file?
Well, today is your lucky day!

<blockquote>
Augury is the practice from ancient Roman religion of<br>
interpreting omens from the observed flight of birds.<br><br>
As per <a href="https://en.wikipedia.org/wiki/Augury">Wikipedia</a>
</blockquote>

There are a lot of really funny twitter accounts out there.
Let's just pick one and get started.

```sh
$ augury generate seinfeldtoday
```

This just created the fortune files in the current directory:

```sh
$ ls
seinfeldtoday seinfeldtoday.dat
```

You can now read the new fortunes!

```sh
$ fortune seinfeldtoday
Elaine has no idea what her BF does for a living and it's now too
late to ask. E:"Teacher, I think. Or a doctor? Wait Is
'computers' a job?"
```

Thanks for all the laughs fortune :)

Here are some accounts that work well with Augury:

- [Modern Seinfeld](https://twitter.com/seinfeldtoday)
- [Very Short Story](https://twitter.com/veryshortstory)
- [<NAME>](https://twitter.com/boredelonmusk)
- Your own feed, so you can get nostalgic.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'augury'
```

And then execute:

```sh
$ bundle
```

Or install it yourself as:

```sh
$ gem install augury
```

### Requirements

This gem requires that the fortune program is also installed.
The fortune program ships with a `strfile` program that converts the plain text files to something that fortune can select from.

For example,
if you are using Homebrew on OS X:

```sh
$ brew install fortune
```

## Configuration

### Augury Config

Create the `~/.augry.cfg` file and then set the permissions since your Twitter API info will be in there.

```sh
$ touch ~/.augury.cfg
$ chmod 600 ~/.augury.cfg
```

Set any of these settings in the `augury` section of the config like this:

```yaml
count: 20
attribution: true
```

### Option list

These are the available options for the `~/.augury.yml` config file.

Option | Description | Default
------ | :---------- | -------
`append` | Make the script add more entries to the specified file instead of re-writing it | `false`
`width` | Set the default width used if none is given on the command line. | `72`
`count` | The number of tweets to get. Set to 0 to get all. | `200`
`retweets` | Include retweets. | `false`
`replies` | Include replies. | `false`
`links` | Include tweets with links in them. | `false`
`attribution` | Add an author attribution to each fortune. | `false`

### Twitter Setup

First, you will need to create a new Twitter application by going here:<commit_msg>fix references to augury config<commit_after># Augury

[![Maintainability](https://api.codeclimate.com/v1/badges/73443845cac0dadff540/maintainability)](https://codeclimate.com/github/claytron/augury/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/73443845cac0dadff540/test_coverage)](https://codeclimate.com/github/claytron/augury/test_coverage)
[![Tests](https://travis-ci.com/claytron/augury.svg?branch=master)](https://travis-ci.com/github/claytron/augury)

Have you ever wanted to turn a twitter account into a fortune file?
Well, today is your lucky day!

<blockquote>
Augury is the practice from ancient Roman religion of<br>
interpreting omens from the observed flight of birds.<br><br>
As per <a href="https://en.wikipedia.org/wiki/Augury">Wikipedia</a>
</blockquote>

There are a lot of really funny twitter accounts out there.
Let's just pick one and get started.

```sh
$ augury generate seinfeldtoday
```

This just created the fortune files in the current directory:

```sh
$ ls
seinfeldtoday seinfeldtoday.dat
```

You can now read the new fortunes!

```sh
$ fortune seinfeldtoday
Elaine has no idea what her BF does for a living and it's now too
late to ask. E:"Teacher, I think. Or a doctor? Wait Is
'computers' a job?"
```

Thanks for all the laughs fortune :)

Here are some accounts that work well with Augury:

- [Modern Seinfeld](https://twitter.com/seinfeldtoday)
- [Very Short Story](https://twitter.com/veryshortstory)
- [<NAME> Musk](https://twitter.com/boredelonmusk)
- Your own feed, so you can get nostalgic.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'augury'
```

And then execute:

```sh
$ bundle
```

Or install it yourself as:

```sh
$ gem install augury
```

### Requirements

This gem requires that the fortune program is also installed.
The fortune program ships with a `strfile` program that converts the plain text files to something that fortune can select from.

For example,
if you are using Homebrew on OS X:

```sh
$ brew install fortune
```

## Configuration

### Augury Config

Create the `~/.augry.yml` file and then set the permissions since your Twitter API info will be in there.

```sh
$ touch ~/.augury.yml
$ chmod 600 ~/.augury.yml
```

Set any of the available settings in the config like this:

```yaml
count: 20
attribution: true
```

### Option list

These are the available options for the `~/.augury.yml` config file.

Option | Description | Default
------ | :---------- | -------
`append` | Make the script add more entries to the specified file instead of re-writing it | `false`
`width` | Set the default width used if none is given on the command line. | `72`
`count` | The number of tweets to get. Set to 0 to get all. | `200`
`retweets` | Include retweets. | `false`
`replies` | Include replies. | `false`
`links` | Include tweets with links in them. | `false`
`attribution` | Add an author attribution to each fortune. | `false`

### Twitter Setup

First, you will need to create a new Twitter application by going here:
{'fraction_non_alphanumeric': 0.11975653890442507, 'fraction_numerical': 0.012173054778746504, 'mean_word_length': 4.291557876414274, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 20, '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': '5571528', 'n_tokens_mistral': 2025, 'n_tokens_neox': 1876, 'n_words': 739}