Rename project

.github/workflows/ci.yml

@@ -12,6 +12,6 @@ jobs:
     - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
-    - uses: sksat/setup-rye@v0.10.0
+    - uses: sksat/setup-rye@v0.23.1
     - run: make install
     - run: make test

LICENSE

@@ -1,6 +1,8 @@
 MIT License
 
-Copyright (c) 2020 Saurabh Kumar
+Copyright for portions of project mkdocs-argref-plugin are held by [Saurabh Kumar, 2020] as
+part of project Autolink References. All other copyright for project mkdocs-argref-plugin
+are held by [Richard Shadrach, 2024].
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,26 +1,27 @@
-# Autolink References (MkDocs Plugin)
+# mkdocs-argref-plugin
 
-[![PyPI - Version](https://img.shields.io/pypi/v/autolink-references-mkdocs-plugin)](https://pypi.org/project/autolink-references-mkdocs-plugin/)
+[![PyPI - Version](https://img.shields.io/pypi/v/mkdocs-argref-plugin)](https://pypi.org/project/mkdocs-argref-plugin/)
 
 
 This [mkdocs plugin](http://www.mkdocs.org/user-guide/plugins/)
 look in each MkDocs article for the presence of a reference to tickets from issues
 trackers like Jira, Linear, etc and convert them to links that point to respective
-platforms:
+platforms. Unlike similar plugins, `argref` takes an argument that can be utilized
+in the URL.
 
 
 ## Getting started
 To install it, using `pip`:
 
 ```
-pip install autolink-references-mkdocs-plugin
+pip install mkdocs-argref-plugin
 ```
 
 Edit your `mkdocs.yml` file and add these few lines of code:
 
 ```yaml
 plugins:
-   - autolink_references:
+   - argref:
         autolinks:
             - reference_prefix: AF-
               target_url: https://linear.com/AF-<num>
@@ -66,4 +67,4 @@ Changelog:
 
 MIT
 
-Built with ❤️ by [Saurabh Kumar](https://saurabh-kumar.com?ref=autolink-references-mkdocs-plugin)
+Originally built with ❤️ by [Saurabh Kumar](https://saurabh-kumar.com?ref=autolink-references-mkdocs-plugin)

pyproject.toml

@@ -1,8 +1,9 @@
 [project]
-name = "autolink-references-mkdocs-plugin"
+name = "mkdocs-argref-plugin"
 description = "This plugin allows to configure your own autolink references for non-GitHub URLs."
 authors = [
-    { name = "Saurabh Kumar", email = "[email protected]" }
+    { name = "Saurabh Kumar", email = "[email protected]" },
+    { name = "Richard Shadrach", email = "[email protected]" },
 ]
 readme = "README.md"
 license = "MIT"
@@ -14,6 +15,7 @@ keywords = [
     'autolinks',
     'mkdocs',
     'regex',
+    'github',
 ]
 
 classifiers=[
@@ -32,12 +34,12 @@ classifiers=[
 ]
 
 [project.entry-points."mkdocs.plugins"]
-"autolink_references" = "autolink_references:AutolinkReference"
+"argref" = "argref:AutolinkReference"
 
 [project.urls]
-Documentation = "https://github.com/theskumar/autolink-references-mkdocs-plugin/tree/main#readme"
-Source = "https://github.com/theskumar/autolink-references-mkdocs-plugin"
-Tracker = "https://github.com/theskumar/autolink-references-mkdocs-plugin/issues"
+Documentation = "https://github.com/rhshadrach/mkdocs-argref-plugin/tree/main#readme"
+Source = "https://github.com/rhshadrach/mkdocs-argref-plugin"
+Tracker = "https://github.com/rhshadrach/mkdocs-argref-plugin/issues"
 
 [build-system]
 requires = ["hatchling"]
@@ -60,7 +62,7 @@ include = [
 ]
 
 [tool.hatch.build.targets.wheel]
-packages = ["src/autolink_references"]
+packages = ["src/argref"]
 
 [tool.hatch.version]
-path = "src/autolink_references/__about__.py"
+path = "src/argref/__about__.py"

tests/test_parser.py

@@ -1,6 +1,6 @@
 import pytest
 
-from autolink_references.main import replace_autolink_references as autolink
+from argref.main import replace_autolink_references as autolink
 
 simple_replace = [
     ("TAG-<num>", "http://gh/<num>", "TAG-123", "[TAG-123](http://gh/123)"),