✨ Fill out the project name

.github/workflows/ci-cd.yml

@@ -68,7 +68,7 @@ env:
   PIP_NO_PYTHON_VERSION_WARNING: 1  # Hide "this Python is deprecated" message
   PIP_NO_WARN_SCRIPT_LOCATION: 1  # Hide "script dir is not in $PATH" message
   PRE_COMMIT_COLOR: always
-  PROJECT_NAME: <FILL-IN-PYPI-PROJECT-NAME-HERE>
+  PROJECT_NAME: awx_plugins.interfaces
   PUBLISHING_TO_TESTPYPI_ENABLED: true
   PY_COLORS: 1  # Recognized by the `py` package, dependency of `pytest`
   PYTHONIOENCODING: utf-8

CONTRIBUTING.md

@@ -4,7 +4,7 @@ This project is [Apache-2.0 licensed] and accepts contributions through
 GitHub pull requests.
 
 [Apache-2.0 licensed]:
-https://github.com/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/blob/devel/LICENSE
+https://github.com/ansible/awx_plugins.interfaces/blob/devel/LICENSE
 
 ## Certificate of Origin
 
@@ -13,7 +13,7 @@ Origin (DCO). This document was created by the Linux Kernel community and is a
 simple statement that you, as a contributor, have the legal right to make the
 contribution. See the [DCO] file for details.
 
-[DCO]: https://github.com/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/blob/devel/DCO
+[DCO]: https://github.com/ansible/awx_plugins.interfaces/blob/devel/DCO
 
 ## Principles
 
@@ -27,7 +27,7 @@ This repository adheres to the following principles:
   alignment with the project objectives principles.
 
 [Code of Conduct]:
-https://github.com/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/blob/devel/CODE-OF-CONDUCT.md
+https://github.com/ansible/awx_plugins.interfaces/blob/devel/CODE-OF-CONDUCT.md
 
 ## How to contribute
 

README.md

@@ -11,28 +11,28 @@
 [![Ansible Discourse Badge]][Ansible Discourse]
 
 [CI/CD Badge]:
-https://github.com/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/actions/workflows/ci-cd.yml/badge.svg?branch=devel
-[CI/CD]: https://github.com/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/actions/workflows/ci-cd.yml
+https://github.com/ansible/awx_plugins.interfaces/actions/workflows/ci-cd.yml/badge.svg?branch=devel
+[CI/CD]: https://github.com/ansible/awx_plugins.interfaces/actions/workflows/ci-cd.yml
 
 [pre-commit.ci Badge]:
-https://results.pre-commit.ci/badge/github/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/devel.svg
+https://results.pre-commit.ci/badge/github/ansible/awx_plugins.interfaces/devel.svg
 [pre-commit.ci]:
-https://results.pre-commit.ci/latest/github/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/devel
+https://results.pre-commit.ci/latest/github/ansible/awx_plugins.interfaces/devel
 
-[PyPI Badge]: https://img.shields.io/pypi/v/<FILL-IN-PYPI-PROJECT-NAME-HERE>
-[PyPI]: https://pypi.org/p/<FILL-IN-PYPI-PROJECT-NAME-HERE>
+[PyPI Badge]: https://img.shields.io/pypi/v/awx_plugins.interfaces
+[PyPI]: https://pypi.org/p/awx_plugins.interfaces
 
-[PyPI Supported Versions Badge]: https://img.shields.io/pypi/pyversions/<FILL-IN-PYPI-PROJECT-NAME-HERE>.svg
-[PyPI Supported Versions]: https://pypi.org/p/<FILL-IN-PYPI-PROJECT-NAME-HERE>
+[PyPI Supported Versions Badge]: https://img.shields.io/pypi/pyversions/awx_plugins.interfaces.svg
+[PyPI Supported Versions]: https://pypi.org/p/awx_plugins.interfaces
 
-[Codecov Badge]: https://codecov.io/gh/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/branch/devel/graph/badge.svg
-[Codecov]: https://app.codecov.io/gh/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>
+[Codecov Badge]: https://codecov.io/gh/ansible/awx_plugins.interfaces/branch/devel/graph/badge.svg
+[Codecov]: https://app.codecov.io/gh/ansible/awx_plugins.interfaces
 
 [Code of Conduct Badge]: https://img.shields.io/badge/code%20of%20conduct-Ansible-yellow.svg
 [Code of Conduct]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
 
 [Apache v2 License Badge]: https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg
-[Apache v2 License]: https://github.com/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/blob/devel/LICENSE
+[Apache v2 License]: https://github.com/ansible/awx_plugins.interfaces/blob/devel/LICENSE
 
 [Ansible Matrix Badge]:
 https://img.shields.io/badge/matrix-Ansible%20Community-blueviolet.svg?logo=matrix
