cookiecutter_pywf_open_source_demo 1.0.0__tar.gz

cookiecutter_pywf_open_source_demo-1.0.0/AUTHORS.rst

@@ -0,0 +1,15 @@
+.. _about_author:
+
+About the Author
+------------------------------------------------------------------------------
+::
+
+   (\ (\
+   ( -.-)o
+   o_(")(")
+
+**Sanhe Hu** is a seasoned software engineer with a deep passion for Python development since 2010. As an author and maintainer of `150+ open-source Python projects <https://pypi.org/user/machugwu/>`_, with over `15 million monthly downloads <https://github.com/MacHu-GWU>`_, I bring a wealth of experience to the table. As a Senior Solution Architect and Subject Matter Expert in AI, Data, Amazon Web Services, Cloud Engineering, DevOps, I thrive on helping clients with platform design, enterprise architecture, and strategic roadmaps.
+
+Talk is cheap, show me the code:
+
+- My Github: https://github.com/MacHu-GWU

cookiecutter_pywf_open_source_demo-1.0.0/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2025 Sanhe Hu <https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cookiecutter_pywf_open_source_demo-1.0.0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: cookiecutter_pywf_open_source_demo
+Version: 1.0.0
+Summary: An example project generated by cookiecutter-pywf_open_source.
+Author-email: Sanhe Hu <husanhe@gmail.com>
+Maintainer-email: Sanhe Hu <husanhe@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+Project-URL: Documentation, https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+Project-URL: Issues, https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/issues
+Project-URL: Changelog, https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/blob/main/release-history.rst
+Project-URL: Download, https://pypi.org/pypi/cookiecutter-pywf-open-source-demo#files
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Unix
+Requires-Python: <4.0,>=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+License-File: AUTHORS.rst
+Provides-Extra: dev
+Requires-Dist: twine<7.0.0,>=6.0.0; extra == "dev"
+Requires-Dist: wheel<1.0.0,>=0.45.0; extra == "dev"
+Requires-Dist: build<2.0.0,>=1.2.1; extra == "dev"
+Requires-Dist: rich<14.0.0,>=13.8.1; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest<9.0.0,>=8.2.2; extra == "test"
+Requires-Dist: pytest-cov<7.0.0,>=6.0.0; extra == "test"
+Provides-Extra: doc
+Requires-Dist: Sphinx<8.0.0,>=7.4.7; extra == "doc"
+Requires-Dist: sphinx-copybutton<1.0.0,>=0.5.2; extra == "doc"
+Requires-Dist: sphinx-design<1.0.0,>=0.6.1; extra == "doc"
+Requires-Dist: sphinx-jinja<3.0.0,>=2.0.2; extra == "doc"
+Requires-Dist: furo==2024.8.6; extra == "doc"
+Requires-Dist: pygments<3.0.0,>=2.18.0; extra == "doc"
+Requires-Dist: ipython<8.19.0,>=8.18.1; extra == "doc"
+Requires-Dist: nbsphinx<1.0.0,>=0.8.12; extra == "doc"
+Requires-Dist: rstobj==1.2.1; extra == "doc"
+Requires-Dist: docfly==3.0.0; extra == "doc"
+Provides-Extra: mise
+Requires-Dist: PyGithub<3.0.0,>=2.8.0; extra == "mise"
+Requires-Dist: httpx<1.0.0,>=0.28.0; extra == "mise"
+Provides-Extra: auto
+Dynamic: license-file
+
+
+.. image:: https://readthedocs.org/projects/cookiecutter-pywf-open-source-demo/badge/?version=latest
+    :target: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/
+    :alt: Documentation Status
+
+.. image:: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/actions/workflows/main.yml/badge.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/actions?query=workflow:CI
+
+.. image:: https://codecov.io/gh/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+
+.. image:: https://img.shields.io/pypi/v/cookiecutter-pywf-open-source-demo.svg
+    :target: https://pypi.python.org/pypi/cookiecutter-pywf-open-source-demo
+
+.. image:: https://img.shields.io/pypi/l/cookiecutter-pywf-open-source-demo.svg
+    :target: https://pypi.python.org/pypi/cookiecutter-pywf-open-source-demo
+
+.. image:: https://img.shields.io/pypi/pyversions/cookiecutter-pywf-open-source-demo.svg
+    :target: https://pypi.python.org/pypi/cookiecutter-pywf-open-source-demo
+
+.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/blob/main/release-history.rst
+
+.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+
+------
+
+.. image:: https://img.shields.io/badge/Link-API-blue.svg
+    :target: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/py-modindex.html
+
+.. image:: https://img.shields.io/badge/Link-Install-blue.svg
+    :target: `install`_
+
+.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+
+.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/issues
+
+.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/issues
+
+.. image:: https://img.shields.io/badge/Link-Download-blue.svg
+    :target: https://pypi.org/pypi/cookiecutter-pywf-open-source-demo#files
+
+
+Welcome to ``cookiecutter_pywf_open_source_demo`` Documentation
+==============================================================================
+.. image:: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/_static/cookiecutter_pywf_open_source_demo-logo.png
+    :target: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/
+
+Documentation for ``cookiecutter_pywf_open_source_demo``.
+
+
+.. _install:
+
+Install
+------------------------------------------------------------------------------
+
+``cookiecutter_pywf_open_source_demo`` is released on PyPI, so all you need is to:
+
+.. code-block:: console
+
+    $ pip install cookiecutter-pywf-open-source-demo
+
+To upgrade to latest version:
+
+.. code-block:: console
+
+    $ pip install --upgrade cookiecutter-pywf-open-source-demo

cookiecutter_pywf_open_source_demo-1.0.0/README.rst

@@ -0,0 +1,71 @@
+
+.. image:: https://readthedocs.org/projects/cookiecutter-pywf-open-source-demo/badge/?version=latest
+    :target: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/
+    :alt: Documentation Status
+
+.. image:: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/actions/workflows/main.yml/badge.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/actions?query=workflow:CI
+
+.. image:: https://codecov.io/gh/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+
+.. image:: https://img.shields.io/pypi/v/cookiecutter-pywf-open-source-demo.svg
+    :target: https://pypi.python.org/pypi/cookiecutter-pywf-open-source-demo
+
+.. image:: https://img.shields.io/pypi/l/cookiecutter-pywf-open-source-demo.svg
+    :target: https://pypi.python.org/pypi/cookiecutter-pywf-open-source-demo
+
+.. image:: https://img.shields.io/pypi/pyversions/cookiecutter-pywf-open-source-demo.svg
+    :target: https://pypi.python.org/pypi/cookiecutter-pywf-open-source-demo
+
+.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/blob/main/release-history.rst
+
+.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+
+------
+
+.. image:: https://img.shields.io/badge/Link-API-blue.svg
+    :target: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/py-modindex.html
+
+.. image:: https://img.shields.io/badge/Link-Install-blue.svg
+    :target: `install`_
+
+.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+
+.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/issues
+
+.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/issues
+
+.. image:: https://img.shields.io/badge/Link-Download-blue.svg
+    :target: https://pypi.org/pypi/cookiecutter-pywf-open-source-demo#files
+
+
+Welcome to ``cookiecutter_pywf_open_source_demo`` Documentation
+==============================================================================
+.. image:: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/_static/cookiecutter_pywf_open_source_demo-logo.png
+    :target: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/
+
+Documentation for ``cookiecutter_pywf_open_source_demo``.
+
+
+.. _install:
+
+Install
+------------------------------------------------------------------------------
+
+``cookiecutter_pywf_open_source_demo`` is released on PyPI, so all you need is to:
+
+.. code-block:: console
+
+    $ pip install cookiecutter-pywf-open-source-demo
+
+To upgrade to latest version:
+
+.. code-block:: console
+
+    $ pip install --upgrade cookiecutter-pywf-open-source-demo

cookiecutter_pywf_open_source_demo-1.0.0/cookiecutter_pywf_open_source_demo/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+
+from ._version import __version__
+from ._version import __short_description__
+from ._version import __license__
+from ._version import __author__
+from ._version import __author_email__
+from ._version import __maintainer__
+from ._version import __maintainer_email__

cookiecutter_pywf_open_source_demo-1.0.0/cookiecutter_pywf_open_source_demo/_version.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+# This file is automatically generated by pywf script
+# based on the content in pyproject.toml file
+
+__version__ = "0.1.4"
+__short_description__ = "An example project generated by cookiecutter-pywf_open_source."
+__license__ = "MIT"
+__author__ = "Sanhe Hu"
+__author_email__ = "husanhe@gmail.com"
+__maintainer__ = "Sanhe Hu"
+__maintainer_email__ = "husanhe@gmail.com"
+
+# run this script to print out the version number
+if __name__ == "__main__":  # pragma: no cover
+    print(__version__)

cookiecutter_pywf_open_source_demo-1.0.0/cookiecutter_pywf_open_source_demo/api.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+

cookiecutter_pywf_open_source_demo-1.0.0/cookiecutter_pywf_open_source_demo/paths.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+
+from pathlib import Path
+from functools import cached_property
+
+_dir_here = Path(__file__).absolute().parent
+PACKAGE_NAME = _dir_here.name
+
+
+class PathEnum:
+    """
+    Centralized enumeration of all project paths with absolute path references.
+
+    Provides IDE-autocomplete-friendly access to all project directories and files using
+    absolute paths to eliminate current directory dependencies and ensure consistent path
+    resolution across different execution contexts and DevOps workflows.
+    """
+    @cached_property
+    def dir_home(self):
+        return Path.home()
+
+    dir_project_root = _dir_here.parent
+    dir_tmp = dir_project_root / "tmp"
+
+    # Source Code
+    dir_package = _dir_here
+    path_version_py = dir_package / "_version.py"
+    path_pyproject_toml = dir_project_root / "pyproject.toml"
+    path_requirements_txt = dir_project_root / "requirements.txt"
+    path_authors = dir_project_root / "AUTHORS.txt"
+    path_license = dir_project_root / "LICENSE.txt"
+    path_release_history = dir_project_root / "release-history.rst"
+
+    # Virtual Environment
+    dir_venv = dir_project_root / ".venv"
+    dir_venv_bin = dir_venv / "bin"
+    path_venv_bin_pip = dir_venv_bin / "pip"
+    path_venv_bin_python = dir_venv_bin / "python"
+    path_venv_bin_pytest = dir_venv_bin / "pytest"
+
+    # Test
+    dir_htmlcov = dir_project_root / "htmlcov"
+    path_cov_index_html = dir_htmlcov / "index.html"
+    dir_unit_test = dir_project_root / "tests"
+    dir_int_test = dir_project_root / "tests_int"
+    dir_load_test = dir_project_root / "tests_load"
+
+    # Documentation
+    dir_docs_source = dir_project_root / "docs" / "source"
+    dir_docs_build_html = dir_project_root / "docs" / "build" / "html"
+
+    # Build
+    dir_build = dir_project_root / "build"
+    dir_dist = dir_project_root / "dist"
+
+
+path_enum = PathEnum()
+"""
+Single entry point for all project paths with absolute path references.
+"""

cookiecutter_pywf_open_source_demo-1.0.0/cookiecutter_pywf_open_source_demo/vendor/__init__.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+

cookiecutter_pywf_open_source_demo-1.0.0/cookiecutter_pywf_open_source_demo/vendor/pytest_cov_helper.py

@@ -0,0 +1,148 @@
+# -*- coding: utf-8 -*-
+
+import os
+import sys
+import contextlib
+import subprocess
+from pathlib import Path
+
+__version__ = "0.2.1"
+
+
+@contextlib.contextmanager
+def temp_cwd(path: Path):
+    """
+    Temporarily set the current working directory (CWD) and automatically
+    switch back when it's done.
+    """
+    cwd = os.getcwd()
+    os.chdir(str(path))
+    try:
+        yield path
+    finally:
+        os.chdir(cwd)
+
+
+def run_unit_test(
+    script: str,
+    root_dir: str,
+):
+    """
+    Run ``pytest -s --tb=native /path/to/script.py`` Command.
+
+    :param script: the path to test script
+    :param root_dir: the dir you want to temporarily set as cwd
+    """
+    bin_pytest = Path(sys.executable).parent / "pytest"
+    args = [
+        f"{bin_pytest}",
+        "-s",
+        "--tb=native",
+        script,
+    ]
+    with temp_cwd(Path(root_dir)):
+        subprocess.run(args)
+
+
+def run_cov_test(
+    script: str,
+    module: str,
+    root_dir: str,
+    htmlcov_dir: str,
+    preview: bool = False,
+    is_folder: bool = False,
+):
+    """
+    The pytest-cov plugin gives you the coverage for entire project. What if
+    I want run per-module test independently and get per-module coverage?
+
+    This is a simple wrapper around pytest + coverage cli command. Allow you to run
+    coverage test from Python script and set the code coverage measurement scope.
+
+    Usage example:
+
+    suppose you have a source code folder structure like this::
+
+        /dir_git_repo/
+        /dir_git_repo/my_library
+        /dir_git_repo/my_library/__init__.py
+        /dir_git_repo/my_library/module1.py
+        /dir_git_repo/my_library/module2.py
+
+    In your module 1 unit test script, you can do this:
+
+    .. code-block:: python
+
+        from my_library.module1 import func1, func2
+
+        def test_func1():
+            pass
+
+        def test_func2():
+            pass
+
+        if __name__ == "__main__":
+            from fixa.pytest_cov_helper import run_cov_test
+
+            run_cov_test(
+                script=__file__,
+                module="my_library.module1", # test scope is the module1.py
+                root_dir="/path/to/dir_git_repo",
+                htmlcov_dir="/path/to/dir_git_repo/htmlcov",
+            )
+
+    In your all modules unit test script, you can do this:
+
+    .. code-block:: python
+
+        if __name__ == "__main__":
+            from fixa.pytest_cov_helper import run_cov_test
+
+            run_cov_test(
+                script=__file__,
+                module="my_library", # test scope is the my_library/
+                root_dir="/path/to/dir_git_repo",
+                htmlcov_dir="/path/to/dir_git_repo/htmlcov",
+                is_folder=True, # my_library is a folder
+            )
+
+    :param script: the test script absolute path
+    :param module: the dot notation to the python module you want to calculate
+        coverage
+    :param root_dir: the dir to dump coverage results binary file
+    :param htmlcov_dir: the dir to dump HTML output
+    :param preview: whether to open the HTML output in web browser after the test
+    :param is_folder: whether the module is a folder
+
+    Reference:
+
+    - https://pypi.org/project/pytest-cov/
+    """
+    bin_pytest = Path(sys.executable).parent / "pytest"
+    if is_folder:
+        script = f"{Path(script).parent}"
+    if module.endswith(".py"):  # pragma: no cover
+        module = module[:-3]
+    args = [
+        f"{bin_pytest}",
+        "-s",
+        "--tb=native",
+        f"--rootdir={root_dir}",
+        f"--cov={module}",
+        "--cov-report",
+        "term-missing",
+        "--cov-report",
+        f"html:{htmlcov_dir}",
+        script,
+    ]
+    with temp_cwd(Path(root_dir)):
+        subprocess.run(args)
+    if preview:  # pragma: no cover
+        platform = sys.platform
+        if platform in ["win32", "cygwin"]:
+            open_command = "start"
+        elif platform in ["darwin", "linux"]:
+            open_command = "open"
+        else:
+            raise NotImplementedError
+        subprocess.run([open_command, f"{Path(htmlcov_dir).joinpath('index.html')}"])

cookiecutter_pywf_open_source_demo-1.0.0/cookiecutter_pywf_open_source_demo.egg-info/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: cookiecutter_pywf_open_source_demo
+Version: 1.0.0
+Summary: An example project generated by cookiecutter-pywf_open_source.
+Author-email: Sanhe Hu <husanhe@gmail.com>
+Maintainer-email: Sanhe Hu <husanhe@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+Project-URL: Documentation, https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+Project-URL: Issues, https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/issues
+Project-URL: Changelog, https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/blob/main/release-history.rst
+Project-URL: Download, https://pypi.org/pypi/cookiecutter-pywf-open-source-demo#files
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Unix
+Requires-Python: <4.0,>=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+License-File: AUTHORS.rst
+Provides-Extra: dev
+Requires-Dist: twine<7.0.0,>=6.0.0; extra == "dev"
+Requires-Dist: wheel<1.0.0,>=0.45.0; extra == "dev"
+Requires-Dist: build<2.0.0,>=1.2.1; extra == "dev"
+Requires-Dist: rich<14.0.0,>=13.8.1; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest<9.0.0,>=8.2.2; extra == "test"
+Requires-Dist: pytest-cov<7.0.0,>=6.0.0; extra == "test"
+Provides-Extra: doc
+Requires-Dist: Sphinx<8.0.0,>=7.4.7; extra == "doc"
+Requires-Dist: sphinx-copybutton<1.0.0,>=0.5.2; extra == "doc"
+Requires-Dist: sphinx-design<1.0.0,>=0.6.1; extra == "doc"
+Requires-Dist: sphinx-jinja<3.0.0,>=2.0.2; extra == "doc"
+Requires-Dist: furo==2024.8.6; extra == "doc"
+Requires-Dist: pygments<3.0.0,>=2.18.0; extra == "doc"
+Requires-Dist: ipython<8.19.0,>=8.18.1; extra == "doc"
+Requires-Dist: nbsphinx<1.0.0,>=0.8.12; extra == "doc"
+Requires-Dist: rstobj==1.2.1; extra == "doc"
+Requires-Dist: docfly==3.0.0; extra == "doc"
+Provides-Extra: mise
+Requires-Dist: PyGithub<3.0.0,>=2.8.0; extra == "mise"
+Requires-Dist: httpx<1.0.0,>=0.28.0; extra == "mise"
+Provides-Extra: auto
+Dynamic: license-file
+
+
+.. image:: https://readthedocs.org/projects/cookiecutter-pywf-open-source-demo/badge/?version=latest
+    :target: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/
+    :alt: Documentation Status
+
+.. image:: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/actions/workflows/main.yml/badge.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/actions?query=workflow:CI
+
+.. image:: https://codecov.io/gh/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+
+.. image:: https://img.shields.io/pypi/v/cookiecutter-pywf-open-source-demo.svg
+    :target: https://pypi.python.org/pypi/cookiecutter-pywf-open-source-demo
+
+.. image:: https://img.shields.io/pypi/l/cookiecutter-pywf-open-source-demo.svg
+    :target: https://pypi.python.org/pypi/cookiecutter-pywf-open-source-demo
+
+.. image:: https://img.shields.io/pypi/pyversions/cookiecutter-pywf-open-source-demo.svg
+    :target: https://pypi.python.org/pypi/cookiecutter-pywf-open-source-demo
+
+.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/blob/main/release-history.rst
+
+.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+
+------
+
+.. image:: https://img.shields.io/badge/Link-API-blue.svg
+    :target: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/py-modindex.html
+
+.. image:: https://img.shields.io/badge/Link-Install-blue.svg
+    :target: `install`_
+
+.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project
+
+.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/issues
+
+.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
+    :target: https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/issues
+
+.. image:: https://img.shields.io/badge/Link-Download-blue.svg
+    :target: https://pypi.org/pypi/cookiecutter-pywf-open-source-demo#files
+
+
+Welcome to ``cookiecutter_pywf_open_source_demo`` Documentation
+==============================================================================
+.. image:: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/_static/cookiecutter_pywf_open_source_demo-logo.png
+    :target: https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/
+
+Documentation for ``cookiecutter_pywf_open_source_demo``.
+
+
+.. _install:
+
+Install
+------------------------------------------------------------------------------
+
+``cookiecutter_pywf_open_source_demo`` is released on PyPI, so all you need is to:
+
+.. code-block:: console
+
+    $ pip install cookiecutter-pywf-open-source-demo
+
+To upgrade to latest version:
+
+.. code-block:: console
+
+    $ pip install --upgrade cookiecutter-pywf-open-source-demo

cookiecutter_pywf_open_source_demo-1.0.0/cookiecutter_pywf_open_source_demo.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+AUTHORS.rst
+LICENSE.txt
+README.rst
+pyproject.toml
+cookiecutter_pywf_open_source_demo/__init__.py
+cookiecutter_pywf_open_source_demo/_version.py
+cookiecutter_pywf_open_source_demo/api.py
+cookiecutter_pywf_open_source_demo/paths.py
+cookiecutter_pywf_open_source_demo.egg-info/PKG-INFO
+cookiecutter_pywf_open_source_demo.egg-info/SOURCES.txt
+cookiecutter_pywf_open_source_demo.egg-info/dependency_links.txt
+cookiecutter_pywf_open_source_demo.egg-info/requires.txt
+cookiecutter_pywf_open_source_demo.egg-info/top_level.txt
+cookiecutter_pywf_open_source_demo/vendor/__init__.py
+cookiecutter_pywf_open_source_demo/vendor/pytest_cov_helper.py
+tests/test_api.py

cookiecutter_pywf_open_source_demo-1.0.0/cookiecutter_pywf_open_source_demo.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cookiecutter_pywf_open_source_demo-1.0.0/cookiecutter_pywf_open_source_demo.egg-info/requires.txt

@@ -0,0 +1,28 @@
+
+[auto]
+
+[dev]
+twine<7.0.0,>=6.0.0
+wheel<1.0.0,>=0.45.0
+build<2.0.0,>=1.2.1
+rich<14.0.0,>=13.8.1
+
+[doc]
+Sphinx<8.0.0,>=7.4.7
+sphinx-copybutton<1.0.0,>=0.5.2
+sphinx-design<1.0.0,>=0.6.1
+sphinx-jinja<3.0.0,>=2.0.2
+furo==2024.8.6
+pygments<3.0.0,>=2.18.0
+ipython<8.19.0,>=8.18.1
+nbsphinx<1.0.0,>=0.8.12
+rstobj==1.2.1
+docfly==3.0.0
+
+[mise]
+PyGithub<3.0.0,>=2.8.0
+httpx<1.0.0,>=0.28.0
+
+[test]
+pytest<9.0.0,>=8.2.2
+pytest-cov<7.0.0,>=6.0.0

cookiecutter_pywf_open_source_demo-1.0.0/cookiecutter_pywf_open_source_demo.egg-info/top_level.txt

@@ -0,0 +1 @@
+cookiecutter_pywf_open_source_demo

cookiecutter_pywf_open_source_demo-1.0.0/pyproject.toml

@@ -0,0 +1,165 @@
+# ==============================================================================
+# The [project] table defined by Official python.org
+#
+# Read: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
+# ==============================================================================
+[project]
+name = "cookiecutter_pywf_open_source_demo"
+# Increment version before each release - follow `semantic versioning <https://semver.org/>`_
+# Currently, poetry 2.1.X doesn't support dynamic versioning
+# (Read https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#version)
+# So this value has to be aligned with the one in ``cookiecutter_pywf_open_source_demo/_version.py``
+version = "1.0.0"
+description = "An example project generated by cookiecutter-pywf_open_source."
+# Read https://dev-exp-share.readthedocs.io/en/latest/search.html?q=Pick+An+Open+Source+License+For+Python+Project&check_keywords=yes&area=default
+# To pick a license and update the ``license``, ``classifier`` field in ``pyproject.toml``
+# And also update the ``LICENSE.txt`` file in the git repo.
+license = "MIT"
+license-files = ["LICENSE.txt", "AUTHORS.rst"]
+authors = [
+    { name = "Sanhe Hu", email = "husanhe@gmail.com" },
+]
+maintainers = [
+    { name = "Sanhe Hu", email = "husanhe@gmail.com" },
+]
+keywords = []
+readme = "README.rst"
+requires-python = ">=3.10,<4.0"
+# Full list of classifiers: https://pypi.org/classifiers/
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: MacOS",
+    "Operating System :: Unix",
+    # Note: classfier like "Programming Language :: Python :: 3 :: Only",
+    # "Programming Language :: Python :: 3.X" is no longer needed,
+    # because we have ``requires-python`` field.
+]
+
+# ------------------------------------------------------------------------------
+# Core Dependencies
+# ------------------------------------------------------------------------------
+dependencies = [
+]
+
+# ------------------------------------------------------------------------------
+# Optional dependency that can be used in ``pip install ${your_project_name}[${feature_name}]``
+# Sometime this is also called "extras"
+# Read: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#dependencies-optional-dependencies
+#
+# IMPORTANT: all optional dependencies has to be compatible with the "requires-python" field
+# ------------------------------------------------------------------------------
+[project.optional-dependencies]
+
+# ------------------------------------------------------------------------------
+# Local Development dependenceies
+# ------------------------------------------------------------------------------
+dev = [
+    "twine>=6.0.0,<7.0.0", # distribute package to PyPI
+    "wheel>=0.45.0,<1.0.0", # build wheel package
+    "build>=1.2.1,<2.0.0", # build source distribution
+    "rich>=13.8.1,<14.0.0", # pretty print
+]
+
+# ------------------------------------------------------------------------------
+# (Unit/Coverage/Integration/Load) Test dependenceies
+# ------------------------------------------------------------------------------
+test = [
+    "pytest>=8.2.2,<9.0.0", # Testing framework
+    "pytest-cov>=6.0.0,<7.0.0", # Coverage reporting
+]
+
+# ------------------------------------------------------------------------------
+# Documentation build dependenceies
+# ------------------------------------------------------------------------------
+doc = [
+    "Sphinx>=7.4.7,<8.0.0",
+    "sphinx-copybutton>=0.5.2,<1.0.0", # add copy button to code block
+    "sphinx-design>=0.6.1,<1.0.0", # add additional design pattern to sphinx
+    "sphinx-jinja>=2.0.2,<3.0.0", # enable jinja syntax in reStructuredText
+    "furo==2024.8.6", # the furo sphinx theme
+    "pygments>=2.18.0,<3.0.0", # syntax highlight
+    "ipython>=8.18.1,<8.19.0", # interactive Python
+    "nbsphinx>=0.8.12,<1.0.0", # add jupyter notebook in sphinx doc
+    "rstobj==1.2.1", # generate reStructuredText from Python code
+    "docfly==3.0.0", # automaticall generate .. toctree directives and API reference doc
+]
+
+# ------------------------------------------------------------------------------
+# Mise task runner dependencies
+# ------------------------------------------------------------------------------
+mise = [
+    "PyGithub>=2.8.0,<3.0.0", # GitHub API client
+    "httpx>=0.28.0,<1.0.0", # HTTP client for ReadTheDocs API
+]
+
+# ------------------------------------------------------------------------------
+# Automation (devops) dependenceies
+# ------------------------------------------------------------------------------
+auto = [
+]
+
+# Quick Links
+[project.urls]
+Homepage = "https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project"
+Documentation = "https://cookiecutter-pywf-open-source-demo.readthedocs.io/en/latest/"
+Repository = "https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project"
+Issues = "https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/issues"
+Changelog = "https://github.com/MacHu-GWU/cookiecutter_pywf_open_source_demo-project/blob/main/release-history.rst"
+Download = "https://pypi.org/pypi/cookiecutter-pywf-open-source-demo#files"
+
+# For command line interface, read: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#creating-executable-scripts
+[project.scripts]
+
+[tool.poetry.requires-plugins]
+poetry-plugin-export = ">=1.9.0,<2.0.0"
+
+[tool.poetry]
+# Files to include in the package distribution
+packages = [
+    { include = "cookiecutter_pywf_open_source_demo", from = ".", to = "." }
+]
+# Files to exclude from the package
+exclude = [
+    "cookiecutter_pywf_open_source_demo/tests/*",
+    "cookiecutter_pywf_open_source_demo/docs/*",
+    "**/*.pyc",
+    "**/*.pyo",
+]
+
+## python workflow tool config
+#[tool.pywf]
+## The specific python version you use for local development
+#dev_python = "3.12.11"
+## --- github.com
+#github_account = "MacHu-GWU"
+## Create GitHub token in https://github.com/settings/tokens and put the token in
+## ``${HOME}/home_secret.json``
+#github_token_field = "providers.github.accounts.sh.users.sh.secrets.dev.value"
+## --- codecov.io (for code coverage test report)
+#codecov_account = "MacHu-GWU"
+## Create Codecov token in https://app.codecov.io/account/gh/${codecov_account}/access
+## and put the token in ``${HOME}/home_secret.json``
+#codecov_token_field = "providers.codecov_io.accounts.sh.users.sh.secrets.dev.value"
+## --- readthedocs.org (for documentation hosting)
+## Create Readthedocs token in https://app.readthedocs.org/accounts/tokens/
+## and put the token at ``${HOME}/home_secret.json``
+#readthedocs_token_field = "providers.readthedocs.accounts.sh.users.sh.secrets.dev.value"
+## Readthedocs project name, usually it is the same as your project name
+#readthedocs_project_name = "cookiecutter_pywf_open_source_demo"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["cookiecutter_pywf_open_source_demo*"]
+exclude = [
+    "cookiecutter_pywf_open_source_demo.tests",
+    "cookiecutter_pywf_open_source_demo.tests.*",
+    "cookiecutter_pywf_open_source_demo.docs",
+    "cookiecutter_pywf_open_source_demo.docs.*",
+]
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"

cookiecutter_pywf_open_source_demo-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cookiecutter_pywf_open_source_demo-1.0.0/tests/test_api.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+from cookiecutter_pywf_open_source_demo import api
+
+
+def test():
+    _ = api
+
+
+if __name__ == "__main__":
+    from cookiecutter_pywf_open_source_demo.tests import run_cov_test
+
+    run_cov_test(
+        __file__,
+        "cookiecutter_pywf_open_source_demo.api",
+        preview=False,
+    )