Refactor - better underscore / hyphenated handling, pypi publish workflow (#17)

Author: arthanson

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 120

.pre-commit-config.yaml

@@ -3,20 +3,8 @@ ci:
   autofix_commit_msg: "style: pre-commit fixes"
 
 repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
-    hooks:
-      - id: check-added-large-files
-      - id: check-case-conflict
-      - id: check-merge-conflict
-      - id: check-symlinks
-      - id: end-of-file-fixer
-      - id: mixed-line-ending
-      - id: requirements-txt-fixer
-      - id: trailing-whitespace
-
   - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.47"
+    rev: "0.49"
     hooks:
       - id: check-manifest
         stages: [manual]

Makefile

@@ -9,7 +9,7 @@ bake:
 	cookiecutter $(BAKE_OPTIONS) . --overwrite-if-exists
 
 watch: bake
-	watchmedo shell-command -p '*.*' -c 'make bake -e BAKE_OPTIONS=$(BAKE_OPTIONS)' -W -R -D \{{cookiecutter.project_slug}}/
+	watchmedo shell-command -p '*.*' -c 'make bake -e BAKE_OPTIONS=$(BAKE_OPTIONS)' -W -R -D \{{cookiecutter.underscored}}/
 
 replay: BAKE_OPTIONS=--replay
 replay: watch

cookiecutter.json

@@ -1,14 +1,15 @@
 {
   "plugin_name": "ACL",
   "project_name": "NetBox {{ cookiecutter.plugin_name }} Plugin",
-  "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
+  "hyphenated": "{{ '-'.join(cookiecutter['project_name'].lower().split()).replace('_', '-') }}",
+  "underscored": "{{ cookiecutter.hyphenated.replace('-', '_') }}",
   "project_short_description": "NetBox plugin for {{ cookiecutter.plugin_name }}.",
   "__model_name": "{{ cookiecutter.plugin_name.replace(' ', '').replace('-', '') }}",
   "__model_url": "{{ cookiecutter.plugin_name.lower().replace(' ', '-').replace('_', '-') }}",
   "__model_url_name": "{{ cookiecutter.plugin_name.lower().replace(' ', '').replace('_', '').replace('-', '') }}",
-  "full_name": "Arthur Hanson",
-  "email": "[email protected]",
-  "github_username": "arthanson",
+  "full_name": "John Doe",
+  "email": "",
+  "github_username": "",
   "version": "0.1.0",
   "open_source_license": ["Apache-2.0", "MIT", "BSD", "ISC", "GPL-3.0-only", "Not open source"],
   "_copy_without_render": ["docs/changelog.md", "docs/contributing.md", "docs/index.md", ".github/workflows/*.yml"]

docs/prompts.md

@@ -20,10 +20,13 @@ to initialize most of the other settings.</dd>
 <dd>The name of your new Python package project. This is used in
 documentation, so spaces and any characters are fine here.</dd>
 
-<dt>project_slug</dt>
+<dt>hyphenated</dt>
 <dd>The name of your Python package for PyPI, also as the repository name of GitHub.
 Typically, it is the slugified version of project_name.</dd>
 
+<dt>underscored</dt>
+<dd>The name of the python module and directory in the project.</dd>
+
 <dt>project_short_description</dt>
 <dd>A 1-sentence description of what your Python package does.</dd>
 

docs/tutorial.md

@@ -30,7 +30,7 @@ cookiecutter https://github.com/netbox-community/cookiecutter-netbox-plugin.git
 ```
 
 Finally, a new folder will be created under current folder, the name is the answer you
-provided to `project_slug`.
+provided to `hyphenated`.
 
 Go to this generated folder, the project layout should look like:
 
@@ -94,7 +94,7 @@ At this point you can run tests and make sure everything is working properly.
 ## Step 5: Create a GitHub Repo
 
 Go to your GitHub account and create a new repo named `netbox-healthcheck-plugin`, where
-`netbox-healthcheck-plugin` matches the `project_slug` from your answers to running
+`netbox-healthcheck-plugin` matches the `hyphenated` from your answers to running
 cookiecutter.
 
 Then go to repo > settings > secrets, click on 'New repository secret', add the following
@@ -106,7 +106,7 @@ Then go to repo > settings > secrets, click on 'New repository secret', add the
 
 ## Step 6: Upload code to GitHub
 
-Back to your develop environment, find the folder named after the `project_slug`.
+Back to your develop environment, find the folder named after the `hyphenated`.
 Move into this folder, and then setup git to use your GitHub repo and upload the
 code:
 
@@ -140,7 +140,7 @@ click on actions link, you should find screen like this:
 ![](http://images.jieyu.ai/images/202104/20210419170304.png)
 
 There should be some workflows running. After they finished, go to [TestPyPI], check if a
-new artifact is published under the name `project_slug`.
+new artifact is published under the name `hyphenated`.
 
 ## Step 7. Check documentation
 

hooks/pre_gen_project.py

@@ -5,7 +5,7 @@
 
 MODULE_REGEX = r"^[_a-zA-Z][_a-zA-Z0-9]+$"
 
-module_name = "{{ cookiecutter.project_slug}}"
+module_name = "{{ cookiecutter.underscored}}"
 
 if not re.match(MODULE_REGEX, module_name):
     print(

pyproject.toml

@@ -2,10 +2,12 @@
 # https://www.python.org/dev/peps/pep-0518/
 
 [build-system]
-requires = ["setuptools>=63.2.0", "wheel"]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
 
 [project]
 name =  "cookiecutter-netbox-plugin"
+version = "0.1.0"
 authors = [
     {name = "Arthur Hanson", email = "[email protected]"},
 ]
@@ -17,24 +19,22 @@ classifiers=[
     'Intended Audience :: Developers',
     'Natural Language :: English',
     "Programming Language :: Python :: 3 :: Only",
-    'Programming Language :: Python :: 3.8',
     'Programming Language :: Python :: 3.9',
     'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
 ]
 
 requires-python = ">=3.8"
-dynamic = ["version"]
 
 [project.optional-dependencies]
 test = [
-    "black==23.3.0",
+    "black==24.3.0",
     "check-manifest==0.49",
-    "pre-commit==3.3.1",
-    "pylint==2.17.4",
-    "pytest-mock<3.10.1",
-    "pytest-runner",
-    "pytest==7.3.1",
+    "pre-commit==3.7.0",
+    "pytest==8.1.1",
+    "flake8",
+    "flake8-pyproject",
     "pytest-github-actions-annotate-failures",
 ]
 
@@ -45,10 +45,4 @@ Tracker = "https://github.com/netbox-community/cookiecutter-netbox-plugin/issues
 
 [tool.black]
 line-length = 120
-target_version = ['py38', 'py39', 'py310', 'py311']
-
-[tool.isort]
-profile = "black"
-
-[tool.pylint]
-max-line-length = 120
+target-version = ['py312']

requirements_dev.txt

@@ -1,6 +1,6 @@
-black==23.9.1
-bump2version==1.0.1
-cookiecutter>=2.3.1
-isort==5.12.0
-pytest==5.3.1
-pytest-cookies==0.5.1
+black==24.3.0
+flake8==7.0.0
+pip==24.0
+check-manifest==0.49
+pytest==8.1.1
+pytest-cookies==0.7.0

tests/test_bake_project.py

@@ -1,16 +1,12 @@
 from __future__ import annotations
 
 import datetime
-import importlib
 import os
 import shlex
 import subprocess
 import sys
 from contextlib import contextmanager
 
-import pytest
-import yaml
-from click.testing import CliRunner
 from cookiecutter.utils import rmtree
 
 
@@ -94,9 +90,7 @@ def test_bake_and_run_tests(cookies):
 
 def test_bake_withspecialchars_and_run_tests(cookies):
     """Ensure that a `full_name` with double quotes does not break setup.py"""
-    with bake_in_temp_dir(
-        cookies, extra_context={"full_name": 'name "quote" name'}
-    ) as result:
+    with bake_in_temp_dir(cookies, extra_context={"full_name": 'name "quote" name'}) as result:
         assert result.project.isdir()
         run_inside_dir("python setup.py test", str(result.project)) == 0
 
@@ -119,24 +113,19 @@ def test_make_help(cookies):
 def test_bake_selecting_license(cookies):
     license_strings = {
         "MIT license": "MIT ",
-        "BSD license": "Redistributions of source code must retain the "
-        + "above copyright notice, this",
+        "BSD license": "Redistributions of source code must retain the " + "above copyright notice, this",
         "ISC license": "ISC License",
         "Apache Software License 2.0": "Licensed under the Apache License, Version 2.0",
         "GNU General Public License v3": "GNU GENERAL PUBLIC LICENSE",
     }
     for license, target_string in license_strings.items():
-        with bake_in_temp_dir(
-            cookies, extra_context={"open_source_license": license}
-        ) as result:
+        with bake_in_temp_dir(cookies, extra_context={"open_source_license": license}) as result:
             assert target_string in result.project.join("LICENSE").read()
             assert license in result.project.join("setup.py").read()
 
 
 def test_bake_not_open_source(cookies):
-    with bake_in_temp_dir(
-        cookies, extra_context={"open_source_license": "Not open source"}
-    ) as result:
+    with bake_in_temp_dir(cookies, extra_context={"open_source_license": "Not open source"}) as result:
         found_toplevel_files = [f.basename for f in result.project.listdir()]
         assert "setup.py" in found_toplevel_files
         assert "LICENSE" not in found_toplevel_files