Merge pull request #11 from jsickcodes/drop-py-pandoc

Drop py pandoc (0.3.0 release)

Author: jonathansick

.github/workflows/ci.yaml

@@ -1,6 +1,9 @@
 name: CI
 
-"on": ["pull_request", "push"]
+"on":
+  pull_request:
+  push:
+    branches: [main]
 
 jobs:
   pre-commit:
@@ -12,7 +15,7 @@ jobs:
 
       - uses: actions/setup-python@v2
 
-      - uses: pre-commit/action@v2.0.0
+      - uses: pre-commit/action@v2.0.3
 
   typing:
     runs-on: ubuntu-latest
@@ -23,8 +26,6 @@ jobs:
 
       - name: Set up Python
         uses: actions/setup-python@v2
-        with:
-          python-version: 3.8
 
       - name: Python install
         run: |
@@ -55,6 +56,9 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Install pandoc
+        run: brew install pandoc
+
       - name: Python install
         run: |
           python -m pip install --upgrade pip

CHANGELOG.rst

@@ -1,10 +1,14 @@
 Change log
 ==========
 
-Unreleased
-----------
+0.3.0 (2021-05-12)
+------------------
 
 - Trim trailing whitespace from the output.
+- Drop ``py-pandoc`` as a default dependency.
+  To get pandoc, you can install it with your system's package manager (such as homebrew or apt-get).
+  Alternatively, you can directly install pre-commit-docx-plain using the ``[pandoc]`` extra to install pandoc through the ``py-pandoc`` PyPI package.
+  However, we've found that py-pandoc cannot be installed reliably as a dependency of a pre-commit hook.
 
 0.2.0 (2021-03-23)
 ------------------

README.rst

@@ -15,7 +15,7 @@ At the root of your document's Git repository, add a file named ``.pre-commit-co
 
    repos:
      - repo: https://github.com/jsickcodes/pre-commit-docx-plain
-       rev: 0.1.0
+       rev: 0.3.0
        hooks:
          - id: docxplain
 
@@ -53,7 +53,10 @@ If the repository does not already have a GitHub Actions workflow, create a file
 
    name: CI
 
-   "on": [push, pull_request]
+   'on':
+     pull_request:
+     push:
+       branches: [main]
 
    jobs:
      pre-commit:
@@ -65,8 +68,11 @@ If the repository does not already have a GitHub Actions workflow, create a file
          - name: Set up Python
            uses: actions/setup-python@v2
 
+         - name: Install pandoc
+           run: brew install pandoc
+
          - name: Run pre-commit hooks
-           uses: pre-commit/action@v2.0.0
+           uses: pre-commit/action@v2.0.3
 
 This workflow will generate a build "failure" if the plain-text mirror file is out of date with the Word file in the repository — as might happen if a contributor did not install pre-commit locally.
 
@@ -78,7 +84,10 @@ The ``.github/workflows/ci.yaml`` file::
 
    name: CI
 
-   "on": [push, pull_request]
+   'on':
+     pull_request:
+     push:
+       branches: [main]
 
    jobs:
      pre-commit:
@@ -92,8 +101,11 @@ The ``.github/workflows/ci.yaml`` file::
          - name: Set up Python
            uses: actions/setup-python@v2
 
+         - name: Install pandoc
+           run: brew install pandoc
+
          - name: Run pre-commit hooks
-           uses: pre-commit/action@v2.0.0
+           uses: pre-commit/action@v2.0.3
            with:
              token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -115,7 +127,7 @@ However, you can customize the suffix of the file name by setting a ``--suffix``
 
    repos:
      - repo: https://github.com/jsickcodes/pre-commit-docx-plain
-       rev: 0.2.0
+       rev: 0.3.0
        hooks:
          - id: docxplain
            args:
@@ -130,7 +142,7 @@ This is useful for explaining that the file is autogenerated::
 
    repos:
      - repo: https://github.com/jsickcodes/pre-commit-docx-plain
-       rev: 0.2.0
+       rev: 0.3.0
        hooks:
          - id: docxplain
            args:
@@ -141,9 +153,30 @@ You can also insert the name of the source docx file using Python format string
 
    repos:
      - repo: https://github.com/jsickcodes/pre-commit-docx-plain
-       rev: 0.2.0
+       rev: 0.3.0
        hooks:
          - id: docxplain
            args:
              - "--header"
              - "This file is autogenerated from {docx}. Do not edit."
+
+Development guide
+=================
+
+Release procedure
+-----------------
+
+From the pull request:
+
+1. Update the `changelog <CHANGELOG.rst>`__
+2. Update the version numbers in the ``.pre-commit-config.yaml`` code samples in the README.
+3. Update the version in `setup.cfg <setup.cfg>`__.
+
+Next, merge the PR to the ``main`` branch once checks pass.
+
+Finally, create a Release using the GitHub Release UI from the ``main`` branch. The tag name should be the semantic version set in the first step.
+
+Project information
+===================
+
+pre-commit-docx-plain is developed and maintained by J.Sick Codes Inc.

pyproject.toml

@@ -1,8 +1,7 @@
 [build-system]
 requires = [
     "setuptools>=42",
-    "wheel",
-    "setuptools_scm[toml]>=3.4"
+    "wheel"
 ]
 build-backend = 'setuptools.build_meta'
 

setup.cfg

@@ -1,5 +1,6 @@
 [metadata]
 name = docxplain
+version = 0.3.0
 description = Convert Office (docx) files to plain text using pandoc.
 author = Jonathan Sick
 author_email = hi@jsick.codes
@@ -28,12 +29,9 @@ package_dir =
     = src
 packages = find:
 python_requires = >=3.7
-setup_requires =
-    setuptools_scm
 install_requires =
     importlib_metadata; python_version < "3.8"
     pypandoc
-    py-pandoc
 
 [options.packages.find]
 where = src
@@ -43,6 +41,8 @@ console_scripts =
     docxplain = docxplain.cli:main
 
 [options.extras_require]
+pandoc =
+    py-pandoc
 dev =
     pytest
 

setup.py

@@ -1,3 +1,3 @@
 from setuptools import setup
 
-setup(use_scm_version=True)
+setup()

tox.ini

@@ -11,6 +11,8 @@ skip_missing_interpreters = True
 description = Run unit tests
 extras =
     dev
+allowlist_externals =
+    pandoc
 commands=
     pytest {posargs}