diff --git a/README.rst b/README.rst index d5981e7..8c42522 100644 --- a/README.rst +++ b/README.rst @@ -2,51 +2,50 @@ UBC EOAS MOAD Group Tools Package ********************************* -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Continuous Integration** | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/pytest-with-coverage.yaml/badge.svg | -| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:pytest-with-coverage | -| | :alt: Pytest with Coverage Status | -| | .. image:: https://codecov.io/gh/UBC-MOAD/moad_tools/branch/main/graph/badge.svg | -| | :target: https://app.codecov.io/gh/UBC-MOAD/moad_tools | -| | :alt: Codecov Testing Coverage Report | -| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/codeql-analysis.yaml/badge.svg | -| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:CodeQL | -| | :alt: CodeQL analysis | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Documentation** | .. image:: https://readthedocs.org/projects/ubc-moad-tools/badge/?version=latest | -| | :target: https://ubc-moad-tools.readthedocs.io/en/latest/ | -| | :alt: Documentation Status | -| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/sphinx-linkcheck.yaml/badge.svg | -| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:sphinx-linkcheck | -| | :alt: Sphinx linkcheck | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Package** | .. image:: https://img.shields.io/github/v/release/UBC-MOAD/moad_tools?logo=github | -| | :target: https://github.com/UBC-MOAD/moad_tools/releases | -| | :alt: Releases | -| | .. image:: https://img.shields.io/badge/Python-3.11%20%7C%203.12-blue?logo=python&label=Python&logoColor=gold | -| | :target: https://docs.python.org/3.12/ | -| | :alt: Python Version | -| | .. image:: https://img.shields.io/github/issues/UBC-MOAD/moad_tools?logo=github | -| | :target: https://github.com/UBC-MOAD/moad_tools/issues | -| | :alt: Issue Tracker | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Meta** | .. image:: https://img.shields.io/badge/license-Apache%202-cb2533.svg | -| | :target: https://www.apache.org/licenses/LICENSE-2.0 | -| | :alt: Licensed under the Apache License, Version 2.0 | -| | .. image:: https://img.shields.io/badge/version%20control-git-blue.svg?logo=github | -| | :target: https://github.com/UBC-MOAD/moad_tools | -| | :alt: Git on GitHub | -| | .. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white | -| | :target: https://pre-commit.com | -| | :alt: pre-commit | -+ +-----------------------------------------------------------------------------------------------------------------+ -| | .. image:: https://img.shields.io/badge/code%20style-black-000000.svg | -| | :target: https://black.readthedocs.io/en/stable/ | -| | :alt: The uncompromising Python code formatter | -| | .. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg | -| | :target: https://github.com/pypa/hatch | -| | :alt: Hatch project | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Continuous Integration** | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/pytest-with-coverage.yaml/badge.svg | +| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:pytest-with-coverage | +| | :alt: Pytest with Coverage Status | +| | .. image:: https://codecov.io/gh/UBC-MOAD/moad_tools/branch/main/graph/badge.svg | +| | :target: https://app.codecov.io/gh/UBC-MOAD/moad_tools | +| | :alt: Codecov Testing Coverage Report | +| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/codeql-analysis.yaml/badge.svg | +| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:CodeQL | +| | :alt: CodeQL analysis | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Documentation** | .. image:: https://readthedocs.org/projects/ubc-moad-tools/badge/?version=latest | +| | :target: https://ubc-moad-tools.readthedocs.io/en/latest/ | +| | :alt: Documentation Status | +| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/sphinx-linkcheck.yaml/badge.svg | +| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:sphinx-linkcheck | +| | :alt: Sphinx linkcheck | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Package** | .. image:: https://img.shields.io/github/v/release/UBC-MOAD/moad_tools?logo=github | +| | :target: https://github.com/UBC-MOAD/moad_tools/releases | +| | :alt: Releases | +| | .. image:: https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/UBC-MOAD/moad_tools/main/pyproject.toml&logo=Python&logoColor=gold&label=Python | +| | :target: https://docs.python.org/3.12/ | +| | :alt: Python Version from PEP 621 TOML | +| | .. image:: https://img.shields.io/github/issues/UBC-MOAD/moad_tools?logo=github | +| | :target: https://github.com/UBC-MOAD/moad_tools/issues | +| | :alt: Issue Tracker | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Meta** | .. image:: https://img.shields.io/badge/license-Apache%202-cb2533.svg | +| | :target: https://www.apache.org/licenses/LICENSE-2.0 | +| | :alt: Licensed under the Apache License, Version 2.0 | +| | .. image:: https://img.shields.io/badge/version%20control-git-blue.svg?logo=github | +| | :target: https://github.com/UBC-MOAD/moad_tools | +| | :alt: Git on GitHub | +| | .. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white | +| | :target: https://pre-commit.com | +| | :alt: pre-commit | +| | .. image:: https://img.shields.io/badge/code%20style-black-000000.svg | +| | :target: https://black.readthedocs.io/en/stable/ | +| | :alt: The uncompromising Python code formatter | +| | .. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg | +| | :target: https://github.com/pypa/hatch | +| | :alt: Hatch project | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ The UBC EOAS MOAD Group Tools package (``moad_tools``) is a collection of Python modules that facilitate code reuse for the UBC EOAS MOAD Group. diff --git a/docs/pkg_development.rst b/docs/pkg_development.rst index c86f62b..da80269 100644 --- a/docs/pkg_development.rst +++ b/docs/pkg_development.rst @@ -22,51 +22,50 @@ :py:obj:`moad_tools` Package Development **************************************** -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Continuous Integration** | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/pytest-with-coverage.yaml/badge.svg | -| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:pytest-with-coverage | -| | :alt: Pytest with Coverage Status | -| | .. image:: https://codecov.io/gh/UBC-MOAD/moad_tools/branch/main/graph/badge.svg | -| | :target: https://app.codecov.io/gh/UBC-MOAD/moad_tools | -| | :alt: Codecov Testing Coverage Report | -| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/codeql-analysis.yaml/badge.svg | -| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:CodeQL | -| | :alt: CodeQL analysis | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Documentation** | .. image:: https://readthedocs.org/projects/ubc-moad-tools/badge/?version=latest | -| | :target: https://ubc-moad-tools.readthedocs.io/en/latest/ | -| | :alt: Documentation Status | -| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/sphinx-linkcheck.yaml/badge.svg | -| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:sphinx-linkcheck | -| | :alt: Sphinx linkcheck | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Package** | .. image:: https://img.shields.io/github/v/release/UBC-MOAD/moad_tools?logo=github | -| | :target: https://github.com/UBC-MOAD/moad_tools/releases | -| | :alt: Releases | -| | .. image:: https://img.shields.io/badge/Python-3.11%20%7C%203.12-blue?logo=python&label=Python&logoColor=gold | -| | :target: https://docs.python.org/3.12/ | -| | :alt: Python Version | -| | .. image:: https://img.shields.io/github/issues/UBC-MOAD/moad_tools?logo=github | -| | :target: https://github.com/UBC-MOAD/moad_tools/issues | -| | :alt: Issue Tracker | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Meta** | .. image:: https://img.shields.io/badge/license-Apache%202-cb2533.svg | -| | :target: https://www.apache.org/licenses/LICENSE-2.0 | -| | :alt: Licensed under the Apache License, Version 2.0 | -| | .. image:: https://img.shields.io/badge/version%20control-git-blue.svg?logo=github | -| | :target: https://github.com/UBC-MOAD/moad_tools | -| | :alt: Git on GitHub | -| | .. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white | -| | :target: https://pre-commit.com | -| | :alt: pre-commit | -+ +-----------------------------------------------------------------------------------------------------------------+ -| | .. image:: https://img.shields.io/badge/code%20style-black-000000.svg | -| | :target: https://black.readthedocs.io/en/stable/ | -| | :alt: The uncompromising Python code formatter | -| | .. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg | -| | :target: https://github.com/pypa/hatch | -| | :alt: Hatch project | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Continuous Integration** | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/pytest-with-coverage.yaml/badge.svg | +| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:pytest-with-coverage | +| | :alt: Pytest with Coverage Status | +| | .. image:: https://codecov.io/gh/UBC-MOAD/moad_tools/branch/main/graph/badge.svg | +| | :target: https://app.codecov.io/gh/UBC-MOAD/moad_tools | +| | :alt: Codecov Testing Coverage Report | +| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/codeql-analysis.yaml/badge.svg | +| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:CodeQL | +| | :alt: CodeQL analysis | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Documentation** | .. image:: https://readthedocs.org/projects/ubc-moad-tools/badge/?version=latest | +| | :target: https://ubc-moad-tools.readthedocs.io/en/latest/ | +| | :alt: Documentation Status | +| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/sphinx-linkcheck.yaml/badge.svg | +| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:sphinx-linkcheck | +| | :alt: Sphinx linkcheck | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Package** | .. image:: https://img.shields.io/github/v/release/UBC-MOAD/moad_tools?logo=github | +| | :target: https://github.com/UBC-MOAD/moad_tools/releases | +| | :alt: Releases | +| | .. image:: https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/UBC-MOAD/moad_tools/main/pyproject.toml&logo=Python&logoColor=gold&label=Python | +| | :target: https://docs.python.org/3.12/ | +| | :alt: Python Version from PEP 621 TOML | +| | .. image:: https://img.shields.io/github/issues/UBC-MOAD/moad_tools?logo=github | +| | :target: https://github.com/UBC-MOAD/moad_tools/issues | +| | :alt: Issue Tracker | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Meta** | .. image:: https://img.shields.io/badge/license-Apache%202-cb2533.svg | +| | :target: https://www.apache.org/licenses/LICENSE-2.0 | +| | :alt: Licensed under the Apache License, Version 2.0 | +| | .. image:: https://img.shields.io/badge/version%20control-git-blue.svg?logo=github | +| | :target: https://github.com/UBC-MOAD/moad_tools | +| | :alt: Git on GitHub | +| | .. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white | +| | :target: https://pre-commit.com | +| | :alt: pre-commit | +| | .. image:: https://img.shields.io/badge/code%20style-black-000000.svg | +| | :target: https://black.readthedocs.io/en/stable/ | +| | :alt: The uncompromising Python code formatter | +| | .. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg | +| | :target: https://github.com/pypa/hatch | +| | :alt: Hatch project | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ The UBC EOAS MOAD Group Tools package (:py:obj:`moad_tools`) is a collection of Python modules that facilitate code reuse for the UBC EOAS MOAD Group. @@ -77,9 +76,9 @@ Python modules that facilitate code reuse for the UBC EOAS MOAD Group. Python Versions =============== -.. image:: https://img.shields.io/badge/Python-3.11%20%7C%203.12-blue?logo=python&label=Python&logoColor=gold +.. image:: https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/UBC-MOAD/moad_tools/main/pyproject.toml&logo=Python&logoColor=gold&label=Python :target: https://docs.python.org/3.12/ - :alt: Python Version + :alt: Python Version from PEP 621 TOML The :py:obj:`moad_tools` package is developed using `Python`_ 3.12. It is tested for Python versions >=3.11.