Merge pull request #1 from prosegrinder/init

Initial Release v0.1.0

Author: davidlday

.editorconfig

@@ -0,0 +1,15 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+charset = utf-8
+
+# Docstrings and comments use max_line_length = 79
+[*.py]
+indent_size = 4

.gitignore

@@ -45,6 +45,7 @@ nosetests.xml
 coverage.xml
 *.cover
 .hypothesis/
+.pytest_cache/
 
 # Translations
 *.mo

.travis.yml

@@ -0,0 +1,25 @@
+language: python
+python:
+- pypy3
+- pypy
+- '3.6'
+- '3.5'
+- '3.4'
+- '2.7'
+sudo: false
+install:
+- pip install -U pip
+- pip install -U pytest
+script:
+- python ./setup.py develop
+- pytest tests/*
+deploy:
+  provider: pypi
+  user: davidlday
+  python: '3.6'
+  password:
+    secure: 3/zLhV44lkbEuyT14Y4zFd65ywUwKMWeGqr5Yi8DTzYKYTlCTf/W1Qhm2/WfaYEiFQPyyAbjrf9cAGtSj70lo0xdkjXTteJnY7jtchEh7kcawJDdmuMxa9x2QhhJ2C4p5rl6ec3iBZwxGU6yox4woG9aSAC7D6x/KDPw4qSdb1aXq50WT+ePgBYMkenKdLNX5O/9+MD5nUI7tCbcatKyP2erWK86RbiVO7iOFAUG/g8fJ3OIp2Y+XFqDzLT4AlQBalLI3CQJAKjiVfUEK7SH60sHTkFtFp9MQBnvVWHcElsF4wW7VN9rbgqV0vbPG0wWwgaA04Sea1QOq5JLV2TJ3k1V0dRQQcRNuF+cqXw3bsBitqVnEUuZt+iphi+xeFXEkrY3rZXqcftlxZeF0u4966s3FpvkAK6zjR6zxtH6S2af8at3esoFOZ59j2Rt4+cgrKYfjQnzCsIDcP6+b9NVkLMcNyzy5/syhn3+TjhPcDs8G38IAfguAfIYgH/uZSbO/6fHCTI49mTpA6fFpIeauGTiiqyOJmwulQ/rQncOpmsDlbyLVMIef+AS8Stt2Om0HSSljdMfx+VX2vzwZLbIIOcf8mnPD3yP04FEI9KUUNN5OzQBNh2GaCJfhTcslmaMEN196KWyAaZx0paQzq0IylB6RqVeLY57a1S/1VLzxAk=
+  distributions: sdist bdist_wheel
+  on:
+    tags: true
+

MANIFEST.in

@@ -0,0 +1,8 @@
+include MANIFEST.in
+include README.rst
+include LICENSE
+graft narrative
+graft tests
+global-exclude .git
+global-exclude __pycache__
+global-exclude *.py[co] .DS_Store

README.md

@@ -0,0 +1,64 @@
+narrative
+===========
+
+.. image:: https://img.shields.io/pypi/v/narrative.svg
+    :target: https://pypi.python.org/pypi/narrative
+    :alt: Latest PyPI version
+
+.. image:: https://travis-ci.org/prosegrinder/python-narrative.svg?branch=master
+    :target: https://travis-ci.org/prosegrinder/python-narrative
+    :alt: Latest Travis CI build status
+
+.. image:: https://api.codacy.com/project/badge/Grade/199d8dcecc4345249c704325bec9cf7c
+    :target: https://www.codacy.com/app/ProseGrinder/python-narrative?utm_source=github.com&utm_medium=referral&utm_content=prosegrinder/python-narrative&utm_campaign=Badge_Grade
+    :alt: Latest Codacy Coverage Report
+
+A Python small package for splitting text into dialogue and narrative.
+
+Installation
+------------
+
+``narrative`` is available on PyPI. Simply install it with ``pip``::
+
+    $ pip install narrative
+
+You can also install it from source::
+
+    $ git clone https://github.com/prosegrinder/python-narrative.git
+    Cloning into 'python-narrative'...
+    ...
+
+    $ cd python-narrative
+    $ python setup.py install
+    ...
+
+Usage
+-----
+
+``narrative`` splits a piece of prose into narrative and dialogue components. The main function ``split()`` will return a dict containing both ``narrative`` and ``dialogue`` components::
+
+    >>> import narrative
+    >>> text = '"Hello," he said. "How are you today?"'
+    >>> narrative.split(text)
+    {'dialogue': ['"Hello,"', '"How are you today?"'], 'narrative': ['', ' he said. ', '']}
+
+There are two other helper functions as well.
+
+``get_dialogue()`` returns only the dialogue components::
+
+    >>> narrative.get_dialogue(text)
+    ['"Hello,"', '"How are you today?"']
+
+``get_narrative()`` returns a dict containing all first, second, and third person pov words::
+
+    >>> narrative.get_dialogue(text)
+    ['', ' he said. ', '']
+
+Note: The empty strings are a feature of Python's ``split()`` function. See `Why are empty strings returned in split() results?`_ for an explanation.
+
+Authors
+-------
+
+``narrative`` was written by `David L. Day <[email protected]>`_.
+
+.. _`Why are empty strings returned in split() results?`: https://stackoverflow.com/questions/2197451/why-are-empty-strings-returned-in-split-results#2197493

README.rst

@@ -0,0 +1 @@
+0.1.0

narrative/VERSION

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+"""narrative - A Python small package for splitting text into dialogue and narrative."""
+
+import re
+
+import pkg_resources
+
+__version__ = pkg_resources.resource_string(
+    'narrative', 'VERSION').decode('utf-8').strip()
+
+# NOTE: Smart quotes are error prone. I recommend converting
+# them to regular quotes first.
+#
+# RegEx developed from following reference
+# http://www.rubular.com/r/mP6IRzteSm
+# http://pythex.org/
+# http://www.metaltoad.com/blog/regex-quoted-string-escapable-quotes
+# DIALOGUE_RE = r'[\"“]((?:.(?![\"“]))*.?)[\"”\\n]'
+DIALOGUE_RE = re.compile(r'[\"“](?:.(?![\"“]))*.?[\"”\\n]', re.MULTILINE)
+
+
+def get_dialogue(text, dialogue_regex=DIALOGUE_RE):
+    dialogue = dialogue_regex.findall(text)
+    return dialogue
+
+
+def get_narrative(text, dialogue_regex=DIALOGUE_RE):
+    narrative = dialogue_regex.split(text)
+    return narrative
+
+
+def split(text, dialogue_regex=DIALOGUE_RE):
+    dialogue = get_dialogue(text, dialogue_regex)
+    narrative = get_narrative(text, dialogue_regex)
+    return {"dialogue": dialogue, "narrative": narrative}

narrative/__init__.py

@@ -0,0 +1,5 @@
+[bdist_wheel]
+universal = 1
+
+[metadata]
+license_file = LICENSE

setup.cfg

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+
+from os import path
+
+from setuptools import setup
+
+# Version
+with open(path.join(path.dirname(__file__), 'narrative', 'VERSION')) as version_file:
+    VERSION = version_file.read().strip()
+# Long Description
+with open(path.join(path.dirname(__file__), 'README.rst')) as readme_file:
+    LONG_DESCRIPTION = readme_file.read()
+
+
+setup(
+    name="narrative",
+    version=VERSION,
+    url="https://github.com/prosegrinder/python-narrative",
+
+    author="David L. Day",
+    author_email="[email protected]",
+
+    description="A Python small package for splitting text into dialogue and narrative.",
+    long_description=LONG_DESCRIPTION,
+
+    packages=[
+        'narrative'
+    ],
+    package_dir={'narrative': 'narrative'},
+    package_data={
+        '': ['LICENSE', '*.rst', 'MANIFEST.in'],
+    },
+    include_package_data=True,
+
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+        'Natural Language :: English',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+    ],
+)