From 9634cbfb98d981c638b3b8ece206b26ae4e7e89d Mon Sep 17 00:00:00 2001 From: Rob Hudson Date: Sun, 27 Oct 2024 14:22:43 -0700 Subject: [PATCH] Update references to point to django-commons repo --- CONTRIBUTING.md | 6 ++---- README.rst | 16 ++++++---------- debug_toolbar/panels/sql/panel.py | 2 +- debug_toolbar/panels/sql/tracking.py | 6 +++--- debug_toolbar/toolbar.py | 2 +- docs/configuration.rst | 2 +- docs/contributing.rst | 21 ++++++++------------- docs/installation.rst | 4 ++-- example/test_views.py | 2 +- pyproject.toml | 8 +------- tests/panels/test_request.py | 4 ++-- tests/test_integration_async.py | 2 +- 12 files changed, 29 insertions(+), 46 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 829a22ace..470c5ccdf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,5 @@ -[![Jazzband](https://jazzband.co/static/img/jazzband.svg)](https://jazzband.co/) - -This is a [Jazzband](https://jazzband.co/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://jazzband.co/about/conduct) and follow the [guidelines](https://jazzband.co/about/guidelines). +This is a [Django Commons](https://github.com/django-commons/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md). Please see the -[full contributing documentation](https://django-debug-toolbar.readthedocs.io/en/stable/contributing.html) +[README](https://github.com/django-commons/membership/blob/main/README.md) for more help. diff --git a/README.rst b/README.rst index 9f62b85b5..11257c993 100644 --- a/README.rst +++ b/README.rst @@ -2,22 +2,18 @@ Django Debug Toolbar |latest-version| ===================================== -|jazzband| |build-status| |coverage| |docs| |python-support| |django-support| +|build-status| |coverage| |docs| |python-support| |django-support| .. |latest-version| image:: https://img.shields.io/pypi/v/django-debug-toolbar.svg :target: https://pypi.org/project/django-debug-toolbar/ :alt: Latest version on PyPI -.. |jazzband| image:: https://jazzband.co/static/img/badge.svg - :target: https://jazzband.co/ - :alt: Jazzband - -.. |build-status| image:: https://github.com/jazzband/django-debug-toolbar/workflows/Test/badge.svg - :target: https://github.com/jazzband/django-debug-toolbar/actions +.. |build-status| image:: https://github.com/django-commons/django-debug-toolbar/workflows/Test/badge.svg + :target: https://github.com/django-commons/django-debug-toolbar/actions/workflows/test.yml :alt: Build Status .. |coverage| image:: https://img.shields.io/badge/Coverage-94%25-green - :target: https://github.com/jazzband/django-debug-toolbar/actions/workflows/test.yml?query=branch%3Amain + :target: https://github.com/django-commons/django-debug-toolbar/actions/workflows/test.yml?query=branch%3Amain :alt: Test coverage status .. |docs| image:: https://img.shields.io/readthedocs/django-debug-toolbar/latest.svg @@ -38,7 +34,7 @@ more details about the panel's content. Here's a screenshot of the toolbar in action: -.. image:: https://raw.github.com/jazzband/django-debug-toolbar/main/example/django-debug-toolbar.png +.. image:: https://raw.github.com/django-commons/django-debug-toolbar/main/example/django-debug-toolbar.png :alt: Django Debug Toolbar screenshot In addition to the built-in panels, a number of third-party panels are @@ -59,4 +55,4 @@ itself. If you like it, please consider contributing! The Django Debug Toolbar was originally created by Rob Hudson in August 2008 and was further developed by many contributors_. -.. _contributors: https://github.com/jazzband/django-debug-toolbar/graphs/contributors +.. _contributors: https://github.com/django-commons/django-debug-toolbar/graphs/contributors diff --git a/debug_toolbar/panels/sql/panel.py b/debug_toolbar/panels/sql/panel.py index fe18a9c11..206686352 100644 --- a/debug_toolbar/panels/sql/panel.py +++ b/debug_toolbar/panels/sql/panel.py @@ -89,7 +89,7 @@ def _duplicate_query_key(query): raw_params = () if query["raw_params"] is None else tuple(query["raw_params"]) # repr() avoids problems because of unhashable types # (e.g. lists) when used as dictionary keys. - # https://github.com/jazzband/django-debug-toolbar/issues/1091 + # https://github.com/django-commons/django-debug-toolbar/issues/1091 return (query["raw_sql"], repr(raw_params)) diff --git a/debug_toolbar/panels/sql/tracking.py b/debug_toolbar/panels/sql/tracking.py index b5fc81234..477106fdd 100644 --- a/debug_toolbar/panels/sql/tracking.py +++ b/debug_toolbar/panels/sql/tracking.py @@ -53,8 +53,8 @@ def cursor(*args, **kwargs): # some code in the wild which does not follow that convention, # so we pass on the arguments even though it's not clean. # See: - # https://github.com/jazzband/django-debug-toolbar/pull/615 - # https://github.com/jazzband/django-debug-toolbar/pull/896 + # https://github.com/django-commons/django-debug-toolbar/pull/615 + # https://github.com/django-commons/django-debug-toolbar/pull/896 logger = connection._djdt_logger cursor = connection._djdt_cursor(*args, **kwargs) if logger is None: @@ -66,7 +66,7 @@ def cursor(*args, **kwargs): def chunked_cursor(*args, **kwargs): # prevent double wrapping - # solves https://github.com/jazzband/django-debug-toolbar/issues/1239 + # solves https://github.com/django-commons/django-debug-toolbar/issues/1239 logger = connection._djdt_logger cursor = connection._djdt_chunked_cursor(*args, **kwargs) if logger is not None and not isinstance(cursor, DjDTCursorWrapperMixin): diff --git a/debug_toolbar/toolbar.py b/debug_toolbar/toolbar.py index 432a1f578..edd5c369b 100644 --- a/debug_toolbar/toolbar.py +++ b/debug_toolbar/toolbar.py @@ -110,7 +110,7 @@ def should_render_panels(self): # The wsgi.multiprocess case of being True isn't supported until the # toolbar has resolved the following issue: # This type of set up is most likely - # https://github.com/jazzband/django-debug-toolbar/issues/1430 + # https://github.com/django-commons/django-debug-toolbar/issues/1430 render_panels = self.request.META.get("wsgi.multiprocess", True) return render_panels diff --git a/docs/configuration.rst b/docs/configuration.rst index e4ccc1dae..7cd6bc11b 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -406,4 +406,4 @@ could add a **debug_toolbar/base.html** template override to your project: The list of CSS variables are defined at `debug_toolbar/static/debug_toolbar/css/toolbar.css -`_ +`_ diff --git a/docs/contributing.rst b/docs/contributing.rst index 832ef4679..4d690c954 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,19 +1,14 @@ Contributing ============ -.. image:: https://jazzband.co/static/img/jazzband.svg - :target: https://jazzband.co/ - :alt: Jazzband - -This is a `Jazzband `_ project. By contributing you agree -to abide by the `Contributor Code of Conduct `_ -and follow the `guidelines `_. +This is a `Django Commons `_ project. By contributing you agree +to abide by the `Contributor Code of Conduct `_. Bug reports and feature requests -------------------------------- You can report bugs and request features in the `bug tracker -`_. +`_. Please search the existing database for duplicates before filing an issue. @@ -21,13 +16,13 @@ Code ---- The code is available `on GitHub -`_. Unfortunately, the +`_. Unfortunately, the repository contains old and flawed objects, so if you have set `fetch.fsckObjects `_ you'll have to deactivate it for this repository:: - git clone --config fetch.fsckobjects=false https://github.com/jazzband/django-debug-toolbar.git + git clone --config fetch.fsckobjects=false https://github.com/django-commons/django-debug-toolbar.git Once you've obtained a checkout, you should create a virtualenv_ and install the libraries required for working on the Debug Toolbar:: @@ -145,7 +140,7 @@ Patches ------- Please submit `pull requests -`_! +`_! The Debug Toolbar includes a limited but growing test suite. If you fix a bug or add a feature code, please consider adding proper coverage in the test @@ -176,7 +171,7 @@ You will need to `install the Transifex CLI `_. To publish a release you have to be a `django-debug-toolbar project lead at -Jazzband `__. +Django Commons `__. The release itself requires the following steps: @@ -204,7 +199,7 @@ The release itself requires the following steps: #. Push the commit and the tag. -#. Publish the release from the Jazzband website. +#. Publish the release from the Django Commons website. #. Change the default version of the docs to point to the latest release: https://readthedocs.org/dashboard/django-debug-toolbar/versions/ diff --git a/docs/installation.rst b/docs/installation.rst index ebe95bf3c..79e431176 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -31,7 +31,7 @@ instead with the following command: .. code-block:: console - $ python -m pip install -e git+https://github.com/jazzband/django-debug-toolbar.git#egg=django-debug-toolbar + $ python -m pip install -e git+https://github.com/django-commons/django-debug-toolbar.git#egg=django-debug-toolbar If you're upgrading from a previous version, you should review the :doc:`change log ` and look for specific upgrade instructions. @@ -84,7 +84,7 @@ Add ``"debug_toolbar"`` to your ``INSTALLED_APPS`` setting: ] .. note:: Check out the configuration example in the `example app - `_ + `_ to learn how to set up the toolbar to function smoothly while running your tests. diff --git a/example/test_views.py b/example/test_views.py index c3a8b96b0..f31a8b3c8 100644 --- a/example/test_views.py +++ b/example/test_views.py @@ -1,6 +1,6 @@ # Add tests to example app to check how the toolbar is used # when running tests for a project. -# See https://github.com/jazzband/django-debug-toolbar/issues/1405 +# See https://github.com/django-commons/django-debug-toolbar/issues/1405 from django.test import TestCase from django.urls import reverse diff --git a/pyproject.toml b/pyproject.toml index 57b0fc464..637fc0a16 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,18 +40,12 @@ dependencies = [ "sqlparse>=0.2", ] urls.Download = "https://pypi.org/project/django-debug-toolbar/" -urls.Homepage = "https://github.com/jazzband/django-debug-toolbar" - -[tool.hatch.build.targets.sdist] -# Jazzband's release process is limited to 2.2 metadata -core-metadata-version = "2.2" +urls.Homepage = "https://github.com/django-commons/django-debug-toolbar" [tool.hatch.build.targets.wheel] packages = [ "debug_toolbar", ] -# Jazzband's release process is limited to 2.2 metadata -core-metadata-version = "2.2" [tool.hatch.version] path = "debug_toolbar/__init__.py" diff --git a/tests/panels/test_request.py b/tests/panels/test_request.py index 316e09ed4..707b50bb4 100644 --- a/tests/panels/test_request.py +++ b/tests/panels/test_request.py @@ -92,7 +92,7 @@ def test_list_for_request_in_method_post(self): """ Verify that the toolbar doesn't crash if request.POST contains unexpected data. - See https://github.com/jazzband/django-debug-toolbar/issues/1621 + See https://github.com/django-commons/django-debug-toolbar/issues/1621 """ self.request.POST = [{"a": 1}, {"b": 2}] response = self.panel.process_request(self.request) @@ -112,7 +112,7 @@ def test_session_list_sorted_or_not(self): """ Verify the session is sorted when all keys are strings. - See https://github.com/jazzband/django-debug-toolbar/issues/1668 + See https://github.com/django-commons/django-debug-toolbar/issues/1668 """ self.request.session = { 1: "value", diff --git a/tests/test_integration_async.py b/tests/test_integration_async.py index 64e8f5a0d..c6fb88ca5 100644 --- a/tests/test_integration_async.py +++ b/tests/test_integration_async.py @@ -214,7 +214,7 @@ async def test_async_sql_page(self): # Check out the following links for more information: # https://forum.djangoproject.com/t/are-concurrent-database-queries-in-asgi-a-thing/24136/2 -# https://github.com/jazzband/django-debug-toolbar/issues/1828 +# https://github.com/django-commons/django-debug-toolbar/issues/1828 # Work that is done so far for asynchrounous database backend # https://github.com/django/deps/blob/main/accepted/0009-async.rst#the-orm