add dependency drain-swamp-snippet

- feat: use package drain-swamp-snippet - refactor: remove module drain_swamp.snip - chore: add build requirement dependency drain-swamp-snippet
msftcangoblowm · Sep 20, 2024 · f99109f · f99109f
1 parent cdb411c
commit f99109f
Show file tree

Hide file tree

Showing 62 changed files with 303 additions and 1,898 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -42,6 +42,10 @@ Changelog
    Commit items for NEXT VERSION
    ..............................
 
+   - feat: use package drain-swamp-snippet
+   - refactor: remove module drain_swamp.snip
+   - chore: add build requirement dependency drain-swamp-snippet
+
 .. scriv-start-here
 
 .. _changes_1-7-2:

diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -18,10 +18,11 @@ subtrees:
 - entries:
   - file: code/index
     entries:
-    - file: code/snip
     - file: code/cli_unlock
     - file: code/cli_igor
     - file: code/cli_scm_version
+    - title: Snip
+      url: https://drain-swamp-snippet.readthedocs.io/en/stable/code/snip.html#drain_swamp_snippet.snip.Snip
     - file: code/general/index
       entries:
       - file: code/general/version_file
@@ -71,7 +72,8 @@ subtrees:
         - file: code/monkey/plugins/scm_version
 - caption: Articles
   entries:
-  - file: snippets/snippets
+  - title: Anatomy of a snippet
+    url: https://drain-swamp-snippet.readthedocs.io/en/stable/overview.html
   - file: article-version-specifiers
   - file: why/about_authors
   - file: why/cringe-culture

diff --git a/docs/code/index.rst b/docs/code/index.rst
@@ -17,10 +17,14 @@ Code manual
       - :doc:`cli_igor`
       - :doc:`cli_scm_version`
 
-   .. grid-item-card:: :material-twotone:`pinch;2em;sd-text-primary` Techniques
+   .. grid-item-card:: :material-twotone:`pinch;2em;sd-text-primary` Snippet
       :class-card: sd-border-0
+      :link-type: url
+      :link: https://drain-swamp-snippet.readthedocs.io/en/stable/code/snip.html#drain_swamp_snippet.snip.Snip
+      :link-alt: Snippet base package drain-swamp-snippet has class Snip and enum ReplaceResult
 
-      - :doc:`Snip <snip>`
+      - drain_swamp_snippet.Snip
+      - drain_swamp_snippet.ReplaceResult
 
    .. grid-item-card:: :material-twotone:`lock_open;2em;sd-text-success` Dependency locking
       :class-card: sd-border-0

diff --git a/docs/code/snip.rst b/docs/code/snip.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -159,6 +159,10 @@
         "https://github.com/pypa/setuptools/blob",
         ("objects-setuptools.inv", "objects-setuptools.txt"),
     ),
+    "dss": (
+        "https://drain-swamp-snippet.readthedocs.io/en/stable",
+        ("objects-dss.inv", "objects-dss.txt"),
+    ),
 }
 intersphinx_disabled_reftypes = ["std:doc"]
 

diff --git a/docs/getting_started/pipenv-unlock.rst b/docs/getting_started/pipenv-unlock.rst
@@ -49,7 +49,14 @@ Then link this to your ``pyproject.toml`` file
 .. code:: text
 
    [build-system]
-   requires = ["setuptools>=70.0.0", "wheel", "build", "setuptools_scm>=8", "drain_swamp"]
+   requires = [
+       "setuptools>=70.0.0",
+       "wheel",
+       "build",
+       "setuptools_scm>=8",
+       "drain-swamp",
+       "drain-swamp-snippet",
+   ]
    build-backend = "setuptools.build_meta"
 
    [project]

diff --git a/docs/getting_started/setuptools-scm.rst b/docs/getting_started/setuptools-scm.rst
@@ -7,7 +7,14 @@ pyproject.toml
 .. code-block:: text
 
    [build-system]
