Django 3 & reshape the repo

.github/workflows/ci.yml

@@ -0,0 +1,108 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - 'master'
+    tags:
+      - '*'
+
+jobs:
+  build:
+
+    # When testing new Python or Django versions, one should use the
+    # filterwarnings definition of setup.cfg to turn deprecation warnings
+    # into errors.
+    strategy:
+      matrix:
+        include:
+
+          - name: Python 3.7 / Django 3.2
+            python_version: "3.7"
+            tox_env: py37-django32
+
+          - name: Python 3.8 / Django 3.2
+            python_version: "3.8"
+            tox_env: py38-django32
+
+          - name: Python 3.9 / Django 2.2
+            python_version: "3.9"
+            tox_env: py39-django22
+
+          - name: Python 3.9 / Django 3.0
+            python_version: "3.9"
+            tox_env: py39-django30
+
+          - name: Python 3.9 / Django 3.1
+            python_version: "3.9"
+            tox_env: py39-django31
+
+          - name: Python 3.9 / Django 3.2
+            python_version: "3.9"
+            tox_env: py39-django32
+
+          - name: Python 3.9 / Django 4.0
+            python_version: "3.9"
+            tox_env: py39-django40
+
+          - name: Python 3.10 / Django 3.2
+            python_version: "3.10"
+            tox_env: py310-django32
+
+          - name: Lint
+            python_version: "3"
+            tox_env: lint
+
+          - name: Docs
+            python_version: "3"
+            tox_env: docs
+
+    name: "${{ matrix.name }}"
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres
+        # Set health checks to wait until postgres has started
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+        ports:
+          - 5432:5432
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python
+        id: setup-python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python_version }}
+
+      - name: Pip cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cache/
+          key: ${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('setup.py') }}
+
+      - name: Install Tox
+        run: pip install tox
+
+      - name: Run ${{ matrix.name }}
+        run: tox -e ${{ matrix.tox_env }}
+        env:
+          DATABASE_URL: postgres://postgres:postgres@localhost:5432/test
+
+  report-status:
+    name: success
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+
+      - name: Report success
+        run: echo 'Success !'

CONTRIBUTING.rst

@@ -109,4 +109,4 @@ Tips
 
 To run a subset of tests::
 
-    $ python -m unittest tests.test_django_readonly_field
+    $ pytest tests/test_django_readonly_field

LICENSE

@@ -1,14 +1,10 @@
 
 MIT License
 
-Copyright (c) 2016, Joachim Jablon
+Copyright (c) 2016, PeopleDoc
 
 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.
-
-
-
-

django_readonly_field/__init__.py

@@ -1,3 +1,7 @@
+import django
+
 __version__ = "1.0.6dev0"
 
-default_app_config = "django_readonly_field.apps.Readonly"
+
+if django.VERSION[:2] < (3, 2):
+    default_app_config = "django_readonly_field.apps.Readonly"

django_readonly_field/apps.py

@@ -1,5 +1,3 @@
-from __future__ import unicode_literals
-
 from django.apps import AppConfig
 
 

docker-compose.yml

@@ -0,0 +1,9 @@
+version: '2.1'
+services:
+
+  postgres:
+    image: postgres
+    ports: ["5432:5432"]
+    environment:
+      POSTGRES_DB: db
+      POSTGRES_PASSWORD: password

docs/conf.py

@@ -100,7 +100,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/django_readonly_field.rst

@@ -1,30 +1,29 @@
-django_readonly_field package
-=============================
+django\_readonly\_field package
+===============================
 
 Submodules
 ----------
 
-django_readonly_field.apps module
----------------------------------
+django\_readonly\_field.apps module
+-----------------------------------
 
 .. automodule:: django_readonly_field.apps
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-django_readonly_field.compiler module
--------------------------------------
+django\_readonly\_field.compiler module
+---------------------------------------
 
 .. automodule:: django_readonly_field.compiler
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------
 
 .. automodule:: django_readonly_field
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

requirements.txt

@@ -1,2 +1 @@
-django>=1.11
--e .
+-e .[dev]

setup.cfg

@@ -1,3 +1,71 @@
+[metadata]
+name = django-readonly-field
+description = Make Django model fields readonly
+author = PeopleDoc
+author_email = peopledoc-python@ukg.com
+url = https://github.com/peopledoc/django-readonly-field
+long_description = file: README.rst
+keywords = django posgresql read-only
+license = MIT
+classifiers =
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Development Status :: 5 - Production/Stable',
+        'Framework :: Django',
+        'Framework :: Django :: 2.2',
+        'Framework :: Django :: 3.0',
+        'Framework :: Django :: 3.1',
+        'Framework :: Django :: 3.2',
+        'Framework :: Django :: 4.0',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+
+[options]
+zip_safe = True
+include_package_data = True
+packages = find:
+install_requires =
+    Django
+
+[options.extras_require]
+
+dev =
+    build
+    dj_database_url
+    flake8
+    psycopg2
+    pytest
+    pytest-cov
+    pytest-django
+    requests
+    sphinx
+    tox
+    twine
+
+[isort]
+profile = black
+
+[flake8]
+ignore = E501
+
 [wheel]
 universal = 1
 
+[doc8]
+max-line-length=88
+ignore-path=docs/_build
+
+
+[tool:pytest]
+DJANGO_SETTINGS_MODULE = tests.readonly_project.settings
+addopts =
+    --cov-report term-missing --cov-branch --cov-report html --cov-report term
+    --cov=django_readonly_field -vv --strict-markers -rfE -s
+testpaths =
+    tests/
+filterwarnings =
+    error
+    ignore:.*distutils Version classes are deprecated.*:DeprecationWarning