<commit_before>[![Build Status](http://img.shields.io/travis/theodi/octopub.svg)](https://travis-ci.org/theodi/octopub)
[![Dependency Status](http://img.shields.io/gemnasium/theodi/octopub.svg)](https://gemnasium.com/theodi/octopub)
[![Coverage Status](http://img.shields.io/coveralls/theodi/octopub.svg)](https://coveralls.io/r/theodi/octopub)
[![Code Climate](http://img.shields.io/codeclimate/github/theodi/octopub.svg)](https://codeclimate.com/github/theodi/octopub)
[![License](http://img.shields.io/:license-mit-blue.svg)](http://theodi.mit-license.org)
[![Dependency Status](https://dependencyci.com/github/theodi/octopub/badge)](https://dependencyci.com/github/theodi/octopub)
[![Badges](http://img.shields.io/:badges-7/7-ff6799.svg)](https://github.com/badges/badgerbadgerbadger)

# Octopub

A Rails app that provides a simple and frictionless way for users to publish data on Github.

More information is in the [announcement blog post](http://theodi.org/blog/removing-barriers-to-publishing-open-data).

Live instance is running at [http://octopub.io/](http://octopub.io/)<commit_msg>Updating the readme with set up instructions.<commit_after>[![Build Status](http://img.shields.io/travis/theodi/octopub.svg)](https://travis-ci.org/theodi/octopub)
[![Dependency Status](http://img.shields.io/gemnasium/theodi/octopub.svg)](https://gemnasium.com/theodi/octopub)
[![Coverage Status](http://img.shields.io/coveralls/theodi/octopub.svg)](https://coveralls.io/r/theodi/octopub)
[![Code Climate](http://img.shields.io/codeclimate/github/theodi/octopub.svg)](https://codeclimate.com/github/theodi/octopub)
[![License](http://img.shields.io/:license-mit-blue.svg)](http://theodi.mit-license.org)
[![Dependency Status](https://dependencyci.com/github/theodi/octopub/badge)](https://dependencyci.com/github/theodi/octopub)
[![Badges](http://img.shields.io/:badges-7/7-ff6799.svg)](https://github.com/badges/badgerbadgerbadger)

# Octopub

A Rails app that provides a simple and frictionless way for users to publish data on Github.

More information is in the [announcement blog post](http://theodi.org/blog/removing-barriers-to-publishing-open-data).

Live instance is running at [http://octopub.io/](http://octopub.io/)

## Development

Checkout the repository and run ```bundle``` in the checked out directory.
The application uses sidekiq for managing the background proccessing of data uploads. To use this functionality, install ```redis``` either by following the [instructions](https://redis.io/topics/quickstart) or if on macOS and using homebrew, run ```brew install redis``` and start a redis instance running with ```redis-server```.

## Tests

Octopub uses the ```rspec``` test framework and the test suite can be run with the usual ```bundle exec rspec```

## Deployment

A commit to master will trigger a TravisCI run, which, if successful, will automatically deploy to Heroku.
{'fraction_non_alphanumeric': 0.16695471828551675, 'fraction_numerical': 0.00414794331144141, 'mean_word_length': 5.47427293064877, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 15, 'lorem ipsum': 0, 'www.': 0, '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': '1105860', 'n_tokens_mistral': 1009, 'n_tokens_neox': 974, 'n_words': 185}