Merge pull request #29 from financica/master

Modernize / Recent Python+Django compat

Author: danni

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+exclude = .git,__pycache__,migrations
+max-complexity = 10
+max-line-length = 88

.github/workflows/linting.yml

@@ -0,0 +1,26 @@
+name: Linting
+
+on:
+  push:
+
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [master]
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install poetry
+        run: curl -sSL https://install.python-poetry.org | python3 -
+
+      - name: Install package
+        run: poetry install --with dev
+
+      - name: Run pre-commit
+        run: poetry run pre-commit run --all-files --show-diff-on-failure

.gitignore

@@ -1,8 +1,4 @@
-/build/
+/poetry.lock
 /dist/
-/django_postgres_composite_types.egg-info/
-/.eggs/
-/requirements.txt
-/test_requirements.txt
 __pycache__
 /.tox

.pre-commit-config.yaml

@@ -0,0 +1,57 @@
+exclude: ".git|.tox|.pytest_cache"
+default_stages: [commit]
+fail_fast: true
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.3.0"
+    hooks:
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: "22.8.0"
+    hooks:
+      - id: black
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.2.2
+    hooks:
+      - id: pyupgrade
+
+  - repo: https://github.com/dosisod/refurb
+    rev: "v1.8.0"
+    hooks:
+      - id: refurb
+
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: "1.12.0"
+    hooks:
+    - id: django-upgrade
+      args: [--target-version, "3.2"]
+
+  - repo: https://github.com/timothycrosley/isort
+    rev: "5.10.1"
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/pycqa/flake8
+    rev: "5.0.4"
+    hooks:
+      - id: flake8
+
+  - repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: env DJANGO_SETTINGS_MODULE="tests.settings" pylint
+        language: system
+        types: [python]
+        args: ["--ignore-paths=tests/"]

.travis.yml

@@ -0,0 +1,27 @@
+(c) 2016, Danielle Madeley  <danielle@madeley.id.au>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

LICENSE

@@ -1,11 +1,9 @@
-Django Postgres composite types
-===============================
+# Django Postgres composite types
 
 An implementation of Postgres' [composite types](http://www.postgresql.org/docs/current/static/rowtypes.html)
 for [Django](https://docs.djangoproject.com/en/1.9/).
 
-Usage
------
+## Usage
 
 Install with:
 
@@ -66,8 +64,7 @@ class Migration(migrations.Migration):
     ]
 ```
 
-Examples
---------
+## Examples
 
 Array fields:
 
@@ -93,7 +90,6 @@ Nested types:
 class Point(CompositeType):
     """A point on the cartesian plane."""
 
-    # pylint:disable=invalid-name
     x = models.IntegerField()
     y = models.IntegerField()
 
@@ -110,10 +106,9 @@ class Box(CompositeType):
     bottom_right = Point.Field()
 ```
 
-Gotchas and Caveats
--------------------
+## Gotchas and Caveats
 
-The migration operation currently loads the *current* state of the type, not
+The migration operation currently loads the _current_ state of the type, not
 the state when the migration was written. A generic `CreateType` operation
 which takes the fields of the type would be possible, but it would still
 require manual handling still as Django's `makemigrations` is not currently
@@ -144,8 +139,8 @@ Lookups and indexes are not implemented yet
 ([bug #9](https://github.com/danni/django-postgres-composite-types/issues/9),
 [bug #10](https://github.com/danni/django-postgres-composite-types/issues/10)).
 
-Running Tests
--------------------
+## Running Tests
+
 Clone the repository, go to it's base directory and run the following commands.
 
     pip install tox
@@ -155,40 +150,12 @@ Or if you want a specific environment
 
     tox -e py35-dj2.0
 
-Authors
--------
-
-* Danielle Madeley <danielle@madeley.id.au>
-* Tim Heap <hello@timheap.me>
-
-License
--------
-
-(c) 2016, Danielle Madeley  <danielle@madeley.id.au>
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+## Authors
 
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
+-   Danielle Madeley <danielle@madeley.id.au>
+-   Tim Heap <hello@timheap.me>
 
-3. Neither the name of the copyright holder nor the names of its contributors
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
+## License
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+This project is licensed under the BSD license.
+See the LICENSE file for the full text of the license.