django-multisite2 2.0.0__tar.gz

django-multisite2-2.0.0/.coveragerc

@@ -0,0 +1,3 @@
+[run]
+source=multisite
+omit=multisite/tests.py,multisite/migrations/*,multisite/south_migrations/*

django-multisite2-2.0.0/.github/workflows/build.yml

@@ -0,0 +1,74 @@
+---
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: build (Python ${{ matrix.python-version }}, Django ${{ matrix.django-version }})
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.11', '3.12']
+        django-version: ['4.2', '5.0', 'dev']
+
+        exclude:
+          - python-version: '3.12'
+            django-version: '4.2'
+          - python-version: '3.11'
+            django-version: 'dev'
+    services:
+      mysql:
+        image: mysql:latest
+        env:
+          MYSQL_DATABASE: mysql
+          MYSQL_ROOT_PASSWORD: mysql
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+    steps:
+      - name: Install pycups and words dependency
+        run: |
+          sudo sed -i 's/azure\.//' /etc/apt/sources.list
+          sudo apt-get -y update
+          sudo apt-get install libcups2-dev wamerican
+
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "dir=$(pip cache dir)" >>$GITHUB_OUTPUT
+
+      - name: Cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key:
+            ${{ matrix.python-version }}-v1-${{ hashFiles('**/setup.py') }}-${{ hashFiles('**/tox.ini') }}
+          restore-keys: |
+            ${{ matrix.python-version }}-v1-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -r https://raw.githubusercontent.com/clinicedc/edc/develop/requirements.tests/tox.txt
+
+
+      - name: Tox tests
+        run: |
+          tox -v
+        env:
+          DJANGO: ${{ matrix.django-version }}
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          name: Python ${{ matrix.python-version }}

django-multisite2-2.0.0/.gitignore

