Feature/british (#9)

* ignore tests

* added british dialogue regex

* added tests for british dialogue

* added actions

* removed 2.7, 3.6, and added 3.10

* reordered job dependencies

* auto approved dependabot and davidlday

* updated readme for british style

* v1.1.0

* splitting out jobs

* reuse community workflow

* maybe just in workflows?

* nope

* try from a different repo

* spelling matters

* moved python-lint to community health repo

* use reusables

* use community testpub and pub

* reusable autoapprove

Author: davidlday

.github/dependabot.yml

@@ -1,12 +1,18 @@
 version: 2
 updates:
-- package-ecosystem: pip
-  directory: "/"
-  schedule:
-    interval: weekly
-    day: friday
-    time: "17:00"
-    timezone: America/New_York
-  open-pull-requests-limit: 10
-  reviewers:
-  - davidlday
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: monthly
+      timezone: America/New_York
+    open-pull-requests-limit: 10
+    reviewers:
+      - davidlday
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: monthly
+      timezone: America/New_York
+    open-pull-requests-limit: 10
+    reviewers:
+      - davidlday

.github/workflows/dependabot-autoapprove.yaml

@@ -0,0 +1,9 @@
+name: Dependabot auto-approve
+on: pull_request
+
+permissions:
+  pull-requests: write
+
+jobs:
+  dependabot:
+    uses: prosegrinder/.github/.github/workflows/dependabot-autoapprove.yaml@main

.github/workflows/pypi-publish.yml

@@ -5,23 +5,5 @@ on:
     types: [created]
 
 jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.x"
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install setuptools wheel twine build
-      - name: Build Dists
-        run: |
-          python -m build
-      - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}
+  python-publish:
+    uses: prosegrinder/.github/.github/workflows/python-publish.yaml@main

.github/workflows/pypi-test-publish.yml

@@ -6,24 +6,5 @@ on:
       - "v*"
 
 jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.x"
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install setuptools wheel twine build
-      - name: Build Dists
-        run: |
-          python -m build
-      - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          user: __token__
-          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
-          repository_url: https://test.pypi.org/legacy/
+  python-test-publish:
+    uses: prosegrinder/.github/.github/workflows/python-test-publish.yaml@main

.github/workflows/python-ci.yml

@@ -1,59 +1,21 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-
 name: Python CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check Out
-        uses: actions/checkout@v2
-      - name: Black
-        uses: psf/black@stable
-      - name: Pylint
-        uses: cclauss/GitHub-Action-for-pylint@0.7.0
-        with:
-          args: pip install .; pylint src/**/*.py
+    uses: prosegrinder/.github/.github/workflows/python-lint.yaml@main
 
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [2.7, 3.6, 3.7, 3.8, 3.9]
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-      - name: Install module
-        run: |
-          pip install -e .
-      - name: Test with pytest
-        run: |
-          pip install pytest
-          pytest
+  check-build:
+    uses: prosegrinder/.github/.github/workflows/python-check-build.yaml@main
+    needs: lint
 