-   requires = ["setuptools>=70.0.0", "wheel", "build", "setuptools_scm>=8", "drain-swamp"]
+   requires = [
+       "setuptools>=70.0.0",
+       "wheel",
+       "build",
+       "setuptools_scm>=8",
+       "drain-swamp",
+       "drain-swamp-snippet",
+   ]
    build-backend = "setuptools.build_meta"
 
    [project]

diff --git a/docs/objects-dss.inv b/docs/objects-dss.inv
diff --git a/docs/objects-dss.txt b/docs/objects-dss.txt
@@ -0,0 +1,16 @@
+# Sphinx inventory version 2
+# Project: drain-swamp-snippet 0.0.1.post1
+# Version: 0.0.1.post1
+# The remainder of this file is compressed using zlib.
+drain_swamp_snippet.Snip py:class 1 code/snip.html#drain_swamp_snippet.snip.Snip -
+drain_swamp_snippet.Snip.replace py:method 1 code/snip.html#drain_swamp_snippet.snip.Snip.replace -
+drain_swamp_snippet.Snip.replace.params.replacement py:parmeter 1 code/snip.html#drain_swamp_snippet.snip.Snip.replace -
+drain_swamp_snippet.Snip.replace.params.id_ py:parmeter 1 code/snip.html#drain_swamp_snippet.snip.Snip.replace -
+drain_swamp_snippet.ReplaceResult py:class 1 code/snip.html#drain_swamp_snippet.snip.ReplaceResult -
+drain_swamp_snippet.snip.Snip py:class 1 code/snip.html#$ -
+drain_swamp_snippet.snip.Snip.replace py:method 1 code/snip.html#$ -
+drain_swamp_snippet.snip.Snip.replace.params.replacement py:parmeter 1 code/snip.html#$ -
+drain_swamp_snippet.snip.Snip.replace.params.id_ py:parmeter 1 code/snip.html#$ -
+drain_swamp_snippet.snip.ReplaceResult py:class 1 code/snip.html#$ -
+snippets std:doc -1 snippets.html snippets
+overview std:doc -1 overview.html Anatomy of a snippet
diff --git a/docs/requirements.in b/docs/requirements.in
@@ -2,7 +2,7 @@
 # For details: https://github.com/msftcangoblowm/drain-swamp/blob/master/NOTICE.txt
 
 # -c ../requirements/pins.lock
--c ../requirements/prod.in
+-r ../requirements/prod.in
 
 sphinx
 sphinx-pyproject

diff --git a/docs/requirements.lock b/docs/requirements.lock
@@ -48,6 +48,8 @@ domdf-python-tools==3.8.0.post2
     # via
     #   dom-toml
     #   sphinx-pyproject
+drain-swamp-snippet==1.0.0.post2
+    # via -r ../requirements/prod.in
 idna==3.6
     # via
     #   requests
@@ -94,7 +96,7 @@ myst-parser==2.0.0
     # via sphinx-external-toc-strict
 natsort==8.4.0
     # via domdf-python-tools
-packaging==24.0
+packaging==24.1
     # via
     #   sphinx
     #   sphinx-external-toc-strict
@@ -154,7 +156,7 @@ sphinx-copybutton==0.5.2
     # via -r docs/requirements.in
 sphinx-design==0.6.1
     # via -r docs/requirements.in
-sphinx-external-toc-strict==1.2.0
+sphinx-external-toc-strict==1.2.3.post0
     # via -r docs/requirements.in
 sphinx-favicon==1.0.1
     # via -r docs/requirements.in

diff --git a/docs/requirements.unlock b/docs/requirements.unlock
@@ -14,3 +14,4 @@ sphinx_design
 sphinx-tabs
 sphinx-favicon
 interrogate
+drain-swamp-snippet==1.0.0.post1
diff --git a/docs/snippets/index.rst b/docs/snippets/index.rst