Use Pyproject.toml

Author: burgerbecky

LICENSE.txt

@@ -6,7 +6,7 @@ Please?
 
 --------------------------------------------
 
-Copyright (c) 2013-2024 Rebecca Ann Heineman <becky@burgerbecky.com>
+Copyright (c) 2013-2025 Rebecca Ann Heineman <becky@burgerbecky.com>
 
 --------------------------------------------
 

build_rules.py

@@ -9,6 +9,12 @@
 
 When any of these tools are invoked, this file is loaded and parsed to
 determine special rules on how to handle building the code and / or data.
+
+python -m twine upload --verbose dist/*
+
+cd docs
+sphinx-build -M html . temp\build
+
 """
 
 # pylint: disable=unused-argument
@@ -17,7 +23,8 @@
 
 import os
 import sys
-from burger import import_py_script, run_command, clean_directories
+from burger import clean_directories, run_command, __version__, \
+    delete_directory, clean_files, lock_files, unlock_files
 
 # If set to True, ``buildme -r``` will not parse directories in this folder.
 BUILDME_NO_RECURSE = False
@@ -28,7 +35,33 @@
 # If set to True, ``cleanme -r``` will not parse directories in this folder.
 CLEANME_NO_RECURSE = True
 
-CLEANME_CONTINUE = True
+# ``cleanme`` will clean the listed folders before cleaning this folder.
+CLEANME_DEPENDENCIES = []
+
+# Directories to clean
+CLEAN_DIR_LIST = [
+    "makeprojects.egg-info",
+    "makeprojects-" + __version__,
+    "dist",
+    "build",
+    "temp",
+    ".pytest_cache",
+    ".tox",
+    ".vscode"
+]
+
+# Recurse these directories clean
+CLEAN_DIR_RECURSE_LIST = (
+    "temp",
+    "__pycache__",
+    "_build"
+)
+
+# Delete any files with these extensions
+CLEAN_EXTENSION_LIST = (
+    "*.pyc",
+    "*.pyo"
+)
 
 ########################################
 
@@ -51,10 +84,20 @@ def build(working_directory, configuration):
         None if not implemented, otherwise an integer error code.
     """
 
-    # Call setup.py to create the distribution files.
-    run_command(
-        ("python", "setup.py", "sdist", "bdist_wheel"),
-        working_dir=working_directory)
+    # Unlock the files to handle Perforce locking
+    lock_list = unlock_files(working_directory) + \
+        unlock_files(os.path.join(working_directory, "makeprojects"))
+
+    try:
+        # Use "build" from python to build everything
+        run_command(
+            ("python", "-m", "build"),
+            working_dir=working_directory)
+
+    # If any files were unlocked, relock them
+    finally:
+        lock_files(lock_list)
+
     return 0
 
 ########################################
@@ -77,13 +120,21 @@ def clean(working_directory):
         None if not implemented, otherwise an integer error code.
     """
 
-    # Clean up tox, or pylint
-    clean_directories(working_directory, "temp")
+    # Delete all folders, including read only files
+    for item in CLEAN_DIR_LIST:
+        delete_directory(os.path.join(working_directory, item))
+
+    clean_directories(
+        working_directory,
+        CLEAN_DIR_RECURSE_LIST,
+        recursive=True)
+
+    # Delete all *.pyc and *.pyo files
+    clean_files(
+        working_directory,
+        name_list=CLEAN_EXTENSION_LIST,
+        recursive=True)
 
-    # The function exists in setup.py.
-    # It can be manually invoked with "setup.py clean"
-    setup = import_py_script(os.path.join(working_directory, "setup.py"))
-    setup.clean(working_directory)
     return 0
 
 

docs/Doxyfile

@@ -1039,7 +1039,8 @@ RECURSIVE              = NO
 # run.
 
 EXCLUDE                = setup.py \
-                         build_rules.py
+                         build_rules.py \
+                         ../makeprojects/core.py
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded

docs/build_rules.py

@@ -120,7 +120,9 @@ def clean(working_directory):
         None if not implemented, otherwise an integer error code.
     """
 
-    clean_directories(working_directory, ("temp", "_build", "build"))
+    clean_directories(
+        working_directory, ("temp", "_build"),
+        delete_read_only=True)
     clean_files(working_directory, ".DS_Store")
     return 0
 

docs/conf.py

@@ -14,7 +14,8 @@
 import os
 import sys
 import errno
-import sphinx_rtd_theme
+
+from burger import import_py_script
 
 # Determine if running on "ReadTheDocs.org"
 
@@ -102,7 +103,6 @@
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = ["_themes",]
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further. For a list of options available for each theme, see the
@@ -257,10 +257,9 @@ def generate_doxygen_xml(app):
 
     # Invoke the prebuild python script to create the README.html
     # file if needed using pandoc
-    sys.path.append(CWD)
-    build_rules = __import__("build_rules")
-    sys.path.pop()
-    build_rules.build(CWD, "all")
+    build_rules = import_py_script(
+        os.path.join(CWD, "build_rules.py"))
+    build_rules.build(CWD, None)
 
     # Call Doxygen to build the documentation
     try:

makeprojects/__init__.py

@@ -102,7 +102,7 @@
 __license__ = "MIT License"
 
 # Copyright owner
-__copyright__ = "Copyright 2013-2024 Rebecca Ann Heineman"
+__copyright__ = "Copyright 2013-2025 Rebecca Ann Heineman"
 
 # Items to import on "from makeprojects import *"
 __all__ = [

makeprojects/codeblocks.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-# Copyright 1995-2024 by Rebecca Ann Heineman becky@burgerbecky.com
+# Copyright 1995-2025 by Rebecca Ann Heineman becky@burgerbecky.com
 
 # It is released under an MIT Open Source license. Please see LICENSE
 # for license details. Yes, you can use it in a

makeprojects/codewarrior.py

@@ -33,7 +33,7 @@
 Tab character for XML output
 """
 
-# Copyright 2019-2024 by Rebecca Ann Heineman becky@burgerbecky.com
+# Copyright 2019-2025 by Rebecca Ann Heineman becky@burgerbecky.com
 
 # It is released under an MIT Open Source license. Please see LICENSE
 # for license details. Yes, you can use it in a

makeprojects/config.py

@@ -43,7 +43,7 @@
 Full pathname of the configuration file
 """
 
-# Copyright 2013-2024 by Rebecca Ann Heineman becky@burgerbecky.com
+# Copyright 2013-2025 by Rebecca Ann Heineman becky@burgerbecky.com
 #
 # It is released under an MIT Open Source license. Please see LICENSE
 # for license details. Yes, you can use it in a

makeprojects/enums.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-# Copyright 2013-2024 by Rebecca Ann Heineman becky@burgerbecky.com
+# Copyright 2013-2025 by Rebecca Ann Heineman becky@burgerbecky.com
 #
 # It is released under an MIT Open Source license. Please see LICENSE
 # for license details. Yes, you can use it in a