From 719b8f74810467fd0cb9d77c648c015351964409 Mon Sep 17 00:00:00 2001 From: Michael Panchenko Date: Mon, 29 Apr 2024 14:26:11 +0200 Subject: [PATCH] More project_name -> package_name --- .../.github/workflows/lint_and_docs.yaml | 0 .../.github/workflows/publish.yaml | 0 .../.github/workflows/pytest.yml | 0 .../.github/workflows/windows_mac_test.yml | 0 .../.gitignore | 0 .../.pre-commit-config.yaml | 0 .../.readthedocs.yaml | 0 .../CHANGELOG.md | 0 .../README.md | 0 .../config.json | 0 .../config.py | 0 .../data/.gitignore | 0 .../data/raw/hello.txt | 0 .../docs/.gitignore | 0 .../docs/01_tutorials/00_example.rst | 0 .../docs/01_tutorials/index.rst | 0 .../docs/02_notebooks/00_intro.md | 0 .../docs/02_notebooks/01_library_example.ipynb | 0 .../docs/02_notebooks/02_config_example.ipynb | 0 .../docs/04_contributing/04_contributing.rst | 0 .../docs/_config.yml | 0 .../docs/_static/css/style.css | 0 .../docs/_static/js/require.min.js | 0 .../docs/autogen_rst.py | 2 +- .../docs/bibtex.json | 0 .../docs/create_toc.py | 0 .../docs/index.rst | 0 .../docs/nbstripout.py | 0 .../docs/refs.bib | 0 .../docs/spelling_wordlist.txt | 1 + .../public/.gitignore | 0 .../pyproject.toml | 2 +- .../scripts/run_sample.py | 0 .../src/__init__.py | 0 .../src/{{cookiecutter.project_name}}/__init__.py | 0 .../src/{{cookiecutter.project_name}}/sample_module.py | 0 .../{{cookiecutter.project_name}}/sample_package/__init__.py | 0 .../sample_package/sample_module.py | 0 .../test/{{cookiecutter.project_name}}/conftest.py | 0 .../test_lazy_fixture_demonstration.py | 0 .../test/{{cookiecutter.project_name}}/test_sample_class.py | 0 41 files changed, 3 insertions(+), 2 deletions(-) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/.github/workflows/lint_and_docs.yaml (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/.github/workflows/publish.yaml (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/.github/workflows/pytest.yml (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/.github/workflows/windows_mac_test.yml (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/.gitignore (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/.pre-commit-config.yaml (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/.readthedocs.yaml (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/CHANGELOG.md (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/README.md (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/config.json (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/config.py (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/data/.gitignore (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/data/raw/hello.txt (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/.gitignore (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/01_tutorials/00_example.rst (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/01_tutorials/index.rst (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/02_notebooks/00_intro.md (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/02_notebooks/01_library_example.ipynb (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/02_notebooks/02_config_example.ipynb (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/04_contributing/04_contributing.rst (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/_config.yml (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/_static/css/style.css (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/_static/js/require.min.js (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/autogen_rst.py (98%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/bibtex.json (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/create_toc.py (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/index.rst (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/nbstripout.py (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/refs.bib (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/docs/spelling_wordlist.txt (87%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/public/.gitignore (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/pyproject.toml (98%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/scripts/run_sample.py (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/src/__init__.py (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/src/{{cookiecutter.project_name}}/__init__.py (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/src/{{cookiecutter.project_name}}/sample_module.py (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/src/{{cookiecutter.project_name}}/sample_package/__init__.py (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/src/{{cookiecutter.project_name}}/sample_package/sample_module.py (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/test/{{cookiecutter.project_name}}/conftest.py (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/test/{{cookiecutter.project_name}}/test_lazy_fixture_demonstration.py (100%) rename {{{cookiecutter.project_name}} => {{cookiecutter.package_name}}}/test/{{cookiecutter.project_name}}/test_sample_class.py (100%) diff --git a/{{cookiecutter.project_name}}/.github/workflows/lint_and_docs.yaml b/{{cookiecutter.package_name}}/.github/workflows/lint_and_docs.yaml similarity index 100% rename from {{cookiecutter.project_name}}/.github/workflows/lint_and_docs.yaml rename to {{cookiecutter.package_name}}/.github/workflows/lint_and_docs.yaml diff --git a/{{cookiecutter.project_name}}/.github/workflows/publish.yaml b/{{cookiecutter.package_name}}/.github/workflows/publish.yaml similarity index 100% rename from {{cookiecutter.project_name}}/.github/workflows/publish.yaml rename to {{cookiecutter.package_name}}/.github/workflows/publish.yaml diff --git a/{{cookiecutter.project_name}}/.github/workflows/pytest.yml b/{{cookiecutter.package_name}}/.github/workflows/pytest.yml similarity index 100% rename from {{cookiecutter.project_name}}/.github/workflows/pytest.yml rename to {{cookiecutter.package_name}}/.github/workflows/pytest.yml diff --git a/{{cookiecutter.project_name}}/.github/workflows/windows_mac_test.yml b/{{cookiecutter.package_name}}/.github/workflows/windows_mac_test.yml similarity index 100% rename from {{cookiecutter.project_name}}/.github/workflows/windows_mac_test.yml rename to {{cookiecutter.package_name}}/.github/workflows/windows_mac_test.yml diff --git a/{{cookiecutter.project_name}}/.gitignore b/{{cookiecutter.package_name}}/.gitignore similarity index 100% rename from {{cookiecutter.project_name}}/.gitignore rename to {{cookiecutter.package_name}}/.gitignore diff --git a/{{cookiecutter.project_name}}/.pre-commit-config.yaml b/{{cookiecutter.package_name}}/.pre-commit-config.yaml similarity index 100% rename from {{cookiecutter.project_name}}/.pre-commit-config.yaml rename to {{cookiecutter.package_name}}/.pre-commit-config.yaml diff --git a/{{cookiecutter.project_name}}/.readthedocs.yaml b/{{cookiecutter.package_name}}/.readthedocs.yaml similarity index 100% rename from {{cookiecutter.project_name}}/.readthedocs.yaml rename to {{cookiecutter.package_name}}/.readthedocs.yaml diff --git a/{{cookiecutter.project_name}}/CHANGELOG.md b/{{cookiecutter.package_name}}/CHANGELOG.md similarity index 100% rename from {{cookiecutter.project_name}}/CHANGELOG.md rename to {{cookiecutter.package_name}}/CHANGELOG.md diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.package_name}}/README.md similarity index 100% rename from {{cookiecutter.project_name}}/README.md rename to {{cookiecutter.package_name}}/README.md diff --git a/{{cookiecutter.project_name}}/config.json b/{{cookiecutter.package_name}}/config.json similarity index 100% rename from {{cookiecutter.project_name}}/config.json rename to {{cookiecutter.package_name}}/config.json diff --git a/{{cookiecutter.project_name}}/config.py b/{{cookiecutter.package_name}}/config.py similarity index 100% rename from {{cookiecutter.project_name}}/config.py rename to {{cookiecutter.package_name}}/config.py diff --git a/{{cookiecutter.project_name}}/data/.gitignore b/{{cookiecutter.package_name}}/data/.gitignore similarity index 100% rename from {{cookiecutter.project_name}}/data/.gitignore rename to {{cookiecutter.package_name}}/data/.gitignore diff --git a/{{cookiecutter.project_name}}/data/raw/hello.txt b/{{cookiecutter.package_name}}/data/raw/hello.txt similarity index 100% rename from {{cookiecutter.project_name}}/data/raw/hello.txt rename to {{cookiecutter.package_name}}/data/raw/hello.txt diff --git a/{{cookiecutter.project_name}}/docs/.gitignore b/{{cookiecutter.package_name}}/docs/.gitignore similarity index 100% rename from {{cookiecutter.project_name}}/docs/.gitignore rename to {{cookiecutter.package_name}}/docs/.gitignore diff --git a/{{cookiecutter.project_name}}/docs/01_tutorials/00_example.rst b/{{cookiecutter.package_name}}/docs/01_tutorials/00_example.rst similarity index 100% rename from {{cookiecutter.project_name}}/docs/01_tutorials/00_example.rst rename to {{cookiecutter.package_name}}/docs/01_tutorials/00_example.rst diff --git a/{{cookiecutter.project_name}}/docs/01_tutorials/index.rst b/{{cookiecutter.package_name}}/docs/01_tutorials/index.rst similarity index 100% rename from {{cookiecutter.project_name}}/docs/01_tutorials/index.rst rename to {{cookiecutter.package_name}}/docs/01_tutorials/index.rst diff --git a/{{cookiecutter.project_name}}/docs/02_notebooks/00_intro.md b/{{cookiecutter.package_name}}/docs/02_notebooks/00_intro.md similarity index 100% rename from {{cookiecutter.project_name}}/docs/02_notebooks/00_intro.md rename to {{cookiecutter.package_name}}/docs/02_notebooks/00_intro.md diff --git a/{{cookiecutter.project_name}}/docs/02_notebooks/01_library_example.ipynb b/{{cookiecutter.package_name}}/docs/02_notebooks/01_library_example.ipynb similarity index 100% rename from {{cookiecutter.project_name}}/docs/02_notebooks/01_library_example.ipynb rename to {{cookiecutter.package_name}}/docs/02_notebooks/01_library_example.ipynb diff --git a/{{cookiecutter.project_name}}/docs/02_notebooks/02_config_example.ipynb b/{{cookiecutter.package_name}}/docs/02_notebooks/02_config_example.ipynb similarity index 100% rename from {{cookiecutter.project_name}}/docs/02_notebooks/02_config_example.ipynb rename to {{cookiecutter.package_name}}/docs/02_notebooks/02_config_example.ipynb diff --git a/{{cookiecutter.project_name}}/docs/04_contributing/04_contributing.rst b/{{cookiecutter.package_name}}/docs/04_contributing/04_contributing.rst similarity index 100% rename from {{cookiecutter.project_name}}/docs/04_contributing/04_contributing.rst rename to {{cookiecutter.package_name}}/docs/04_contributing/04_contributing.rst diff --git a/{{cookiecutter.project_name}}/docs/_config.yml b/{{cookiecutter.package_name}}/docs/_config.yml similarity index 100% rename from {{cookiecutter.project_name}}/docs/_config.yml rename to {{cookiecutter.package_name}}/docs/_config.yml diff --git a/{{cookiecutter.project_name}}/docs/_static/css/style.css b/{{cookiecutter.package_name}}/docs/_static/css/style.css similarity index 100% rename from {{cookiecutter.project_name}}/docs/_static/css/style.css rename to {{cookiecutter.package_name}}/docs/_static/css/style.css diff --git a/{{cookiecutter.project_name}}/docs/_static/js/require.min.js b/{{cookiecutter.package_name}}/docs/_static/js/require.min.js similarity index 100% rename from {{cookiecutter.project_name}}/docs/_static/js/require.min.js rename to {{cookiecutter.package_name}}/docs/_static/js/require.min.js diff --git a/{{cookiecutter.project_name}}/docs/autogen_rst.py b/{{cookiecutter.package_name}}/docs/autogen_rst.py similarity index 98% rename from {{cookiecutter.project_name}}/docs/autogen_rst.py rename to {{cookiecutter.package_name}}/docs/autogen_rst.py index bf8cd8a..e832287 100644 --- a/{{cookiecutter.project_name}}/docs/autogen_rst.py +++ b/{{cookiecutter.package_name}}/docs/autogen_rst.py @@ -145,7 +145,7 @@ def make_rst(src_root, rst_root, clean=False, overwrite=False, package_prefix="" logging.basicConfig(level=logging.INFO) docs_root = Path(__file__).parent make_rst( - docs_root / ".." / "src" / "{{cookiecutter.project_name}}", + docs_root / ".." / "src" / "{{cookiecutter.package_name}}", docs_root / "03_api", clean=True, ) diff --git a/{{cookiecutter.project_name}}/docs/bibtex.json b/{{cookiecutter.package_name}}/docs/bibtex.json similarity index 100% rename from {{cookiecutter.project_name}}/docs/bibtex.json rename to {{cookiecutter.package_name}}/docs/bibtex.json diff --git a/{{cookiecutter.project_name}}/docs/create_toc.py b/{{cookiecutter.package_name}}/docs/create_toc.py similarity index 100% rename from {{cookiecutter.project_name}}/docs/create_toc.py rename to {{cookiecutter.package_name}}/docs/create_toc.py diff --git a/{{cookiecutter.project_name}}/docs/index.rst b/{{cookiecutter.package_name}}/docs/index.rst similarity index 100% rename from {{cookiecutter.project_name}}/docs/index.rst rename to {{cookiecutter.package_name}}/docs/index.rst diff --git a/{{cookiecutter.project_name}}/docs/nbstripout.py b/{{cookiecutter.package_name}}/docs/nbstripout.py similarity index 100% rename from {{cookiecutter.project_name}}/docs/nbstripout.py rename to {{cookiecutter.package_name}}/docs/nbstripout.py diff --git a/{{cookiecutter.project_name}}/docs/refs.bib b/{{cookiecutter.package_name}}/docs/refs.bib similarity index 100% rename from {{cookiecutter.project_name}}/docs/refs.bib rename to {{cookiecutter.package_name}}/docs/refs.bib diff --git a/{{cookiecutter.project_name}}/docs/spelling_wordlist.txt b/{{cookiecutter.package_name}}/docs/spelling_wordlist.txt similarity index 87% rename from {{cookiecutter.project_name}}/docs/spelling_wordlist.txt rename to {{cookiecutter.package_name}}/docs/spelling_wordlist.txt index f85fd14..d42b61d 100644 --- a/{{cookiecutter.project_name}}/docs/spelling_wordlist.txt +++ b/{{cookiecutter.package_name}}/docs/spelling_wordlist.txt @@ -1,6 +1,7 @@ {{cookiecutter.project_name}} {{cookiecutter.package_name}} {{cookiecutter.author}} +{{cookiecutter.github_username}} appliedAI autogenerated diff --git a/{{cookiecutter.project_name}}/public/.gitignore b/{{cookiecutter.package_name}}/public/.gitignore similarity index 100% rename from {{cookiecutter.project_name}}/public/.gitignore rename to {{cookiecutter.package_name}}/public/.gitignore diff --git a/{{cookiecutter.project_name}}/pyproject.toml b/{{cookiecutter.package_name}}/pyproject.toml similarity index 98% rename from {{cookiecutter.project_name}}/pyproject.toml rename to {{cookiecutter.package_name}}/pyproject.toml index cd9b6a1..0a119a9 100644 --- a/{{cookiecutter.project_name}}/pyproject.toml +++ b/{{cookiecutter.package_name}}/pyproject.toml @@ -129,7 +129,7 @@ move-optionals-to-bottom = true PYDEVD_DISABLE_FILE_VALIDATION="1" # keep relevant parts in sync with pre-commit [tool.poe.tasks] # https://github.com/nat-n/poethepoet -test = "pytest test --cov={{cookiecutter.project_name}} --cov-report=xml --cov-report=term-missing --durations=0 -v --color=yes" +test = "pytest test --cov={{cookiecutter.package_name}} --cov-report=xml --cov-report=term-missing --durations=0 -v --color=yes" # Adjust to a smaller set of tests if appropriate test-subset = "pytest test --color=yes" _black_check = "black --check ." diff --git a/{{cookiecutter.project_name}}/scripts/run_sample.py b/{{cookiecutter.package_name}}/scripts/run_sample.py similarity index 100% rename from {{cookiecutter.project_name}}/scripts/run_sample.py rename to {{cookiecutter.package_name}}/scripts/run_sample.py diff --git a/{{cookiecutter.project_name}}/src/__init__.py b/{{cookiecutter.package_name}}/src/__init__.py similarity index 100% rename from {{cookiecutter.project_name}}/src/__init__.py rename to {{cookiecutter.package_name}}/src/__init__.py diff --git a/{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/__init__.py b/{{cookiecutter.package_name}}/src/{{cookiecutter.project_name}}/__init__.py similarity index 100% rename from {{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/__init__.py rename to {{cookiecutter.package_name}}/src/{{cookiecutter.project_name}}/__init__.py diff --git a/{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/sample_module.py b/{{cookiecutter.package_name}}/src/{{cookiecutter.project_name}}/sample_module.py similarity index 100% rename from {{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/sample_module.py rename to {{cookiecutter.package_name}}/src/{{cookiecutter.project_name}}/sample_module.py diff --git a/{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/sample_package/__init__.py b/{{cookiecutter.package_name}}/src/{{cookiecutter.project_name}}/sample_package/__init__.py similarity index 100% rename from {{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/sample_package/__init__.py rename to {{cookiecutter.package_name}}/src/{{cookiecutter.project_name}}/sample_package/__init__.py diff --git a/{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/sample_package/sample_module.py b/{{cookiecutter.package_name}}/src/{{cookiecutter.project_name}}/sample_package/sample_module.py similarity index 100% rename from {{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/sample_package/sample_module.py rename to {{cookiecutter.package_name}}/src/{{cookiecutter.project_name}}/sample_package/sample_module.py diff --git a/{{cookiecutter.project_name}}/test/{{cookiecutter.project_name}}/conftest.py b/{{cookiecutter.package_name}}/test/{{cookiecutter.project_name}}/conftest.py similarity index 100% rename from {{cookiecutter.project_name}}/test/{{cookiecutter.project_name}}/conftest.py rename to {{cookiecutter.package_name}}/test/{{cookiecutter.project_name}}/conftest.py diff --git a/{{cookiecutter.project_name}}/test/{{cookiecutter.project_name}}/test_lazy_fixture_demonstration.py b/{{cookiecutter.package_name}}/test/{{cookiecutter.project_name}}/test_lazy_fixture_demonstration.py similarity index 100% rename from {{cookiecutter.project_name}}/test/{{cookiecutter.project_name}}/test_lazy_fixture_demonstration.py rename to {{cookiecutter.package_name}}/test/{{cookiecutter.project_name}}/test_lazy_fixture_demonstration.py diff --git a/{{cookiecutter.project_name}}/test/{{cookiecutter.project_name}}/test_sample_class.py b/{{cookiecutter.package_name}}/test/{{cookiecutter.project_name}}/test_sample_class.py similarity index 100% rename from {{cookiecutter.project_name}}/test/{{cookiecutter.project_name}}/test_sample_class.py rename to {{cookiecutter.package_name}}/test/{{cookiecutter.project_name}}/test_sample_class.py