PyProd 0.3.0__tar.gz → 0.5.0__tar.gz

{pyprod-0.3.0 → pyprod-0.5.0}/.gitignore

@@ -1,3 +1,5 @@
+.*
+!.github
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -98,7 +100,7 @@ ipython_config.py
 #   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
-#uv.lock
+uv.lock
 
 # poetry
 #   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.

{pyprod-0.3.0 → pyprod-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyProd
-Version: 0.3.0
+Version: 0.5.0
 Summary: PyProd: More Makeable than Make
 Project-URL: Homepage, https://github.com/atsuoishimoto/pyprod
 Project-URL: Documentation, https://pyprod.readthedocs.io/en/latest/
@@ -12,12 +12,13 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Build Tools
 Requires-Python: >=3.10
+Requires-Dist: python-dateutil
 Description-Content-Type: text/x-rst
 
 PyProd - More Makeable than Make
 =================================
 
-PyProd is a Python script that can be used as an alternative to Makefile. By leveraging Python's versatility, it enables you to define build rules and dependencies programmatically, allowing for dynamic configurations, integration with existing Python libraries, and custom build logic not easily achievable with traditional Makefiles. For detailed documentation, please refer to the `official documentation <https://pyprod.readthedocs.io/en/latest/>`_.
+PyProd is a Python script that can be used as an alternative to Makefile. By leveraging Python's versatility, it enables you to define build rules and dependencies programmatically, allowing for dynamic configurations, integration with existing Python libraries, and custom build logic not easily achievable with traditional Makefiles. For detailed documentation, please refer to the `official documentation <https://pyprod.readthedocs.io/en/stable/>`_.
 
 
 Features
@@ -42,22 +43,26 @@ With PyProd, a traditional Makefile for C can be expressed as a Python script li
 .. code-block:: python
 
     CC = "gcc"
-    CFLAGS = "-I."
+    CFLAGS = "-c -I."
     DEPS = "hello.h"
     OBJS = "hello.o main.o".split()
+    EXE = "hello.exe"
 
     @rule("%.o", depends=("%.c", DEPS))
     def compile(target, src, *deps):
-        run(CC, "-c -o", target, src, CFLAGS)
+        run(CC, "-o", target, src, CFLAGS)
 
-    @rule("hello.exe", depends=OBJS)
+    @rule(EXE, depends=OBJS)
     def link(target, *objs):
         run(CC, "-o", target, objs)
 
+    @task
     def clean():
         run("rm -f", OBJS, "hello.exe")
 
-    all = "hello.exe"
+    @task
+    def rebuild():
+        build(clean, EXE)
 
 
 To run the build script, simply execute:
@@ -67,6 +72,8 @@ To run the build script, simply execute:
     $ cd project
     $ pyprod
 
+Other examples can be found in the `samples <https://github.com/atsuoishimoto/pyprod/tree/main/samples>`_ directory.
+
 License
 -------
 PyProd is licensed under the MIT License. See the `LICENSE <LICENSE>`_ file for more details.

{pyprod-0.3.0 → pyprod-0.5.0}/README.rst

@@ -1,7 +1,7 @@
 PyProd - More Makeable than Make
 =================================
 
-PyProd is a Python script that can be used as an alternative to Makefile. By leveraging Python's versatility, it enables you to define build rules and dependencies programmatically, allowing for dynamic configurations, integration with existing Python libraries, and custom build logic not easily achievable with traditional Makefiles. For detailed documentation, please refer to the `official documentation <https://pyprod.readthedocs.io/en/latest/>`_.
+PyProd is a Python script that can be used as an alternative to Makefile. By leveraging Python's versatility, it enables you to define build rules and dependencies programmatically, allowing for dynamic configurations, integration with existing Python libraries, and custom build logic not easily achievable with traditional Makefiles. For detailed documentation, please refer to the `official documentation <https://pyprod.readthedocs.io/en/stable/>`_.
 
 
 Features
@@ -26,22 +26,26 @@ With PyProd, a traditional Makefile for C can be expressed as a Python script li
 .. code-block:: python
 
     CC = "gcc"
-    CFLAGS = "-I."
+    CFLAGS = "-c -I."
     DEPS = "hello.h"
     OBJS = "hello.o main.o".split()
+    EXE = "hello.exe"
 
     @rule("%.o", depends=("%.c", DEPS))
     def compile(target, src, *deps):
-        run(CC, "-c -o", target, src, CFLAGS)
+        run(CC, "-o", target, src, CFLAGS)
 
-    @rule("hello.exe", depends=OBJS)
+    @rule(EXE, depends=OBJS)
     def link(target, *objs):
         run(CC, "-o", target, objs)
 
+    @task
     def clean():
         run("rm -f", OBJS, "hello.exe")
 
-    all = "hello.exe"
+    @task
+    def rebuild():
+        build(clean, EXE)
 
 
 To run the build script, simply execute:
@@ -51,6 +55,8 @@ To run the build script, simply execute:
     $ cd project
     $ pyprod
 
+Other examples can be found in the `samples <https://github.com/atsuoishimoto/pyprod/tree/main/samples>`_ directory.
+
 License
 -------
 PyProd is licensed under the MIT License. See the `LICENSE <LICENSE>`_ file for more details.

pyprod-0.5.0/docs/commandline.rst

@@ -0,0 +1,23 @@
+
+.. _commandline:
+
+Command line options
+------------------------
+
+
+usage: pyprod [-h] [-C DIRECTORY] [-f FILE] [-j JOB] [-r] [-g] [-v] [targets ...]
+
+PyProd - More makable than make
+
+positional arguments:
+  targets               Build targets
+
+options:
+  -h, --help            show this help message and exit
+  -C, --directory DIRECTORY
+                        Change to DIRECTORY before performing any operations
+  -f, --file FILE       Use FILE as the Prodfile (default: 'Prodfile.py')
+  -j, --job JOB         Allow up to N jobs to run simultaneously (default: 1)
+  -r, --rebuild         Rebuild all
+  -g, --use-git         Get file timestamps from Git
+  -v                    Increase verbosity level (default: 0)

{pyprod-0.3.0 → pyprod-0.5.0}/docs/conf.py

@@ -7,7 +7,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "PyProd"
-copyright = "2024, Atsuo Ishimoto"
+copyright = "2024-2025, Atsuo Ishimoto"
 author = "Atsuo Ishimoto"
 
 # -- General configuration ---------------------------------------------------

{pyprod-0.3.0 → pyprod-0.5.0}/docs/index.rst

@@ -1,17 +1,47 @@
 PyProd - More Makeable than Make
 ============================================
-
 PyProd is a Python script that can be used as an alternative to Makefile. By leveraging Python's versatility, it enables you to define build rules and dependencies programmatically, allowing for dynamic configurations, integration with existing Python libraries, and custom build logic not easily achievable with traditional Makefiles.
 
 Features
 --------
-
 - Define build rules in Python: Use Python functions to create clear and concise build logic.
 - Specify dependencies for each rule: Automatically track and resolve dependencies between files, such as source files and headers.
 - Easily extendable with custom Python functions: Integrate custom logic for specialized tasks, like code linting or deployment.
 - Manages virtual environments: Automatically create and manage virtual environments for each project, ensuring a clean and isolated build environment.
 
 
+Example
+-------
+With PyProd, a traditional Makefile for C can be expressed as a Python script like this:
+
+.. code-block:: python
+
+    CC = "gcc"
+    CFLAGS = "-c -I."
+    DEPS = "hello.h"
+    OBJS = "hello.o main.o".split()
+    EXE = "hello.exe"
+
+    @rule("%.o", depends=("%.c", DEPS))
+    def compile(target, src, *deps):
+        run(CC, "-o", target, src, CFLAGS)
+
+    @rule(EXE, depends=OBJS)
+    def link(target, *objs):
+        run(CC, "-o", target, objs)
+
+    @task
+    def clean():
+        run("rm -f", OBJS, "hello.exe")
+
+    @task
+    def rebuild():
+        build(clean, EXE)
+
+
+
+Other examples can be found in the `samples <https://github.com/atsuoishimoto/pyprod/tree/main/samples>`_ directory.
+
 Table of Contents
 --------------------
 

{pyprod-0.3.0 → pyprod-0.5.0}/docs/prodfile.rst

@@ -10,12 +10,12 @@ Rule definition
 
 A rule is defined using the ``@rule`` decorator, which takes the target file as an argument. The target file is the output of the rule, and the function that follows the decorator is the build logic that generates the target file.
 
-.. py:function:: @rule(target, pattern=None, depends=(), uses=())
+.. py:function:: @rule(targets, pattern=None, *, depends=(), uses=())
 
    Defines rule to build target files.
 
-   :param target: The target file or files to be generated by the rule. Wildcards can be used in filenames, and exactly one % must be included in the filename.
-   :type target: str | Path|list[str | Path]
+   :param targets: The target file or files to be generated by the rule. Wildcards can be used in filenames, and exactly one % must be included in the filename.
+   :type target: str | Path | list[str | Path]
 
    :param pattern: Specify the pattern used to extract the stem of the target filename.
 
@@ -85,8 +85,8 @@ The rule decorator can also be used as a standalone function without being tied
 
 .. code-block:: python
 
-   rule(target=("file1", "file2"), depends="inc1")
-   rule(target=("file3", "file4"), uses="inc2")
+   rule(targets=("file1", "file2"), depends="inc1")
+   rule(targets=("file3", "file4"), uses="inc2")
 
 
 
@@ -97,12 +97,12 @@ Checker definition
 PyProd provides default checkers for common file types for files and directories. For non-file targets requiring specialized checks, you can define a custom checker to determine whether a build is needed.
 A checker is defined using the ``@check`` decorator, which takes the target file as an argument.
 
-.. py:function:: @check(target)
+.. py:function:: @check(targets)
 
    Defines a checker to get last modified time of the target.
 
-   :param target: The target file to be checked. Wildcards can be used.
-   :type target: str | Path
+   :param targets: The target file or files to be checked. Wildcards can be used.
+ :type target: str | Path | list[str | Path]
 
    :return: Last modified time of the file if the target exists. Returns false or raise FileNotFoundError if the target does not exist.
    :rtype: false|float|datetime.datetime
@@ -137,6 +137,37 @@ For example, a checker to retrieve the last modified timestamp of a file on Amaz
               return
           raise
    
+Task definition
+^^^^^^^^^^^^^^^^^^
+
+A task is similar to a rule but does not have a target and is always executed when it is depended upon.
+
+.. py:function:: @task(*, name=None, uses=(), default=False)
+
+   Defines a task to be executed.
+
+   :param name: The name of the task. Defaults to the function name.
+   :type name: str
+
+   :param uses: Specify the dependencies of the target file.
+   :type uses: str | Path | list[str | Path]
+
+   :param default: If True, this task will be executed when no target is specified in the command-line arguments.
+
+.. code-block:: python
+
+   @task(depends=("file1", "file2"))
+   def my_task(*files):
+       print("Task executed", files)
+
+
+`@task` can be used without any arguments if no dependencies are specified.
+
+.. code-block:: python
+
+   @task
+   def my_task(*files):
+       print("Task executed", files)
 
 
 
@@ -148,18 +179,31 @@ In addition to the ``@rule`` and ``@check`` decorators, PyProd provides several
 The following built-ins are available:
 
 
+.. py:function:: build(*deps)
+
+   Schedule dependencies. The specified deps are built sequentially after the current build completes.
+
+   :param deps: name of dependencies to be built.
+
+   Example:
+
+   .. code-block:: python
+
+      @task
+      def rebuild():
+          build(clean, EXE)
+
 .. py:function:: pip(*args)
 
    Install Python packages. It creates a virtual environment if one does not already exist and installs the specified packages.
    
    :param args: Arguments to pass to the pip install command.
-   :type target: str
 
-Example:
+   Example:
 
-.. code-block:: python
+   .. code-block:: python
    
-   pip("numpy", "pandas")
+      pip("numpy", "pandas")
 
 .. _run:
 
@@ -196,14 +240,14 @@ Example:
    .. code-block:: python
    
       run(["echo", "Hello, World!"]) # list style args
-      run(["echo Hello, World"]) # Shell style args
-      run(["echo", "Hello,", "World"]) # Shell style args (automactic concatenation)
+      run("echo Hello, World") # Shell style args
+      run("echo", "Hello,", "World") # Shell style args (automactic concatenation)
       run("echo", ["hello", ["world"]]) # Shell style args (automactic flattening)
    
       files = run("ls", stdout=True).stdout # Capture output
    
    
-.. py:function:: def capture(*args, echo=True, cwd=None, check=True, text=True, shell=None)
+.. py:function:: capture(*args, echo=True, cwd=None, check=True, text=True, shell=None)
 
    Execute a command and capture the output. This function is a wrapper around 
    :ref:`run <run>`.
@@ -211,10 +255,10 @@ Example:
    :param args: Command and arguments to execute. If first argument is a list, the first element is the command and the rest are arguments. Sequences specified for args are automatically flattened.
    :type args: str | Path | list[str | Path]
 
-   :echo: Print the command before executing it (default ``True``).
+   :param echo: Print the command before executing it (default ``True``).
    :type echo: bool
 
-   :cwd: Change the current working directory before executing the command.
+   :param cwd: Change the current working directory before executing the command.
    :type shell: str | Path | None
 
    :param check: Raise an exception if the command returns a non-zero exit code (default ``True``).
@@ -235,7 +279,7 @@ Example:
       msg = capture("echo Hello, World!")
    
 
-.. py:function:: read(filename):
+.. py:function:: read(filename)
    
    Read the contents of a file.
 
@@ -245,7 +289,7 @@ Example:
    :return: The contents of the file.
    :rtype: str
 
-.. py:function:: write(filename, txt, append=False):
+.. py:function:: write(filename, txt, append=False)
    
    Write text to a file.
 
@@ -258,7 +302,7 @@ Example:
    :param append: Append to the file instead of overwriting it (default ``False``).
    :type append: bool
 
-.. py:function:: makedirs(path):
+.. py:function:: makedirs(path)
    
    Create a directory along with any necessary parent directories if they do not already exist. This function wraps `os.makedirs() <https://docs.python.org/3/library/os.html#os.makedirs>`_ with the ``exists_ok`` parameter set to ``True``.
 
@@ -285,27 +329,34 @@ Example:
    
       SRCFILES = glob("**/*.c")
    
-.. py:function::  quote(s)
-.. py:function::  q(s)
+.. py:function::  quote(*s)
+.. py:function::  q(*s)
 
-   Convert ``s`` to string and quote for use as a shell command argument. This function is a wrapper around `shlex.quote() <https://docs.python.org/3/library/shlex.html#shlex.quote>`_.
+   Quote strings in ``s``. Each ``s`` is flattend.
 
    :param s: The string to quote.
-   :type s: str
+   :type s: str | list
 
-   :return: The quoted string.
-   :rtype: str
+   :return: The list of quoted strings.
+   :rtype: list[str]
 
-.. py:function::  squote(*s)
-.. py:function::  sq(*s)
+.. py:function::  squote(s)
+.. py:function::  sq(s)
 
-   Quote strings in ``s``. Each ``s`` is flattend.
+   Convert ``s`` to string and quote for use as a shell command argument. This function is a wrapper around `shlex.quote() <https://docs.python.org/3/library/shlex.html#shlex.quote>`_.
 
-   :param s: The string to quote.
+   :param s: The string to quote. If ``s`` is sequence, it is flattened and joined with space.
    :type s: str | list
 
-   :return: The list of quoted strings.
-   :rtype: list[str]
+   :return: The quoted string.
+   :rtype: str
+
+.. py:function:: use_git(use)
+   
+   Enable or disable git support. If enabled, PyProd retrieves the last modified time of the files from the git log.
+
+   :param use: Enable or disable git support.
+   :type bool: bool
 
 .. py:class::  Path
    
@@ -316,8 +367,7 @@ Example:
 
 .. py:data::  shutil
 
-   Module to perform high-level file operations. See `shutil <https://docs.python.org/3/library/shutil.html>`_ for detail.
-
+   An alias for the Python Standard Library's `shutil <https://docs.python.org/3/library/shutil.html>`_ module. This module provides a higher-level interface for file operations than the built-in `os <https://docs.python.org/3/library/os.html>`_ module.
 
 .. py:data:: env
    

pyprod-0.5.0/docs/releasenotes.rst

@@ -0,0 +1,22 @@
+Release Notes
+================
+
+0.5.0 (2025-2-12)
+-----------------------------
+
+- Added ``default`` to the ``@task``.
+- Removed ``depends`` from thr ``@task``.
+- Added --use-git commandline option.
+
+0.4.0 (2025-1-17)
+-------------------------
+- Swapped the behavior of quote() and squote() to make their naming more intuitive.
+- Add @task decorator.
+- Change the parameter name target to targets.
+- Added --rebuild option.
+
+0.3.0 (2025-01-03)
+------------------
+- Arguments for build and check function are converted to string.
+- Add built-in functions.
+- Validate rule dependencies.

{pyprod-0.3.0 → pyprod-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "PyProd"
-version = "0.3.0"
+dynamic = ["version"]
 description = "PyProd: More Makeable than Make"
 readme = "README.rst"
 requires-python = ">=3.10"
@@ -12,7 +12,9 @@ classifiers = [
     "Environment :: Console",
     "Topic :: Software Development :: Build Tools",
 ]
-dependencies = []
+dependencies = [
+    "python-dateutil",
+]
 
 [project.urls]
 Homepage = "https://github.com/atsuoishimoto/pyprod"
@@ -25,10 +27,14 @@ pyprod = "pyprod.main:main"
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
+[tool.hatch.version]
+path = "src/pyprod/__init__.py"
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.4",
     "pytest-asyncio>=0.25.0",
+    "pytest-mock>=3.14.0",
     "ruff>=0.8.4",
     "sphinx>=8.1.3",
     "sphinx-autobuild>=2024.10.3",

{pyprod-0.3.0/sample → pyprod-0.5.0/samples}/build-c/Makefile

@@ -7,7 +7,7 @@ OBJS = main.o hello.o
 %.o: %.c $(DEPS)
 	$(CC) -c -o $@ $< $(CFLAGS)
 
-hello.exe a.x: $(OBJS)
+hello.exe: $(OBJS)
 	$(CC) -o $@ $^
 
 clean:

pyprod-0.3.0/sample/build-c/PRODFILE.py → pyprod-0.5.0/samples/build-c/Prodfile.py

@@ -3,7 +3,7 @@
 
 APP = "hello.exe"
 CC = "gcc"
-CFLAGS = "-I."
+CFLAGS = "-c -I."
 DEPS = "hello.h"
 OBJS = "hello.o main.o".split()
 
@@ -15,11 +15,14 @@ def link(target, *src):
 
 @rule("%.o", depends=("%.c", DEPS))
 def compile(target, src, *deps):
-    run(CC, "-c -o", target, src, CFLAGS)
+    run(CC, "-o", target, src, CFLAGS)
 
 
+@task
 def clean():
     run("rm", "-rf", OBJS, APP)
 
 
-all = APP
+@task
+def rebuild():
+    build(clean, APP)

pyprod-0.3.0/sample/generate-doc/PRODFILE.py → pyprod-0.5.0/samples/generate-doc/Prodfile.py

@@ -15,7 +15,7 @@ def build_app(target, *src):
 
 @rule(BUILDDIR)
 def build_dir(target):
-    run("mkdir", target)
+    run("mkdir -p", target)
 
 
 @rule(BUILDDIR / "%.o", depends=("%.txt", COMMON), uses=BUILDDIR)
@@ -23,8 +23,11 @@ def build_c(target, src, *commons):
     run("cat", *commons, src, ">", target)
 
 
+@task
 def clean():
     run("rm", "-rf", BUILDDIR, BUILDFILES, DOC)
 
 
-all = DOC
+@task
+def rebuild():
+    build(clean, DOC)

{pyprod-0.3.0/sample → pyprod-0.5.0/samples}/md-to-pdf/Prodfile.py

@@ -39,9 +39,15 @@ def make_html(target, src, template, *_):
 # create outputs directory
 @rule(BUILD)
 def builds(target):
-    os.makedirs(target)
+    os.makedirs(target, exist_ok=True)
 
 
+@task
 def clean():
     shutil.rmtree(BUILD, ignore_errors=True)
     PDF.unlink(missing_ok=True)
+
+
+@task
+def rebuild():
+    build(clean, PDF)

{pyprod-0.3.0/sample → pyprod-0.5.0/samples}/s3files/Prodfile.py

@@ -1,7 +1,7 @@
 # ruff: NOQA
 # type: ignore
 
-pip("boto3")  # install boto3
+pip("boto3", "-q")  # install boto3
 
 import boto3, botocore
 from urllib.parse import urlparse
@@ -17,7 +17,7 @@ def parse_s3url(s3url):
     return parsed.netloc, parsed.path.lstrip("/")
 
 
-@rule(target=TARGET, pattern="*/%.txt", depends="%.txt")
+@rule(targets=TARGET, pattern="*/%.txt", depends="%.txt")
 def copyfile(target, src):
     """Copies a file to an S3 bucket."""
     bucket, key = parse_s3url(target)
@@ -36,16 +36,20 @@ def check_s3file(s3url):
         raise
 
 
+@task
 def clean():
     """Deletes an S3 file."""
     bucket, key = parse_s3url(TARGET)
     s3.delete_object(Bucket=bucket, Key=key)
 
 
+@task
 def ls():
     """Lists the contents of an S3 bucket."""
     bucket, key = parse_s3url(TARGET)
     run("aws s3 ls", bucket)
 
 
-rule("S3TEST.txt")  # Define target for default goal
+@task
+def rebuild():
+    build(clean, TARGET)

pyprod-0.5.0/src/pyprod/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.5.0"