setup.py

"""
Insults
---------
TLDR: This project is very similar in functionality and purpose to Google's recent `Perspective API <https://www.perspectiveapi.com/>`_ project

Usage
````````````

Save in a hello.py: ::

    from insults import Insults

    comment = "You are a disgusting maggot of a person."

    Insults.load_model()

    Insults.rate_comment(comment)

> 0.89

Install
`````````````````
With PIP and this command: ::

   $ pip install insults

Links
`````
* `Perspective API website <https://www.perspectiveapi.com/>`_
* `Github Repo: <https://github.com/thundergolfer/Insults>`_


Credit
``````

* `cbrew <https://github.com/cbrew>`_ for their original data-science work in `Imperium's Kaggle Competition <https://www.kaggle.com/c/detecting-insults-in-social-commentary>`_. Code in `cbrew/Insults <https://github.com/cbrew/Insults>`_

"""

import os
from distutils.core import setup
from setuptools import find_packages

def get_pip_dependencies():
    this_dir = os.path.abspath(os.path.dirname(__file__))
    with open(os.path.join(this_dir, 'requirements.txt'), 'r') as pip_requirements:
        package_list = [package for package in pip_requirements]
    return package_list

setup(
  name = 'insults',

  packages = find_packages(exclude=['scripts', 'docs', 'tests*']),

  version = '0.1.12',

  description = 'Identify insulting comments and users on social media',

  long_description=__doc__,

  author = 'Jonathon Belotti',

  author_email = 'jonathon.bel.melbourne@gmail.com',

  url = 'https://github.com/thundergolfer/Insults', # use the URL to the github repo

  download_url = 'https://github.com/thundergolfer/Insult/tarball/0.1', # I'll explain this in a second

  keywords = ['machine-learning', 'social-media', 'community', 'data-science'], # arbitrary keywords


  classifiers = [],


  install_requires = [
        'pyparsing==1.5.6',
        'python-dateutil==2.4.1',
        'pytest==3.0.6',
        'Pytz==2016.7',
        'scikit-learn==0.18.1',
        'scipy==0.18.1',
        'six==1.10.0',
        'pandas==0.19.2',
        'futures==2.2.0',
        'nltk==3.0'
  ],

  # If there are data files included in your packages that need to be
  # installed in site-packages, specify them here.  If using Python 2.6 or less, then these
  # have to be included in MANIFEST.in as well.
  include_package_data=True,

  # relative to the vfclust directory
  package_data={
    'Data/Estimates':
            ['Data/Estimates/estimates.csv'],
        'Data/Final':
            ['Data/Final/README.md',
             'Data/Final/final1.csv',
             'Data/Final/final2.csv',
             'Data/Final/final8.csv',
             'Data/Final/final9.csv',
             'Data/Final/final10.csv'
            ],
        'Data/Inputs':
            ['Data/Inputs/final.csv',
             'Data/Inputs/fulltrain.csv',
             'Data/Inputs/sample_submission_null.csv',
             'Data/Inputs/test.csv',
             'Data/Inputs/test_with_solutions.csv',
             'Data/Inputs/train.csv'
            ],
        'Data/Submissions':
            ['Data/Submissions/submission1.csv',
             'Data/Submissions/submission2.csv',
             'Data/Submissions/submission3.csv'
            ],
        'models':
            ['models/insult_classifier.joblib.pkl']
    }
)

## FOR download_url
# The download_url is a link to a hosted file with your repository's code.
# Github will host this for you, but only if you create a git tag.
# In your repository, type:
# git tag 0.1 -m "Adds a tag so that we can put this on PyPI.".
# Then, type git tag to show a list of tags. you should see 0.1 in the list.
# Type git push --tags origin master to update your code on Github with the latest tag information. Github creates tarballs for download at https://github.com/{username}/{module_name}/tarball/{tag}.