Properly package the canonicaljson module (#52)

Package canonicaljson as a proper module rather than a single-file module. The main motivation is to expose the py.typed marker file so other projects can use the typing annotations.

I've decided to go with an src/ layout for the module's source rather than the solution proposed in #50 (comment) to avoid a repeat of matrix-org/matrix-python-common#23.

Fixes #50

Author: babolivier

.github/workflows/tests.yaml

@@ -1,5 +1,8 @@
 name: Tests
-on: [push, pull_request]
+on:
+  push:
+    branches: ["main"]
+  pull_request:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

MANIFEST.in

@@ -1,8 +1,4 @@
-include *.in
-include *.py
+prune .github
 include *.md
-include LICENSE
 include tox.ini
-include pyproject.toml
-prune .travis
-prune debian
+recursive-include tests *.py

pyproject.toml

@@ -3,4 +3,10 @@ show_error_codes = true
 strict = true
 
 files = ["."]
-exclude = "setup.py"
+
+[build-system]
+requires = [
+    "setuptools >= 35.0.2",
+    "setuptools_scm >= 2.0.0, <3"
+]
+build-backend = "setuptools.build_meta"

releasing.md

@@ -1,11 +1,11 @@
 Releasing python-canonicaljson
 ==============================
 
-* bump version in `canonicaljson.py`
+* bump version in `src/canonicaljson/__init__.py`
 * update changelog
 * Build and upload to pypi:
   * `rm -r dist`
-  * `python setup.py sdist bdist_wheel`
+  * `python -m build`
   * `twine upload -s dist/*`
 * `git tag -s v<ver>`
 * `git push`

setup.cfg

@@ -1,3 +1,49 @@
+[metadata]
+name = canonicaljson
+description = Canonical JSON
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+version = attr: canonicaljson.__version__
+keywords = json
+url = https://github.com/matrix-org/python-canonicaljson
+license = Apache License, Version 2.0
+author = Matrix.org Team and Contributors
+author_email = [email protected]
+license_file = LICENSE
+classifiers =
+    Development Status :: 5 - Production/Stable
+    Intended Audience :: Developers
+    License :: OSI Approved :: Apache Software License
+    Programming Language :: Python :: 2
+    Programming Language :: Python :: 3
+
+
+[options]
+zip_safe = true
+python_requires = >=3.7
+
+package_dir = =src
+packages =
+  canonicaljson
+
+install_requires =
+    # simplejson versions before 3.14.0 had a bug with some characters
+    # (e.g. \u2028) if ensure_ascii was set to false.
+    simplejson>=3.14.0
+    # typing.Protocol was only added to the stdlib in Python 3.8
+    typing_extensions>=4.0.0; python_version < '3.8'
+
+
+[options.extras_require]
+# frozendict support can be enabled using the `canonicaljson[frozendict]` syntax
+frozendict =
+    frozendict>=1.0
+
+
+[options.package_data]
+canonicaljson = py.typed
+
+
 [flake8]
 # see https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes
 # for error codes. The ones we ignore are:

setup.py

@@ -1,7 +1,6 @@
-# -*- coding: utf-8 -*-
-
 # Copyright 2014 OpenMarket Ltd
 # Copyright 2018 New Vector Ltd
+# Copyright 2022 The Matrix.org Foundation C.I.C.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

canonicaljson.py renamed to src/canonicaljson/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2022 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

src/canonicaljson/py.typed

@@ -1,7 +1,6 @@
-# -*- coding: utf-8 -*-
-#
 # Copyright 2015 OpenMarket Ltd
 # Copyright 2018 New Vector Ltd
+# Copyright 2022 The Matrix.org Foundation C.I.C.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

tests/__init__.py

@@ -1,7 +1,8 @@
 [tox]
 envlist = packaging, pep8, black, py37, py38, py39, py310, pypy3
+isolated_build = True
 
-[testenv]
+[testenv:py]
 deps =
     coverage
     nose2
@@ -19,20 +20,21 @@ commands = check-manifest
 basepython = python3.7
 deps =
     flake8
-commands = flake8 .
+commands = flake8 src tests
 
 [testenv:black]
 basepython = python3.7
 deps =
     black==21.9b0
     # Workaround black+click incompatability, see https://github.com/psf/black/issues/2964
     click==8.0.4
-commands = python -m black --check --diff .
+commands = python -m black --check --diff src tests
 
 [testenv:mypy]
 deps =
     mypy==0.942
     types-frozendict==2.0.8
     types-simplejson==3.17.5
     types-setuptools==57.4.14
-commands = mypy
+commands = mypy src tests
+