diff --git a/.idea/misc.xml b/.idea/misc.xml
index baf520f..03b18c3 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -3,5 +3,5 @@
-
+
\ No newline at end of file
diff --git a/.idea/bootstrap-python-package.iml b/.idea/mkdocs-macros-adr-summary.iml
similarity index 77%
rename from .idea/bootstrap-python-package.iml
rename to .idea/mkdocs-macros-adr-summary.iml
index 003856d..240476d 100644
--- a/.idea/bootstrap-python-package.iml
+++ b/.idea/mkdocs-macros-adr-summary.iml
@@ -4,7 +4,7 @@
-
+
\ No newline at end of file
diff --git a/.idea/modules.xml b/.idea/modules.xml
index d8c39a6..8755e02 100644
--- a/.idea/modules.xml
+++ b/.idea/modules.xml
@@ -2,7 +2,7 @@
-
+
\ No newline at end of file
diff --git a/.idea/runConfigurations/Pytest.xml b/.idea/runConfigurations/Pytest.xml
index e47c54e..121381a 100644
--- a/.idea/runConfigurations/Pytest.xml
+++ b/.idea/runConfigurations/Pytest.xml
@@ -1,6 +1,6 @@
-
+
diff --git a/README.md b/README.md
index ad6f677..7e6f8d4 100644
--- a/README.md
+++ b/README.md
@@ -1,81 +1,18 @@
-# bootstrap-python-package
+# mkdocs-macros-adr-summary
-[](https://pypi.org/project/bootstrap-python-package/)
-[](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#beta)
+[](https://pypi.org/project/mkdocs-macros-adr-summary/)
+[](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#work-in-progress)
-[](https://github.com/febus982/bootstrap-python-package/actions/workflows/python-tests.yml)
-[](https://github.com/febus982/bootstrap-python-package/actions/workflows/python-bandit.yml)
-[](https://codeclimate.com/github/febus982/bootstrap-python-package/maintainability)
-[](https://codeclimate.com/github/febus982/bootstrap-python-package/test_coverage)
+[](https://github.com/febus982/mkdocs-macros-adr-summary/actions/workflows/python-tests.yml)
+[](https://github.com/febus982/mkdocs-macros-adr-summary/actions/workflows/python-bandit.yml)
+[](https://codeclimate.com/github/febus982/mkdocs-macros-adr-summary/maintainability)
+[](https://codeclimate.com/github/febus982/mkdocs-macros-adr-summary/test_coverage)
[](https://mypy-lang.org/)
[](https://github.com/psf/black)
[](https://github.com/charliermarsh/ruff)
[](https://github.com/PyCQA/bandit)
-This template repository provides the boilerplate to create a python package.
-It is configured with all the following features:
-
-* Test suite using [pytest](https://docs.pytest.org/en/7.4.x/)
-* Typing using [mypy](https://mypy.readthedocs.io/en/stable/)
-* Linting using [ruff](https://github.com/astral-sh/ruff)
-* Code formatter using [black](https://pypi.org/project/black/)
-* Security checks using [bandit](https://github.com/PyCQA/bandit)
-* Integration with CodeClimate for code quality and coverage checks
-* CI pipeline supporting:
- * testing against multiple python versions
- * releases on [PyPI](https://pypi.org)
- * GitHub pages documentation using [mkdocs](https://www.mkdocs.org)
-
-This project doesn't currently use [tox](https://tox.wiki/en/4.11.4/index.html) or other matrix
-testing utilities. I prefer to run the tests only against the latest python locally, and run
-previous python versions directly in the CI pipeline.
-
-## How to use this repository template to create a new package
-
-* Create your github repository using this template. (The big green `Use this template` button)
-* Rename the `bootstrap_python_package` directory
-* Search and replace all the occurrences of `bootstrap-python-package` and `bootstrap_python_package`
-* Configure a pending trusted publisher on [pypi](https://pypi.org/manage/account/publishing) using the following values:
- * PyPI Project Name: what you renamed the directory `bootstrap_python_package` to (Double check `_` and `-`)
- * Owner: The github repository owner (in this case `febus982`)
- * Repository name: The github repository name (in this case `bootstrap-python-package`)
- * Workflow name: `release.yml`
-* Create a GitHub Actions secret named `CODECLIMATE_REPORTER_ID` (at URL `https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions`)
- containing the codeclimate reporter id (you can find it at `https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter`).
- If you don't want to use CodeClimate just delete `workflows/python-quality.yml`.
-* Update the badges in `README.md`! (check [shields.io](https://shields.io/) for extra badges)
-* Setup local development:
- * Clone the repository
- * Install poetry `pip install poetry`
- * Install dev dependencies with `make dev-dependencies`
-* Setup GitHub pages (this need local development setup):
- * Initialise documentation branch `poetry run mike deploy dev latest --update-aliases --push`
- * Configure GitHub Pages to deploy from the `gh-pages` branch (at URL `https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages`)
- * Add the `main` branch and the `v*.*.*` tag rules to the "deployment branches and tags" list in the `gh-pages` environment (at URL `https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments`)
-
-**IMPORTANT:** The repository is configured to deploy on the [test PyPI repository](https://test.pypi.org/).
-It's strongly recommended to create the project in the [test PyPI repository](https://test.pypi.org/) and test
-the deployment pipeline. When you're happy with the result, create the project on the official [PyPI repository](https://pypi.org/)
-and remove the marked lines in `workflows/release.yml`.
-
-## Package release
-
-This setup uses [poetry-dynamic-versioning](https://github.com/mtkennerly/poetry-dynamic-versioning).
-This means it's not necessary to commit the version in the code but the CI pipeline
-will infer it from the git tag.
-
-To release a new version, just create a new release and tag in the GitHub repository, to:
-
-* Build and deploy the python package to PyPI
-* Build and deploy a new version of the documentation to GitHub pages
-
-**IMPORTANT:** The default configuration requires the release name and the tag to follow
-the convention `vX.X.X` (semantic versioning preceded by lowercase `v`). It will publish
-the correct version on Pypi, omitting the `v` (ie. `v1.0.0` will publish `1.0.0`).
-
-This format can be customized, refer to [poetry-dynamic-versioning docs](https://github.com/mtkennerly/poetry-dynamic-versioning)
-
## Commands for development
All the common commands used during development can be run using make targets:
diff --git a/docs/index.md b/docs/index.md
index b3d1b71..7b9d885 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,75 +1 @@
-# bootstrap-python-package
-
-This template repository provides the boilerplate to create a python package.
-It is configured with all the following features:
-
-* Test suite using [pytest](https://docs.pytest.org/en/7.4.x/)
-* Typing using [mypy](https://mypy.readthedocs.io/en/stable/)
-* Linting using [ruff](https://github.com/astral-sh/ruff)
-* Code formatter using [black](https://pypi.org/project/black/)
-* Security checks using [bandit](https://github.com/PyCQA/bandit)
-* Integration with CodeClimate for code quality and coverage checks
-* CI pipeline supporting:
- * testing against multiple python versions
- * releases on [PyPI](https://pypi.org)
- * GitHub pages documentation using [mkdocs](https://www.mkdocs.org)
-
-This project doesn't currently use [tox](https://tox.wiki/en/4.11.4/index.html) or other matrix
-testing utilities. I prefer to run the tests only against the latest python locally, and run
-previous python versions directly in the CI pipeline.
-
-## How to use this repository template to create a new package
-
-* Create your github repository using this template. (The big green `Use this template` button)
-* Rename the `bootstrap_python_package` directory
-* Search and replace all the occurrences of `bootstrap-python-package` and `bootstrap_python_package`
-* Configure a pending trusted publisher on [pypi](https://pypi.org/manage/account/publishing) using the following values:
- * PyPI Project Name: what you renamed the directory `bootstrap_python_package` to (Double check `_` and `-`)
- * Owner: The github repository owner (in this case `febus982`)
- * Repository name: The github repository name (in this case `bootstrap-python-package`)
- * Workflow name: `release.yml`
-* Create a GitHub Actions secret named `CODECLIMATE_REPORTER_ID` (at URL `https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions`)
- containing the codeclimate reporter id (you can find it at `https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter`).
- If you don't want to use CodeClimate just delete `workflows/python-quality.yml`.
-* Update the badges in `README.md`! (check [shields.io](https://shields.io/) for extra badges)
-* Setup local development:
- * Clone the repository
- * Install poetry `pip install poetry`
- * Install dev dependencies with `make dev-dependencies`
-* Setup GitHub pages (this need local development setup):
- * Initialise documentation branch `poetry run mike deploy dev latest --update-aliases --push`
- * Configure GitHub Pages to deploy from the `gh-pages` branch (at URL `https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages`)
- * Add the `main` branch and the `v*.*.*` tag rules to the "deployment branches and tags" list in the `gh-pages` environment (at URL `https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments`)
-
-**IMPORTANT:** The repository is configured to deploy on the [test PyPI repository](https://test.pypi.org/).
-It's strongly recommended to create the project in the [test PyPI repository](https://test.pypi.org/) and test
-the deployment pipeline. When you're happy with the result, create the project on the official [PyPI repository](https://pypi.org/)
-and remove the marked lines in `workflows/release.yml`.
-
-## Package release
-
-This setup uses [poetry-dynamic-versioning](https://github.com/mtkennerly/poetry-dynamic-versioning).
-This means it's not necessary to commit the version in the code but the CI pipeline
-will infer it from the git tag.
-
-To release a new version, just create a new release and tag in the GitHub repository, to:
-
-* Build and deploy the python package to PyPI
-* Build and deploy a new version of the documentation to GitHub pages
-
-**IMPORTANT:** The default configuration requires the release name and the tag to follow
-the convention `vX.X.X` (semantic versioning preceded by lowercase `v`). It will publish
-the correct version on Pypi, omitting the `v` (ie. `v1.0.0` will publish `1.0.0`).
-
-This format can be customized, refer to [poetry-dynamic-versioning docs](https://github.com/mtkennerly/poetry-dynamic-versioning)
-
-## Commands for development
-
-All the common commands used during development can be run using make targets:
-
-* `make dev-dependencies`: Install dev requirements
-* `make update-dependencies`: Update dev requirements
-* `make test`: Run test suite
-* `make check`: Run tests, code style and lint checks
-* `make fix`: Run code style and lint automatic fixes (where possible)
-* `make docs`: Render the mkdocs website locally
+# mkdocs-macros-adr-summary
diff --git a/mkdocs.yml b/mkdocs.yml
index 9e1f3bd..a4126f3 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -4,8 +4,8 @@ site_name: Bootstrap python package
site_description: 'A manager to easily handle multiple SQLAlchemy configurations'
site_author: 'Federico Busetti'
docs_dir: docs/
-repo_name: 'febus982/bootstrap-python-package'
-repo_url: 'https://github.com/febus982/bootstrap-python-package'
+repo_name: 'febus982/mkdocs-macros-adr-summary'
+repo_url: 'https://github.com/febus982/mkdocs-macros-adr-summary'
plugins:
- search
diff --git a/bootstrap_python_package/__init__.py b/mkdocs_macros_adr_summary/__init__.py
similarity index 100%
rename from bootstrap_python_package/__init__.py
rename to mkdocs_macros_adr_summary/__init__.py
diff --git a/bootstrap_python_package/py.typed b/mkdocs_macros_adr_summary/py.typed
similarity index 100%
rename from bootstrap_python_package/py.typed
rename to mkdocs_macros_adr_summary/py.typed
diff --git a/pyproject.toml b/pyproject.toml
index f3ad60b..7be8d35 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,13 +1,13 @@
[tool.poetry]
-name = "bootstrap-python-package"
+name = "mkdocs-macros-adr-summary"
version = "0.0.0"
description = "A manager to easily handle multiple SQLAlchemy configurations"
license = "MIT"
authors = ["Federico Busetti <729029+febus982@users.noreply.github.com>"]
-repository = "https://github.com/febus982/bootstrap-python-package"
-homepage = "https://febus982.github.io/bootstrap-python-package"
+repository = "https://github.com/febus982/mkdocs-macros-adr-summary"
+homepage = "https://febus982.github.io/mkdocs-macros-adr-summary"
readme = "README.md"
-packages = [{include = "bootstrap_python_package"}]
+packages = [{include = "mkdocs_macros_adr_summary"}]
#keywords = ["add", "keywords", "here"]
classifiers = [
"Development Status :: 4 - Beta",
@@ -65,11 +65,11 @@ testpaths = [
]
[tool.mypy]
-files = "bootstrap_python_package"
+files = "mkdocs_macros_adr_summary"
[tool.coverage.run]
branch = true
-source = ["bootstrap_python_package"]
+source = ["mkdocs_macros_adr_summary"]
concurrency = ["multiprocessing"]
parallel = true
@@ -91,7 +91,7 @@ extend-exclude = ["docs"]
[tool.black]
files = '''
(
- bootstrap_python_package
+ mkdocs_macros_adr_summary
tests
)
'''
diff --git a/tests/test_bootstrap.py b/tests/test_bootstrap.py
index 15d16b5..4164485 100644
--- a/tests/test_bootstrap.py
+++ b/tests/test_bootstrap.py
@@ -1,4 +1,4 @@
-from bootstrap_python_package import some_function
+from mkdocs_macros_adr_summary import some_function
async def test_some_variable_to_test():