Merge remote-tracking branch 'origin/master' into feat/resolve-duplic…

…ate-tags
jazzband · Sep 28, 2024 · 9c1538b · 9c1538b
2 parents f4effb2 + 3d42581
commit 9c1538b
Show file tree

Hide file tree

Showing 41 changed files with 21,751 additions and 101 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -6,7 +6,9 @@ Changelog
 * Add a management command (``remove_orphaned_tags``) to remove orphaned tags
 * Add a fallback for when multiple tags are found in case-insensitivity mode (the earliest by PK is returned)
 * Add a ``deduplicate_tags`` management command to remove duplicate tags based on case insensitivity. This feature is enabled when ``TAGGIT_CASE_INSENSITIVE`` is set to ``True`` in the settings.
+* We no longer package tests, docs, or the sample taggit app into the distributed wheels. While we believe this shouldn't affect anything for users of the library, please tell us if you find yourself hitting issues (like around import errors)
 
+>>>>>>> origin/master
 
 6.0.0 (2024-07-27)
 ~~~~~~~~~~~~~~~~~~

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -48,10 +48,40 @@ Running the sample application
 
 There is a sample application in ``sample_taggit``. You can run it by doing the following:
 
-- Run migrations with ``sample_taggit/manage.py migrate``
-- Make yourself a superuser with ``sample_taggit/manage.py createsuperuser`` (this should let you use the admin with ease)
-- Launch the sample project itself with ``sample_taggit/manage.py runserver``
 
+**Prepare the Database**
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Use the `reset-db` command to prepare your database. This will remove any existing data, run migrations, and load fixtures, including creating a default admin user.
+
+**On Windows:**
+
+.. code-block:: console
+
+     cd sample_taggit
+     call make.bat reset-db
+
+**On Mac/Linux:**
+
+.. code-block:: console
+
+     cd sample_taggit
+     make reset-db
+
+**Launch the Sample Project**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Launch the sample project itself with:
+
+.. code-block:: console
+
+     sample_taggit/manage.py runserver
+
+**Default Admin User Login:**
+
+Username: taggit
+
+Password: admin
 
 Follow style conventions (black, flake8, isort)
 -----------------------------------------------

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -2,7 +2,10 @@ include AUTHORS
 include CHANGELOG.rst
 include LICENSE
 include README.rst
-include tox.ini
-recursive-include docs *.py *.rst
+include setup.cfg
+include setup.py
+recursive-include taggit *.py
 recursive-include taggit/locale *.mo *.po
-recursive-include tests *.html *.py
+prune tests
+prune sample_taggit
+prune docs
diff --git a/sample_taggit/admin.py b/sample_taggit/admin.py
diff --git a/sample_taggit/fixtures/0001_users.json b/sample_taggit/fixtures/0001_users.json
@@ -0,0 +1,20 @@
+[
+{
+  "model": "auth.user",
+  "pk": 1,
+  "fields": {
+    "password": "pbkdf2_sha256$720000$KnQUl5xpmqQF2aWaANeHIG$kO4C7iRjRpDfUNwWgvXyCtmfoCQqOHUTHCO2IvrH58U=",
+    "last_login": "2024-07-28T13:26:52.011Z",
+    "is_superuser": true,
+    "username": "taggit",
+    "first_name": "",
+    "last_name": "",
+    "email": "",
+    "is_staff": true,
+    "is_active": true,
+    "date_joined": "2024-07-27T17:02:40.676Z",
+    "groups": [],
+    "user_permissions": []
+  }
+}
+]