-  check_build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check Out
-        uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.x"
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install setuptools wheel twine build
-      - name: Build
-        run: python -m build
-      - name: Check
-        run: twine check dist/*
+  test:
+    uses: prosegrinder/.github/.github/workflows/python-test.yaml@main
+    needs: check-build

.pylintrc

@@ -14,7 +14,7 @@ ignore=CVS
 
 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.
-ignore-patterns=
+ignore-patterns=test_
 
 # Python code to execute, usually for sys.path manipulation such as
 # pygtk.require().

README.md

@@ -27,9 +27,9 @@ $ 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:
+`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:
 
 ```python
 >>> import narrative
@@ -50,11 +50,29 @@ There are two other helper functions as well.
 `get_narrative()` returns only the narrative components:
 
 ```python
->>> narrative.get_dialogue(text)
+>>> narrative.get_narrative(text)
 ['', ' he said. ', '']
 ```
 
-Note: The empty strings are a feature of Python's `split()` function.
-See [Why are empty strings returned in split()
-results?](https://stackoverflow.com/questions/2197451/why-are-empty-strings-returned-in-split-results#2197493)
+Note: The empty strings are a feature of Python's `split()` function. See
+[Why are empty strings returned in split() results?](https://stackoverflow.com/questions/2197451/why-are-empty-strings-returned-in-split-results#2197493)
 for an explanation.
+
+### British Style
+
+Each function accepts a second parameter of a regular expression used to parse
+out the dialogue. This defaults to `narrative.DIALOGUE_RE`, which follows the
+American standard of using double quotes for initial quotes. `narrative` now
+includes a second regular expression, `narrative.BRITISH_DIALOGUE_RE`, which
+follows the British style of using single quotes for initial quotes. Simply use
+it as the second parameter for any function:
+
+```python
+>>> import narrative
+>>> narrative.split(text, narrative.BRITISH_DIALOGUE_RE)
+>>> …
+>>> narrative.get_dialogue(text, narrative.BRITISH_DIALOGUE_RE)
+>>> …
+>>> narrative.get_narrative(text, narrative.BRITISH_DIALOGUE_RE)
+>>> …
+```

src/narrative/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

src/narrative/__init__.py

@@ -23,6 +23,8 @@
 # DIALOGUE_RE = r'[\"“]((?:.(?![\"“]))*.?)[\"”\\n]'
 DIALOGUE_RE = re.compile(r"[\"“](?:.(?![\"“]))*.?[\"”\\n]", re.MULTILINE)
 
+BRITISH_DIALOGUE_RE = re.compile(r"['‘](?:.(?!['‘]))*.?['’\n]", re.MULTILINE)
+
 
 def get_dialogue(text, dialogue_regex=DIALOGUE_RE):
     """Get the dialogue fragments from a piece of text

tests/test_narrative.py

@@ -2,6 +2,18 @@
 
 import narrative
 
+BRITISH_EXCERPT = """‘Economic systems’, according to Professor White, ‘are an inevitable byproduct of civilization, and are, as John Doe said, “with us whether we want them or not”’.
+"""
+# https://www.thepunctuationguide.com/british-versus-american-style.html
+
+BRITISH_DIALOGUE = [
+    "‘Economic systems’",
+    "‘are an inevitable byproduct of civilization, and are, as John Doe said, “with us whether we want them or not”’.\n",
+]
+
+BRITISH_NARRATIVE = ["", ", according to Professor White, ", ""]
+
+
 EXCERPT = """Some one recklessly lifted the veil. By one breath of an uttered word he destroyed the serene charm, and uncovered the truth in its ugly nakedness. No thought was clearly defined in his mind, when his lips smilingly asked: "Why do you not tell us, Lazarus, what was There?" And all became silent, struck with the question. Only now it seemed to have occurred to them that for three days Lazarus had been dead; and they looked with curiosity, awaiting an answer. But Lazarus remained silent.
 
 "You will not tell us?" wondered the inquirer. "Is it so terrible there?"
@@ -35,3 +47,24 @@ def test_parse():
         "narrative": NARRATIVE,
         "dialogue": DIALOGUE,
     }  # nosec
+
+
+def test_get_dialogue_british():
+    assert (
+        narrative.get_dialogue(BRITISH_EXCERPT, narrative.BRITISH_DIALOGUE_RE)
+        == BRITISH_DIALOGUE
+    )  # nosec
+
+
+def test_get_narrative_british():
+    assert (
+        narrative.get_narrative(BRITISH_EXCERPT, narrative.BRITISH_DIALOGUE_RE)
+        == BRITISH_NARRATIVE
+    )  # nosec
+
+
+def test_parse_british():
+    assert narrative.split(BRITISH_EXCERPT, narrative.BRITISH_DIALOGUE_RE) == {
+        "narrative": BRITISH_NARRATIVE,
+        "dialogue": BRITISH_DIALOGUE,
+    }  # nosec