fix: brotli install, doc, and test (#179)

.github/workflows/ci.yaml

@@ -1,6 +1,10 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+    - main
+  pull_request:
 
 jobs:
   unit-tests:
@@ -13,6 +17,10 @@ jobs:
         os: [ubuntu-latest]
         EXTRA: [false]  # used to force includes to get included
         include:
+          - python-version: '3.12'
+            os: ubuntu-latest
+            EXTRA: true
+            NOTALL: true
           - python-version: '3.11'
             os: macos-latest
             EXTRA: true
@@ -40,7 +48,11 @@ jobs:
         run: |
           pip install setuptools
 
-      - name: Install warcio
+      - name: Install warcio ALL
+        if: ${{ ! matrix.NOTALL }}
+        run: pip install .[brotli,testing]
+      - name: Install warcio NOTALL
+        if: ${{ matrix.NOTALL }}
         run: pip install .[testing]
 
       - name: Run tests

CHANGELIST.rst

@@ -3,6 +3,8 @@ Unreleased
 
 - Add support for Python 3.12 by adjusting `urllib3` dependency to `>=1.26.4,<1.26.16`
 
+- Make brotli support easier to install
+
 
 1.7.4
 ~~~~~

README.rst

@@ -11,13 +11,13 @@ Background
 
 This library provides a fast, standalone way to read and write `WARC
 Format <https://en.wikipedia.org/wiki/Web_ARChive>`__ commonly used in
-web archives. Supports Python 2.7+ and Python 3.4+ (using
-`six <https://pythonhosted.org/six/>`__, the only external dependency)
+web archives. Python 3.7+ (minimally only needing
+`six <https://pythonhosted.org/six/>`__ as an external dependency)
 
 warcio supports reading and writing of WARC files compliant with both the `WARC 1.0 <http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf>`__
 and `WARC 1.1 <http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1-1_latestdraft.pdf>`__ ISO standards.
 
-Install with: ``pip install warcio``
+Install with: ``pip install warcio`` (or ``pip install warcio[all]`` to get optional features)
 
 This library is a spin-off of the WARC reading and writing component of
 the `pywb <https://github.com/webrecorder/pywb>`__ high-fidelity replay

setup.py

@@ -37,6 +37,9 @@
             'requests',
             'wsgiprox',
             'hookdns',
+        ],
+        'all': [
+            'brotlipy',
         ]
     },
     classifiers=[