@@ -0,0 +1,25 @@
+build/
+dist/
+etc/
+.etc/
+.env
+_version.py
+*.pyc
+*.pyo
+.cache/
+.eggs/
+*.egg-info/
+.installed.cfg
+bin
+develop-eggs
+django_multisite.egg-info/
+dist
+downloads
+eggs
+parts
+MANIFEST
+multisite/*.egg-info
+django_multisite_edc.egg-info/*
+.coverage
+.tox/
+.pytest_cache/

django-multisite2-2.0.0/.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+---
+exclude: tests/etc/user-*
+
+repos:
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.5
+    hooks:
+      - id: bandit
+        args:
+          - "-x *test*.py"
+
+  - repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+      - id: black
+        language_version: python3.10
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+        args:
+          - "--config=setup.cfg"
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: requirements-txt-fixer
+        files: requirements/.*\.txt$
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: fix-byte-order-marker
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: detect-private-key
+
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.33.0
+    hooks:
+      - id: yamllint
+        args:
+          - "--strict"

django-multisite2-2.0.0/.yamllint

@@ -0,0 +1,13 @@
+# allow "on" until yamllint stops checking keys for truthy!
+# https://github.com/adrienverge/yamllint/issues/158
+---
+extends: default
+
+rules:
+  comments-indentation: disable
+  braces: disable
+  line-length:
+    max: 120
+  truthy:
+    level: error
+    allowed-values: ['true', 'false', 'on']

django-multisite2-2.0.0/CHANGES

@@ -0,0 +1,137 @@
+=============
+Release Notes
+=============
+
+2.0.0
+-----
+ - major refactor, drop support for lower than py 3.11 and DJ4.2
+ - drop pytest, use unitests / runtests.py 
+ - replace rel.to with related_model (Django 4.2)
+ - remove deprecated `process_requests`
+ - add more specific exception handling
+ - add MULTISITE_REGISTER_POST_MIGRATE_SYNC_ALIAS settings attr
+   to allow user to connect signal outside of multisite
+ - drop template loader code. Maybe add back later
+ - remove unused ThreadLocalsMiddleware
+
+1.9.0
+-----
+
+* Fix tldextract version 3.0.0 breaking changes (Issue #72 / PR #74)
+* Fix test requirements missing Django
+* Fix Pluggy dependency version conflict
+* Remove support for Python 3.5 / Django < 1.11
+
+1.8.0
+----------
+
+- Support for Django 3.0 (PR #68 - thanks @erikvw)
+- Fix middleware usage post Django 2.0 (PR #69 thanks @mihalikv)
+
+1.7.0
+-----
+
+* Support Django 2.1 and 2.2 (PR #59 - thanks @ribeiroti!)
+* Replace queryset with get_queryset in admin (PR #61 - thanks @vit-ivanov!)
+
+1.6.0
+-----
+* Fix KeyError from _get_site_by_id
+* Drop support for Django 1.7
+* Remove unnecessary cache type warnings
+* Remove deprecated SiteIDHook
+
+1.5.0
+-----
+* Support Django 2.0 (PR #47 and #60)
+* Remove code for Django < 1.7
+* Remove obsolete PathAssistedCurrentSiteManager
+* Remove obsolete template.loaders.cached
+* Update README to better describe local development setup
+
+1.4.1
+-----
+* Specify Django <2.0 in setup.py
+* Drop support for python 3.3
+
+1.4.0
+-----
+* Support Django 1.10 (PR #38) and 1.11
+* Support Python 3
+* Remove support for Django <1.7
+* Use setuptools over distutils, and integrate the tests with them
+* Use pytest and tox for testing
+* Set up CI with travis
+* Set up coverage and coveralls.io
+* Document MULTISITE_EXTRA_HOSTS in README
+
+1.3.1
+-----
+
+* Add default for SiteID in the README (PR #31)
+* Respect the CACHE_MULTISITE_ALIAS in SiteCache (PR #34)
+* Replace deprecated ExtractResult().tld with .suffic (PR #32)
+
+1.3.0
+-----
+
+* Fix tempfile issue with update_public_suffix_list command
+* Support for tldextract version >= 2.0
+
+1.2.6
+----
+
+* Pin the tldextract dependency to version < 2.0, which breaks API.
+
+1.2.5
+----
+
+* Make template loading more resilient to changes in django (thanks to jbazik for the contribution)
+
+1.2.4
+-----
+
+* Fix domain validation so it's called after the pre_save signal
+
+1.2.3
+-----
+
+* Fix a broken test, due to a django uniqueness constraint in 1.9
+
+1.2.2
+-----
+
+* Fix for 1.9: change the return type of filesystem template loader's get_template_sources()
+
+1.2.1
+-----
+
+* Remove django.utils.unittest (deprecated in 1.9)
+* Use post_migrate instead of post_syncdb in > 1.7
+
+1.2.0
+-----
+
+* We now support Django 1.9
+* Following deprecation in django, all get_cache methods have been replaced caches.
+
+1.1.0
+-----
+
+* We now support post-South Django 1.7 native migrations.
+
+1.0.0
+-----
+
+* 1.0 release. API stability promised from now on.
+* Following the deprecation in Django itself, all get_query_set methods have been renamed to get_queryset. This means Django 1.6 is now the minimum required version.
+
+0.5.1
+-----
+
+* Add key prefix tests
+
+0.5.0
+-----
+
+* Allow use of cache key prefixes from the CACHES settings if CACHE_MULTISITE_KEY_PREFIX not set

django-multisite2-2.0.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Ecometrica
+
+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.

django-multisite2-2.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include INSTALL.txt
+include README.rst
+graft multisite

django-multisite2-2.0.0/PKG-INFO

@@ -0,0 +1,246 @@
+Metadata-Version: 2.1
+Name: django-multisite2
+Version: 2.0.0
+Summary: Serve multiple sites from a single Django application
+Home-page: http://github.com/erikvw/django-multisite
+Author: Leonid S Shestera
+Author-email: leonid@shestera.ru
+Maintainer: Ecometrica
+Maintainer-email: dev@ecometrica.com
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: tldextract
+
+ |actions| |codecov| |downloads| |maintainability| |black|
+
+
+
+README
+======
+
+Python 3.11+ Django 4.2+
+
+Older versions of Django are supported by the original `django-multisite`_ project.
+
+.. _django-multisite: https://github.com/ecometrica/django-multisite
+
+
+Installation
+============
+
+Install with pip:
+
+.. code-block::
+
+    pip install django-multisite2 (no release yet)
+
+
+Replace your ``SITE_ID`` in ``settings.py`` to:
+
+.. code-block::
+
+    from multisite import SiteID
+    SITE_ID = SiteID(default=1)
+
+
+add to INSTALLED_APPS:
+
+.. code-block::
+
+    INSTALLED_APPS = [
+        ...
+        'django.contrib.sites',
+        'multisite',
+        ...
+    ]
+
+
+Edit settings.py MIDDLEWARE:
+
+.. code-block::
+
+    MIDDLEWARE = (
+        ...
+        'multisite.middleware.DynamicSiteMiddleware',
+        ...
+    )
+
+
+Using a custom cache
+--------------------
+Append to settings.py, in order to use a custom cache that can be
+safely cleared::
+
+    # The cache connection to use for django-multisite.
+    # Default: 'default'
+    CACHE_MULTISITE_ALIAS = 'multisite'
+
+    # The cache key prefix that django-multisite should use.
+    # If not set, defaults to the KEY_PREFIX used in the defined
+    # CACHE_MULTISITE_ALIAS or the default cache (empty string if not set)
+    CACHE_MULTISITE_KEY_PREFIX = ''
+
+If you have set CACHE\_MULTISITE\_ALIAS to a custom value, *e.g.*
+``'multisite'``, add a separate backend to settings.py CACHES::
+
+    CACHES = {
+        'default': {
+            ...
+        },
+        'multisite': {
+            'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
+            'TIMEOUT': 60 * 60 * 24,  # 24 hours
+            ...
+        },
+    }
+
+
+Domain fallbacks
+----------------
+
+By default, if the domain name is unknown, multisite will respond with
+an HTTP 404 Not Found error. To change this behaviour, add to
+settings.py::
+
+    # The view function or class-based view that django-multisite will
+    # use when it cannot match the hostname with a Site. This can be
+    # the name of the function or the function itself.
+    # Default: None
+    MULTISITE_FALLBACK = 'django.views.generic.base.RedirectView
+
+    # Keyword arguments for the MULTISITE_FALLBACK view.
+    # Default: {}
+    MULTISITE_FALLBACK_KWARGS = {'url': 'http://example.com/',
+                                 'permanent': False}
+
+Templates
+---------
+If required, create template subdirectories for domain level templates (in a
+location specified in settings.TEMPLATES['DIRS'].
+
+Multisite's template loader will look for templates in folders with the names of
+domains, such as::
+
+    templates/example.com
+
+
+The template loader will also look for templates in a folder specified by the
+optional MULTISITE_DEFAULT_TEMPLATE_DIR setting, e.g.::
+
+    templates/multisite_templates
+
+
+Cross-domain cookies
+--------------------
+
+In order to support `cross-domain cookies`_,
+for purposes like single-sign-on,
+prepend the following to the top of
+settings.py MIDDLEWARE (MIDDLEWARE_CLASSES for Django < 1.10)::
+
+    MIDDLEWARE = (
+        'multisite.middleware.CookieDomainMiddleware',
+        ...
+    )
+
+CookieDomainMiddleware will consult the `Public Suffix List`_
+for effective top-level domains.
+It caches this file
+in the system's default temporary directory
+as ``effective_tld_names.dat``.
+To change this in settings.py::
+
+    MULTISITE_PUBLIC_SUFFIX_LIST_CACHE = '/path/to/multisite_tld.dat'
+
+By default,
+any cookies without a domain set
+will be reset to allow \*.domain.tld.
+To change this in settings.py::
+
+    MULTISITE_COOKIE_DOMAIN_DEPTH = 1  # Allow only *.subdomain.domain.tld
+
+In order to fetch a new version of the list,
+run::
+
+    manage.py update_public_suffix_list
+
+.. _cross-domain cookies: http://en.wikipedia.org/wiki/HTTP_cookie#Domain_and_Path
+.. _Public Suffix List: http://publicsuffix.org/
+
+Post-migrate signal: post_migrate_sync_alias
+--------------------------------------------
+The ``post-migrate`` signal ``post_migrate_sync_alias`` is registered in the ``apps.py``. ``post_migrate_sync_alias``
+ensures the ``domain`` in multisite's ``Alias`` model is updated to match that of django's ``Site`` model. This signal must
+run AFTER any ``post-migrate`` signals that manipulate Django's ``Site`` model. If you have an app that manipulates Django's
+``Site`` model, place it before ``multisite`` in `settings. INSTALLED_APPS`. If this is not possible, you may configure ``multisite``
+to not connect the ``post-migrate`` signal in ``apps.py`` so that you can do it somewhere else in your code.
+
+To configure `multisite` to not connect the `post-post_migrate_sync_alias` in the `apps.py`, update your settings::
+
+    MULTISITE_REGISTER_POST_MIGRATE_SYNC_ALIAS = False
+
+With the `settings` attribute set to `False`, it is your responsibility to connect the signal in your code. Note that if you do not sync the `Alias` and `Site`
+models after the `Site` model has changed, multisite may not recognize the domain and switch to the fallback view or
+raise a `Http404` error.
+
+Development Environments
+------------------------
+Multisite returns a valid Alias when in "development mode" (defaulting to the
+alias associated with the default SiteID.
+
+Development mode is either:
+    - Running tests, i.e. manage.py test
+    - Running locally in settings.DEBUG = True, where the hostname is a top-level name, i.e. localhost
+
+In order to have multisite use aliases in local environments, add entries to
+your local etc/hosts file to match aliases in your applications.  E.g. ::
+
+    127.0.0.1 example.com
+    127.0.0.1 examplealias.com
+
+And access your application at example.com:8000 or examplealias.com:8000 instead of
+the usual localhost:8000.
+
+Tests
+-----
+
+To run the tests::
+
+    python runtests.py
+
+
+
+.. |pypi| image:: https://img.shields.io/pypi/v/django-multisite2.svg
+  :target: https://pypi.python.org/pypi/django-multisite2
+
+.. |actions| image:: https://github.com/erikvw/django-multisite2/actions/workflows/build.yml/badge.svg
+  :target: https://github.com/erikvw/django-multisite2/actions/workflows/build.yml
+
+.. |codecov| image:: https://codecov.io/gh/erikvw/django-multisite2/branch/develop/graph/badge.svg
+  :target: https://codecov.io/gh/erikvw/django-multisite2
+
+.. |downloads| image:: https://pepy.tech/badge/django-multisite2
+   :target: https://pepy.tech/project/django-multisite2
+
+.. |maintainability| image:: https://api.codeclimate.com/v1/badges/4992e131641fc6929b1a/maintainability
+   :target: https://codeclimate.com/github/erikvw/django-multisite2/maintainability
+   :alt: Maintainability
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/ambv/black
+   :alt: Code Style
+