Merge pull request #107 from bastikr/release-4.0

Release 4.0

Author: pombredanne

.github/workflows/pypi-release.yml

@@ -0,0 +1,27 @@
+name: Release library as a PyPI wheel and sdist on tag
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build-and-publish-to-pypi:
+    name: Build and publish library to PyPI
+    runs-on: ubuntu-20.04
+    steps:
+     - uses: actions/checkout@master
+     - name: Set up Python
+       uses: actions/setup-python@v1
+       with:
+         python-version: 3.9
+     - name: Install pypa/build
+       run: python -m pip install build --user
+     - name: Build a binary wheel and a source tarball
+       run: python -m build --sdist --wheel --outdir dist/
+        .
+     - name: Publish distribution to PyPI
+       if: startsWith(github.ref, 'refs/tags')
+       uses: pypa/gh-action-pypi-publish@master
+       with:
+         password: ${{ secrets.PYPI_API_TOKEN }}
+        

.github/workflows/test-and-build.yml

@@ -0,0 +1,76 @@
+
+# Derived in part from https://github.com/google/brotli-wheels
+#
+# Copyright (c) 2009, 2010, 2013-2016 by the Brotli Authors.
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+name: Run tests and build wheel and sdist on all supported OS and Python
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+    build:
+      name: Build source distribution
+      runs-on: ubuntu-20.04
+
+      steps:
+          - uses: actions/checkout@v2
+
+          - name: Checkout and install reqs
+            run: |
+                pip install --upgrade --user build twine pip setuptools
+
+          - name: Build sdist
+            run: |
+                python setup.py sdist bdist_wheel
+                twine check dist/*
+
+          - name: Collect built sdist
+            uses: actions/upload-artifact@v2
+            with:
+                path: dist/*.tar.gz
+
+    test_on_many_oses:
+        name: Run tests ${{ matrix.python }} on ${{ matrix.os }}
+        runs-on: ${{ matrix.os }}
+        defaults:
+          run:
+            shell: bash
+
+        strategy:
+            fail-fast: false
+            matrix:
+                os: [ubuntu-20.04, macos-11, windows-2022]
+                python: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+
+        steps:
+            - name: Set up Python
+              uses: actions/setup-python@v2
+              with:
+                python-version: "${{ matrix.python }}"
+
+            - uses: actions/checkout@v2
+
+            - name: Install
+              run: pip install -e . -r requirements-dev.txt
+
+            - name: Run tests
+              run: pytest -vvs boolean

.gitignore

@@ -8,4 +8,5 @@
 /.eggs/
 /.pytest_cache/
 /.idea/
-.python-version
+.python-version
+/venv/

.travis.yml

@@ -7,6 +7,23 @@ next
 ----
 
 
+4.0 (2022-04-02)
+----------------
+
+* API changes
+
+ * Drop support for Python 2.
+ * Test on Python 3.10
+ * Make Expression.sort_order an instance attributes and not a class attribute
+
+* Misc.
+
+ * Correct licensing documentation
+ * Improve docstringf and apply minor refactorings
+ * Adopt black code style and isort for imports
+ * Drop Travis and use GitHub actions for CI
+
+
 3.8 (2020-06-10)
 ----------------
 

CHANGELOG.rst

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2020 Sebastian Kraemer, [email protected] and others
+Copyright (c) Sebastian Kraemer, [email protected] and others
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

LICENSE.txt

@@ -1,15 +1,16 @@
 graft docs
 graft boolean
+graft .github
+
 
 include .gitignore
-include .travis.yml
 include CHANGELOG.rst
 include LICENSE.txt
 include MANIFEST.in
 include README.rst
 include setup.py
 include setup.cfg
-include test-requirements.txt
+include requirements-dev.txt
 include tox.ini
 
 global-exclude *.py[co] __pycache__

MANIFEST.in

@@ -8,37 +8,41 @@ OR and NOT - other compositions like XOR and NAND are not implemented
 but can be emulated with AND or and NOT. Expressions are constructed
 from parsed strings or in Python.
 
-It runs on Python 2.7 and Python 3.
+It runs on Python 3.6+
+You can use older version 3.x for Python 2.7+ support.
 
 https://github.com/bastikr/boolean.py
 
 Build status: |Build Status|
 
+
 Example
 -------
 
 ::
 
-        >>> import boolean
-        >>> algebra = boolean.BooleanAlgebra()
-        >>> expression1 = algebra.parse(u'apple and (oranges or banana) and not banana', simplify=False)
-        >>> expression1
-        AND(Symbol('apple'), OR(Symbol('oranges'), Symbol('banana')), NOT(Symbol('banana')))
+    >>> import boolean
+    >>> algebra = boolean.BooleanAlgebra()
+    >>> expression1 = algebra.parse(u'apple and (oranges or banana) and not banana', simplify=False)
+    >>> expression1
+    AND(Symbol('apple'), OR(Symbol('oranges'), Symbol('banana')), NOT(Symbol('banana')))
+
+    >>> expression2 = algebra.parse('(oranges | banana) and not banana & apple', simplify=True)
+    >>> expression2
+    AND(Symbol('apple'), NOT(Symbol('banana')), Symbol('oranges'))
 
-        >>> expression2 = algebra.parse(u'(oranges | banana) and not banana & apple', simplify=True)
-        >>> expression2
-        AND(Symbol('apple'), NOT(Symbol('banana')), Symbol('oranges'))
+    >>> expression1 == expression2
+    False
+    >>> expression1.simplify() == expression2
+    True
 
-        >>> expression1 == expression2
-        False
-        >>> expression1.simplify() == expression2
-        True
 
 Documentation
 -------------
 
 http://readthedocs.org/docs/booleanpy/en/latest/
 
+
 Installation
 ------------
 
@@ -55,20 +59,21 @@ You then only need to run the following command:
 
 ``pip install boolean.py``
 
+
 Installation via package managers
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 There are packages available for easy install on some operating systems.
 You are welcome to help us package this tool for more distributions!
 
 -  boolean.py has been packaged as Arch Linux, Fedora, openSus,
-   nixpkgs, Guix, DragonFly and FreeBSD
+   nixpkgs, Guix, DragonFly and FreeBSD 
    `packages <https://repology.org/project/python:boolean.py/versions>`__ .
 
 In particular:
 
--  Arch Linux:
-   `python-boolean.py <https://archlinux.org/packages/community/any/python-boolean.py/>`__
+-  Arch Linux (AUR):
+   `python-boolean.py <https://aur.archlinux.org/packages/python-boolean.py/>`__
 -  Fedora:
    `python-boolean.py <https://apps.fedoraproject.org/packages/python-boolean.py>`__
 -  openSUSE:
@@ -86,20 +91,23 @@ Test with all of the supported Python environments using ``tox``:
 
 ::
 
-    pip install -r test-requirements.txt
+    pip install -r requirements-dev.txt
     tox
 
 If ``tox`` throws ``InterpreterNotFound``, limit it to python
 interpreters that are actually installed on your machine:
 
 ::
 
-    tox -e py27,py36
+    tox -e py36
+
+Alternatively use pytest.
+
 
 License
 -------
 
-Copyright (c) 2009-2020 Sebastian Kraemer, [email protected] and others
+Copyright (c) Sebastian Kraemer, [email protected] and others
 SPDX-License-Identifier: BSD-2-Clause
 
 .. |Build Status| image:: https://travis-ci.org/bastikr/boolean.py.svg?branch=master

README.rst

@@ -6,32 +6,25 @@
 look either into the docs directory or view it online, at
 https://booleanpy.readthedocs.org/en/latest/.
 
-Copyright (c) 2009-2020 Sebastian Kraemer, [email protected] and others
+Copyright (c) Sebastian Kraemer, [email protected] and others
 SPDX-License-Identifier: BSD-2-Clause
 """
 
-from __future__ import absolute_import
-from __future__ import unicode_literals
-from __future__ import print_function
-
-from boolean.boolean import BooleanAlgebra
-
-from boolean.boolean import Expression
-from boolean.boolean import Symbol
-from boolean.boolean import ParseError
-from boolean.boolean import PARSE_ERRORS
-
-from boolean.boolean import AND
-from boolean.boolean import NOT
-from boolean.boolean import OR
-
-from boolean.boolean import TOKEN_TRUE
-from boolean.boolean import TOKEN_FALSE
-from boolean.boolean import TOKEN_SYMBOL
-
-from boolean.boolean import TOKEN_AND
-from boolean.boolean import TOKEN_OR
-from boolean.boolean import TOKEN_NOT
-
-from boolean.boolean import TOKEN_LPAR
-from boolean.boolean import TOKEN_RPAR
+from boolean.boolean import (
+    AND,
+    NOT,
+    OR,
+    PARSE_ERRORS,
+    TOKEN_AND,
+    TOKEN_FALSE,
+    TOKEN_LPAR,
+    TOKEN_NOT,
+    TOKEN_OR,
+    TOKEN_RPAR,
+    TOKEN_SYMBOL,
+    TOKEN_TRUE,
+    BooleanAlgebra,
+    Expression,
+    ParseError,
+    Symbol,
+)