refactor: use 'slug', fix mypy path

dtbuchholz · Apr 22, 2024 · 7f6a9d7 · 7f6a9d7
1 parent 425d3e1
commit 7f6a9d7
Show file tree

Hide file tree

Showing 14 changed files with 12 additions and 14 deletions.
diff --git a/cookiecutter.json b/cookiecutter.json
@@ -1,8 +1,7 @@
 {
   "project_name": "",
   "description": "",
-  "hyphenated": "{{ '-'.join(cookiecutter['project_name'].lower().split()).replace('_', '-') }}",
-  "underscored": "{{ cookiecutter.hyphenated.replace('-', '_') }}",
+  "slug": "{{ '_'.join(cookiecutter['project_name'].lower().split()) }}",
   "github_username": "",
   "author_name": ""
 }
diff --git a/{{cookiecutter.underscored}}/.coveragerc → {{cookiecutter.slug}}/.coveragerc b/{{cookiecutter.underscored}}/.coveragerc → {{cookiecutter.slug}}/.coveragerc
diff --git a/{{cookiecutter.underscored}}/.editorconfig → {{cookiecutter.slug}}/.editorconfig b/{{cookiecutter.underscored}}/.editorconfig → {{cookiecutter.slug}}/.editorconfig
diff --git a/{{cookiecutter.underscored}}/.flake8 → {{cookiecutter.slug}}/.flake8 b/{{cookiecutter.underscored}}/.flake8 → {{cookiecutter.slug}}/.flake8
diff --git a/...r.underscored}}/.github/ISSUE_TEMPLATE.md → ...iecutter.slug}}/.github/ISSUE_TEMPLATE.md b/...r.underscored}}/.github/ISSUE_TEMPLATE.md → ...iecutter.slug}}/.github/ISSUE_TEMPLATE.md
diff --git a/{{cookiecutter.underscored}}/.gitignore → {{cookiecutter.slug}}/.gitignore b/{{cookiecutter.underscored}}/.gitignore → {{cookiecutter.slug}}/.gitignore
diff --git a/...ter.underscored}}/.pre-commit-config.yaml → ...okiecutter.slug}}/.pre-commit-config.yaml b/...ter.underscored}}/.pre-commit-config.yaml → ...okiecutter.slug}}/.pre-commit-config.yaml
diff --git a/{{cookiecutter.underscored}}/LICENSE → {{cookiecutter.slug}}/LICENSE b/{{cookiecutter.underscored}}/LICENSE → {{cookiecutter.slug}}/LICENSE
diff --git a/{{cookiecutter.underscored}}/README.md → {{cookiecutter.slug}}/README.md b/{{cookiecutter.underscored}}/README.md → {{cookiecutter.slug}}/README.md
@@ -1,7 +1,7 @@
-# {{ cookiecutter.hyphenated }}
+# {{ cookiecutter.project_name }}
 
-[![PyPI](https://img.shields.io/pypi/v/{{ cookiecutter.hyphenated }}.svg)](https://pypi.org/project/{{ cookiecutter.hyphenated }}/){% if cookiecutter.github_username %}
-[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.hyphenated }}/blob/main/LICENSE){% endif %}
+[![PyPI](https://img.shields.io/pypi/v/{{ cookiecutter.slug }}.svg)](https://pypi.org/project/{{ cookiecutter.slug }}/){% if cookiecutter.github_username %}
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.slug }}/blob/main/LICENSE){% endif %}
 [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg)](https://github.com/RichardLitt/standard-readme)
 
 > {{ cookiecutter.description }}
@@ -15,19 +15,19 @@ Background information goes here.
 You can install with `pip`:
 
 ```sh
-pip install {{ cookiecutter.hyphenated }}
+pip install {{ cookiecutter.slug }}
 ```
 
 With `poetry`:
 
 ```sh
-poetry add {{ cookiecutter.hyphenated }}
+poetry add {{ cookiecutter.slug }}
 ```
 
 Or with `pipenv`:
 
 ```sh
-pipenv install {{ cookiecutter.hyphenated }}
+pipenv install {{ cookiecutter.slug }}
 ```
 
 ## Usage

diff --git a/{{cookiecutter.underscored}}/pyproject.toml → {{cookiecutter.slug}}/pyproject.toml b/{{cookiecutter.underscored}}/pyproject.toml → {{cookiecutter.slug}}/pyproject.toml
@@ -1,9 +1,8 @@
 [tool.poetry]
-name = "{{ cookiecutter.hyphenated }}"
-version = "0.0.0"
-requires-python = ">=3.11"
+name = "{{ cookiecutter.slug }}"
+version = "0.0.1"
 description = "{{ cookiecutter.description or "" }}"
-authors = [{name = "{{ cookiecutter.author_name }}"}]
+authors = ["{{ cookiecutter.author_name }}"]
 license = "Apache-2.0"
 classifiers = [
     "License :: OSI Approved :: Apache Software License"
@@ -51,7 +50,7 @@ use_parentheses = true
 line_length = 88
 
 [tool.mypy]
-files = ["{{ cookiecutter.hyphenated }}", "test"]
+files = ["src/{{ cookiecutter.slug }}", "test"]
 ignore_missing_imports = false
 
 [tool.pytest.ini_options]

diff --git a/.../{{cookiecutter.underscored}}/__init__.py → ...g}}/src/{{cookiecutter.slug}}/__init__.py b/.../{{cookiecutter.underscored}}/__init__.py → ...g}}/src/{{cookiecutter.slug}}/__init__.py
diff --git a/.../{{cookiecutter.underscored}}/__main__.py → ...g}}/src/{{cookiecutter.slug}}/__main__.py b/.../{{cookiecutter.underscored}}/__main__.py → ...g}}/src/{{cookiecutter.slug}}/__main__.py
diff --git a/...c/{{cookiecutter.underscored}}/example.py → ...ug}}/src/{{cookiecutter.slug}}/example.py b/...c/{{cookiecutter.underscored}}/example.py → ...ug}}/src/{{cookiecutter.slug}}/example.py
diff --git a/...ests/test_{{cookiecutter.underscored}}.py → ...slug}}/test/test_{{cookiecutter.slug}}.py b/...ests/test_{{cookiecutter.underscored}}.py → ...slug}}/test/test_{{cookiecutter.slug}}.py
@@ -1,4 +1,4 @@
-from {{ cookiecutter.underscored }} import example_function
+from {{ cookiecutter.slug }} import example_function
 
 
 def test_example_function():