Rename package to 'brotlicffi'

Author: sethmlarson

README.rst

@@ -1,16 +1,16 @@
-brotlipy
-========
+BrotliCFFI
+==========
 
-This library contains Python bindings for the reference Brotli encoder/decoder,
+This library contains Python CFFI bindings for the reference Brotli encoder/decoder,
 `available here`_. This allows Python software to use the Brotli compression
 algorithm directly from Python code.
 
 To use it simply, try this:
 
 .. code-block:: python
 
-    import brotli
-    data = brotli.decompress(compressed_data)
+    import brotlicffi
+    data = brotlicffi.decompress(compressed_data)
 
 More information can be found `in the documentation`_.
 
@@ -20,11 +20,12 @@ More information can be found `in the documentation`_.
 License
 -------
 
-The source code of brotlipy is available under the MIT license. Brotli itself
+The source code of BrotliCFFI is available under the MIT license. Brotli itself
 is made available under the Version 2.0 of the Apache Software License. See the
 LICENSE and libbrotli/LICENSE files for more information.
 
 Authors
 -------
 
-brotlipy is maintained by Cory Benfield.
+BrotliCFFI/brotlipy was authored by Cory Benfield and
+is currently maintained by Seth Michael Larson.

docs/Makefile

@@ -87,9 +87,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/brotlipy.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/brotlicffi.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/brotlipy.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/brotlicffi.qhc"
 
 applehelp:
 	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@@ -104,8 +104,8 @@ devhelp:
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/brotlipy"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/brotlipy"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/brotlicffi"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/brotlicffi"
 	@echo "# devhelp"
 
 epub:

docs/make.bat

@@ -127,9 +127,9 @@ if "%1" == "qthelp" (
 	echo.
 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 .qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\brotlipy.qhcp
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\brotlicffi.qhcp
 	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\brotlipy.ghc
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\brotlicffi.ghc
 	goto end
 )
 

docs/source/api.rst

@@ -1,34 +1,34 @@
 API Documentation
 =================
 
-.. module:: brotli
+.. module:: brotlicffi
 
-This section of the documentation covers the API of brotlipy.
+This section of the documentation covers the API of BrotliCFFI.
 
 Decompression
 -------------
 
-.. automethod:: brotli.decompress
+.. automethod:: brotlicffi.decompress
 
-.. autoclass:: brotli.Decompressor
+.. autoclass:: brotlicffi.Decompressor
   :inherited-members:
 
 Compression
 -----------
 
-.. automethod:: brotli.compress
+.. automethod:: brotlicffi.compress
 
-.. autoclass:: brotli.Compressor
+.. autoclass:: brotlicffi.Compressor
    :members:
 
-.. autoclass:: brotli.BrotliEncoderMode
+.. autoclass:: brotlicffi.BrotliEncoderMode
    :members:
 
-.. autodata:: brotli.BROTLI_DEFAULT_MODE
+.. autodata:: brotlicffi.BROTLI_DEFAULT_MODE
 
 Errors
 ------
 
-.. autoclass:: brotli.Error
+.. autoclass:: brotlicffi.Error
 
-.. autodata:: brotli.error
+.. autodata:: brotlicffi.error

docs/source/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# brotlipy documentation build configuration file, created by
+# BrotliCFFI documentation build configuration file, created by
 # sphinx-quickstart on Sat Oct  3 16:51:16 2015.
 #
 # This file is execfile()d with the current directory set to its
@@ -12,6 +12,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import datetime
 import sys
 import os
 import shlex
@@ -49,8 +50,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'brotlipy'
-copyright = u'2015, Cory Benfield'
+project = u'brotlicffi'
+copyright = u'%d, Cory Benfield' % (datetime.date.today().year,)
 author = u'Cory Benfield'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -203,7 +204,7 @@
 #html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'brotlipydoc'
+htmlhelp_basename = 'BrotliCFFIdoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -225,7 +226,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  (master_doc, 'brotlipy.tex', u'brotlipy Documentation',
+  (master_doc, 'BrotliCFFI.tex', u'BrotliCFFI Documentation',
    u'Cory Benfield', 'manual'),
 ]
 
@@ -255,7 +256,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'brotlipy', u'brotlipy Documentation',
+    (master_doc, 'BrotliCFFI', u'BrotliCFFI Documentation',
      [author], 1)
 ]
 
@@ -269,8 +270,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  (master_doc, 'brotlipy', u'brotlipy Documentation',
-   author, 'brotlipy', 'One line description of project.',
+  (master_doc, 'BrotliCFFI', u'BrotliCFFI Documentation',
+   author, 'BrotliCFFI', 'One line description of project.',
    'Miscellaneous'),
 ]
 