@@ -46,11 +46,11 @@ https://img.shields.io/badge/discourse-Ansible%20Community-yellowgreen.svg?logo=
 [![RTD Build Status Badge]][RTD Docs]
 
 [RTD Build Status Badge]:
-https://readthedocs.org/projects/<FILL-IN-PYPI-PROJECT-NAME-HERE>/badge/?version=latest
-[RTD Docs]: https://<FILL-IN-PYPI-PROJECT-NAME-HERE>.rtfd.io
+https://readthedocs.org/projects/awx-plugins-interfaces/badge/?version=latest
+[RTD Docs]: https://awx-plugins-interfaces.rtfd.io
 
-# <FILL-IN-PYPI-PROJECT-NAME-HERE>
+# awx_plugins.interfaces
 
 <!-- DO-NOT-REMOVE-docs-intro-START -->
-<FILL-IN-A-SHORT-PYPI-PROJECT-DESCRIPTION-HERE>
+Common interfaces for implementing plugins to AWX.
 <!-- DO-NOT-REMOVE-docs-intro-END -->

docs/conf.py

@@ -33,7 +33,7 @@
 sys.path.insert(0, str(DOCS_ROOT_DIR / '_ext'))
 
 
-project = '<FILL-IN-PYPI-PROJECT-NAME-HERE>'
+project = 'awx_plugins.interfaces'
 author = 'Ansible maintainers and contributors'
 copyright = author  # pylint: disable=redefined-builtin
 

docs/contributing/release_guide.md

@@ -60,4 +60,4 @@ The intended audience for this document is maintainers and core contributors.
 
 
 [GitHub Actions CI/CD workflow]:
-https://github.com/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/actions/workflows/ci-cd.yml
+https://github.com/ansible/awx_plugins.interfaces/actions/workflows/ci-cd.yml

docs/index.md

@@ -3,7 +3,7 @@
 
 <!-- markdownlint-disable first-line-heading -->
 
-(\_<FILL-IN-SNAKE_CASED-PROJECT-NAME-HERE>_index)=
+(\_awx_plugins_interfaces_index)=
 # {{ project }} Documentation
 
 
@@ -32,7 +32,7 @@ Code Of Conduct <contributing/code_of_conduct>
 contributing/guidelines
 contributing/communication
 contributing/security
-Private unsupported (dev) API autodoc <pkg/<FILL-IN-PYPI-PROJECT-NAME-HERE>>
+Private unsupported (dev) API autodoc <pkg/awx_plugins.interfaces>
 ```
 
 ```{toctree}

pyproject.toml

@@ -9,9 +9,9 @@ requires = [
 build-backend = "setuptools.build_meta"  # must be set always
 
 [project]
-name = "<FILL-IN-PYPI-PROJECT-NAME-HERE>"
+name = "awx_plugins.interfaces"
 # version =  # should remain unset when `setuptools-scm` is handling it
-description = "<FILL-IN-A-SHORT-PYPI-PROJECT-DESCRIPTION-HERE>"
+description = "Common interfaces for implementing plugins to AWX."
 dependencies = [  # runtime deps  # https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#dependencies-optional-dependencies
   # GUIDANCE: only add things that this project imports directly
   # GUIDANCE: only set lower version bounds
@@ -93,9 +93,9 @@ content-type = "text/markdown"
 Homepage = "https://docs.ansible.com"
 "Chat: Discuss Forum" = "https://forum.ansible.com"
 "Chat: Matrix" = "https://matrix.to/#/#awx:ansible.com"
-"CI: GitHub" = "https://github.com/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/actions/workflows/ci-cd.yml"
-"Docs: RTD" = "https://<FILL-IN-PYPI-PROJECT-NAME-HERE>.rtfd.io"
-"GitHub: issues" = "https://github.com/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>/issues"
-"GitHub: repo" = "https://github.com/ansible/<FILL-IN-PYPI-PROJECT-NAME-HERE>"
+"CI: GitHub" = "https://github.com/ansible/awx_plugins.interfaces/actions/workflows/ci-cd.yml"
+"Docs: RTD" = "https://awx-plugins-interfaces.rtfd.io"
+"GitHub: issues" = "https://github.com/ansible/awx_plugins.interfaces/issues"
+"GitHub: repo" = "https://github.com/ansible/awx_plugins.interfaces"
 
 [tool.setuptools_scm]  # this section presence is a feature-flag to activate `setuptools-scm`

pytest.ini

@@ -53,7 +53,7 @@ junit_duration_report = call
 junit_family = xunit1
 junit_logging = all
 junit_log_passing_tests = true
-junit_suite_name = <FILL-IN-SNAKE_CASED-PROJECT-NAME-HERE>_test_suite
+junit_suite_name = awx_plugins_test_suite
 
 # A mapping of markers to their descriptions allowed in strict mode:
 markers =