Rename project to pymdownx-superfence-filter-lines

Also rename the wheel package to `pymdownx-superfence-filter-lines` and
the python package to `pymdownx_superfence_filter_lines`.

This is because this is really not Frequenz specific.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

.cookiecutter-replay.json

@@ -2,17 +2,17 @@
   "cookiecutter": {
     "Introduction": "",
     "type": "lib",
-    "name": "pymdownx-superfences-filter-lines",
+    "name": "pymdownx-superfence-filter-lines",
     "description": "A custom superfence for pymdown-extensions that can filters lines and plays nice with MkDocs",
     "title": "Frequenz Filter Lines Superfence",
     "keywords": "markdown, filter, mkdocs, python3, mkdocs-material, pymdownx, pymdown-extensions, superfence",
     "github_org": "frequenz-floss",
     "license": "MIT",
     "author_name": "Frequenz Energy-as-a-Service GmbH",
     "author_email": "[email protected]",
-    "python_package": "frequenz.pymdownx.superfences.filter_lines",
-    "pypi_package_name": "frequenz-pymdownx-superfences-filter-lines",
-    "github_repo_name": "frequenz-pymdownx-superfences-filter-lines-python",
+    "python_package": "pymdownx_superfence_filter_lines",
+    "pypi_package_name": "pymdownx-superfence-filter-lines",
+    "github_repo_name": "pymdownx-superfence-filter-lines-python",
     "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)",
     "_template": "gh:frequenz-floss/frequenz-repo-config-python",
     "_repo_dir": "/home/luca/.cookiecutters/frequenz-repo-config-python/cookiecutter",

.github/ISSUE_TEMPLATE/config.yml

@@ -4,5 +4,5 @@
 blank_issues_enabled: true
 contact_links:
   - name: Ask a question ❓
-    url: https://github.com/frequenz-floss/frequenz-pymdownx-superfences-filter-lines-python/discussions/new?category=support
+    url: https://github.com/frequenz-floss/pymdownx-superfence-filter-lines-python/discussions/new?category=support
     about: Use this if you are not sure how to do something, have installation problems, etc.

.github/labeler.yml

@@ -9,10 +9,10 @@
 # For example:
 #
 # "part:module":
-#   - "src/frequenz/pymdownx/superfences/filter_lines/module/**"
+#   - "src/pymdownx_superfence_filter_lines/module/**"
 #
 # "part:other":
-#   - "src/frequenz/pymdownx/superfences/filter_lines/other/**"
+#   - "src/pymdownx_superfence_filter_lines/other/**"
 #
 # # For excluding some files (in this example, label "part:complicated"
 # # everything inside src/ with a .py suffix, except for src/__init__.py)

CONTRIBUTING.md

@@ -139,9 +139,9 @@ These are the steps to create a new release:
 
 5. A GitHub action will test the tag and if all goes well it will create
    a [GitHub
-   Release](https://github.com/frequenz-floss/frequenz-pymdownx-superfences-filter-lines-python/releases),
+   Release](https://github.com/frequenz-floss/pymdownx-superfence-filter-lines-python/releases),
    and upload a new package to
-   [PyPI](https://pypi.org/project/frequenz-pymdownx-superfences-filter-lines/)
+   [PyPI](https://pypi.org/project/pymdownx-superfence-filter-lines/)
    automatically.
 
 6. Once this is done, reset the `RELEASE_NOTES.md` with the template:

README.md

@@ -1,8 +1,8 @@
 # Frequenz Filter Lines Superfence
 
-[![Build Status](https://github.com/frequenz-floss/frequenz-pymdownx-superfences-filter-lines-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-pymdownx-superfences-filter-lines-python/actions/workflows/ci.yaml)
-[![PyPI Package](https://img.shields.io/pypi/v/frequenz-pymdownx-superfences-filter-lines)](https://pypi.org/project/frequenz-pymdownx-superfences-filter-lines/)
-[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-pymdownx-superfences-filter-lines-python/)
+[![Build Status](https://github.com/frequenz-floss/pymdownx-superfence-filter-lines-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/pymdownx-superfence-filter-lines-python/actions/workflows/ci.yaml)
+[![PyPI Package](https://img.shields.io/pypi/v/pymdownx-superfence-filter-lines)](https://pypi.org/project/pymdownx-superfence-filter-lines/)
+[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/pymdownx-superfence-filter-lines-python/)
 
 ## Introduction
 
@@ -82,8 +82,8 @@ markdown_extensions:
       custom_fences:
         - name: "*"
           class: "highlight"
-          format: !!python/name:frequenz.pymdownx.superfences.filter_lines.do_format
-          validator: !!python/name:frequenz.pymdownx.superfences.filter_lines.do_validate
+          format: !!python/name:pymdownx_superfence_filter_lines.do_format
+          validator: !!python/name:pymdownx_superfence_filter_lines.do_validate
 ```
 
 ### Standalone
@@ -92,11 +92,11 @@ To use this superfence standalone, you can use something like this:
 
 ```python
 import markdown
-from frequenz.pymdownx.superfences.filter_lines import do_format, do_validate
+from pymdownx_superfence_filter_lines import do_format, do_validate
 
 html = markdown.markdown(
     markdown_source,
-    extensions=['pymdownx.superfences'],
+    extensions=['pymdownx.superfence'],
     extension_configs={
         "pymdownx.superfences": {
             "custom_fences": [

mkdocs.yml

@@ -6,8 +6,8 @@ site_name: "Frequenz Filter Lines Superfence"
 site_description: "A custom superfence for pymdown-extensions that can filters lines and plays nice with MkDocs"
 site_author: "Frequenz Energy-as-a-Service GmbH"
 copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
-repo_name: "frequenz-pymdownx-superfences-filter-lines-python"
-repo_url: "https://github.com/frequenz-floss/frequenz-pymdownx-superfences-filter-lines-python"
+repo_name: "pymdownx-superfence-filter-lines-python"
+repo_url: "https://github.com/frequenz-floss/pymdownx-superfence-filter-lines-python"
 edit_uri: "edit/v0.x.x/docs/"
 strict: true  # Treat warnings as errors
 
@@ -82,8 +82,8 @@ markdown_extensions:
           format: !!python/name:pymdownx.superfences.fence_code_format
         - name: "*"
           class: "highlight"
-          format: !!python/name:frequenz.pymdownx.superfences.filter_lines.do_format
-          validator: !!python/name:frequenz.pymdownx.superfences.filter_lines.do_validate
+          format: !!python/name:pymdownx_superfence_filter_lines.do_format
+          validator: !!python/name:pymdownx_superfence_filter_lines.do_validate
   - pymdownx.tabbed
   - pymdownx.tasklist:
       custom_checkbox: true

pyproject.toml

@@ -10,7 +10,7 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "frequenz-pymdownx-superfences-filter-lines"
+name = "pymdownx-superfence-filter-lines"
 description = "A custom superfence for pymdown-extensions that can filters lines and plays nice with MkDocs"
 readme = "README.md"
 license = { text = "MIT" }
@@ -19,7 +19,7 @@ keywords = [
   "python",
   "lib",
   "library",
-  "pymdownx-superfences-filter-lines",
+  "pymdownx-superfence-filter-lines",
   "markdown",
   "filter",
   "mkdocs",
@@ -70,13 +70,13 @@ dev-mypy = [
   "mypy == 1.7.1",
   "types-Markdown == 3.5.0.3",
   # For checking the noxfile, docs/ script, and tests
-  "frequenz-pymdownx-superfences-filter-lines[dev-mkdocs,dev-noxfile,dev-pytest]",
+  "pymdownx-superfence-filter-lines[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-noxfile = ["nox == 2023.4.22", "frequenz-repo-config[lib] == 0.7.5"]
 dev-pylint = [
   "pylint == 3.0.3",
   # For checking the noxfile, docs/ script, and tests
-  "frequenz-pymdownx-superfences-filter-lines[dev-mkdocs,dev-noxfile,dev-pytest]",
+  "pymdownx-superfence-filter-lines[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
   "pytest == 7.4.3",
@@ -86,15 +86,15 @@ dev-pytest = [
   "async-solipsism == 0.5",
 ]
 dev = [
-  "frequenz-pymdownx-superfences-filter-lines[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
+  "pymdownx-superfence-filter-lines[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
 ]
 
 [project.urls]
-Documentation = "https://frequenz-floss.github.io/frequenz-pymdownx-superfences-filter-lines-python/"
-Changelog = "https://github.com/frequenz-floss/frequenz-pymdownx-superfences-filter-lines-python/releases"
-Issues = "https://github.com/frequenz-floss/frequenz-pymdownx-superfences-filter-lines-python/issues"
-Repository = "https://github.com/frequenz-floss/frequenz-pymdownx-superfences-filter-lines-python"
-Support = "https://github.com/frequenz-floss/frequenz-pymdownx-superfences-filter-lines-python/discussions/categories/support"
+Documentation = "https://frequenz-floss.github.io/pymdownx-superfence-filter-lines-python/"
+Changelog = "https://github.com/frequenz-floss/pymdownx-superfence-filter-lines-python/releases"
+Issues = "https://github.com/frequenz-floss/pymdownx-superfence-filter-lines-python/issues"
+Repository = "https://github.com/frequenz-floss/pymdownx-superfence-filter-lines-python"
+Support = "https://github.com/frequenz-floss/pymdownx-superfence-filter-lines-python/discussions/categories/support"
 
 [tool.black]
 line-length = 88
@@ -158,7 +158,7 @@ namespace_packages = true
 # used but getting the original ignored error when removing the type: ignore.
 # See for example: https://github.com/python/mypy/issues/2960
 #no_incremental = true
-packages = ["frequenz.pymdownx.superfences.filter_lines"]
+modules = ["pymdownx_superfence_filter_lines"]
 strict = true
 
 [[tool.mypy.overrides]]

src/frequenz/pymdownx/superfences/filter_lines/__init__.py renamed to src/pymdownx_superfence_filter_lines/__init__.py

@@ -131,7 +131,7 @@ def parse(cls, text: str) -> tuple[Self | None, list[ValueError]]:
 
         The string must be a comma-separated list of ranges, where each range is in the
         format described in
-        [`LinesRange.parse`][frequenz.pymdownx.superfences.filter_lines.LinesRange.parse].
+        [`LinesRange.parse`][pymdownx_superfence_filter_lines.LinesRange.parse].
 
         If no ranges are given, `None` is returned. If any ranges are invalid, they are
         ignored and a list of errors is returned.