docs/source/index.rst

@@ -1,30 +1,30 @@
-Brotlipy: Python Bindings to the Brotli Compression Algorithm
-=============================================================
+BrotliCFFI: Python CFFI Bindings to the Brotli Compression Algorithm
+====================================================================
 
-Brotlipy is a collection of `CFFI-based`_ bindings to the `Brotli`_ compression
+BrotliCFFI is a collection of `CFFI-based`_ bindings to the `Brotli`_ compression
 reference implementation as written by Google. This enables Python software to
 easily and quickly work with the Brotli compression algorithm, regardless of
 what interpreter is being used.
 
-Brotlipy has a very similar interface to the standard library's ``zlib``
-module:
+BrotliCFFI has an identical API to Google's Python C bindings
+for the `Brotli`_ library.
 
 .. code-block:: python
 
-    import brotli
+    import brotlicffi
 
     # Decompress a Brotli-compressed payload in one go.
-    decompressed_data = brotli.decompress(compressed_data)
+    decompressed_data = brotlicffi.decompress(compressed_data)
 
     # Alternatively, you can do incremental decompression.
-    d = brotli.Decompressor()
+    d = brotlicffi.Decompressor()
     for chunk in chunks_of_compressed_data:
         some_uncompressed_data = d.decompress(chunk)
 
     remaining_data = d.flush()
 
     # You can compress data too.
-    compressed = brotli.compress(uncompressed_data)
+    compressed = brotlicffi.compress(uncompressed_data)
 
 For more details on the API, see :doc:`api`.
 
@@ -45,5 +45,5 @@ Documentation
 License
 -------
 
-Brotlipy's source code is made available under the MIT license. Brotli itself
+BrotliCFFI's source code is made available under the MIT license. Brotli itself
 is licensed under Version 2.0 of the Apache Software License.

docs/source/installation.rst

@@ -1,11 +1,11 @@
 Installation
 ============
 
-Installing Brotlipy couldn't be easier:
+Installing BrotliCFFI couldn't be easier:
 
 .. code-block:: bash
 
-    $ pip install brotlipy
+    $ python -m pip install brotlicffi
 
 On OS X and Windows this should succeed without difficulty. On Linux, the above
 command has a few dependencies: mostly, you need a C compiler, the Python

setup.py

@@ -33,7 +33,7 @@ def run(self):
             "include_dirs": [
                 "libbrotli/include",
                 "libbrotli/",
-                "src/brotli"
+                "src/brotlicffi"
             ],
             "sources": [
                 'libbrotli/common/dictionary.c',
@@ -76,12 +76,12 @@ def finalize_options(self):
         cmdclass['bdist_wheel'] = BDistWheel
 
 setup(
-    name="brotlipy",
+    name="brotlicffi",
     version="0.7.0",
 
-    description="Python binding to the Brotli library",
+    description="Python CFFI bindings to the Brotli library",
     long_description=long_description,
-    url="https://github.com/python-hyper/brotlipy/",
+    url="https://github.com/python-hyper/brotlicffi",
     license="MIT",
 
     author="Cory Benfield",
@@ -93,17 +93,10 @@ def finalize_options(self):
     install_requires=[
         "cffi>=1.0.0",
     ],
-    extras_require={
-        ':python_version == "2.7" or python_version == "3.3"': ['enum34>=1.0.4, <2'],
-    },
-
-    cffi_modules=["src/brotli/build.py:ffi"],
-
+    cffi_modules=["src/brotlicffi/_build.py:ffi"],
     packages=find_packages('src'),
     package_dir={'': 'src'},
-
-    ext_package="brotli",
-
+    ext_package="brotlicffi",
     libraries=libraries,
 
     zip_safe=False,
@@ -120,5 +113,8 @@ def finalize_options(self):
         "Programming Language :: Python :: 3.4",
         "Programming Language :: Python :: 3.5",
         "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
     ]
 )

src/brotli/__init__.py src/brotlicffi/__init__.pysrc/brotli/__init__.py renamed to src/brotlicffi/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # flake8: noqa
-from .brotli import (
+from ._api import (
     decompress, Decompressor, compress, BrotliEncoderMode, DEFAULT_MODE,
     Compressor, MODE_GENERIC, MODE_TEXT, MODE_FONT, error, Error
 )

src/brotli/brotli.py src/brotlicffi/_api.pysrc/brotli/brotli.py renamed to src/brotlicffi/_api.py

@@ -2,7 +2,7 @@
 import math
 import enum
 
-from ._brotli import ffi, lib
+from ._brotlicffi import ffi, lib
 
 
 class Error(Exception):