makeapp 2.2.0__tar.gz → 2.4.0__tar.gz

{makeapp-2.2.0 → makeapp-2.4.0}/.gitignore

@@ -10,4 +10,5 @@ __pycache__
 .mypy_cache
 .ruff_cache
 .pytest_cache
+.ma-*
 .env

makeapp-2.4.0/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.5
+Name: makeapp
+Version: 2.4.0
+Summary: Simplifies routine Python application development processes.
+Project-URL: Homepage, https://github.com/idlesign/makeapp
+Project-URL: Documentation, https://makeapp.readthedocs.io/
+Author-email: Igor Starikov <idlesign@yandex.ru>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: development,scaffolding
+Requires-Python: >=3.11
+Requires-Dist: click
+Requires-Dist: jinja2~=3.1
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Description-Content-Type: text/markdown
+
+# makeapp
+
+[![PyPI - Version](https://img.shields.io/pypi/v/makeapp)](https://pypi.org/project/makeapp/)
+[![License](https://img.shields.io/pypi/l/makeapp)](https://pypi.org/project/makeapp/)
+[![Coverage](https://img.shields.io/coverallsCoverage/github/idlesign/makeapp)](https://coveralls.io/github/idlesign/makeapp)
+[![Docs](https://img.shields.io/readthedocs/makeapp)](https://makeapp.readthedocs.io/)
+
+`makeapp` scaffolds Python projects and provides one CLI for their common development tasks. It can create a project
+from composable templates, initialize Git and a virtual environment, run a GitHub Actions test matrix locally, maintain
+a changelog, and publish releases.
+
+## Install
+
+Python 3.11 or newer and [uv](https://docs.astral.sh/uv/getting-started/installation/) are required.
+
+```bash
+uv tool install makeapp
+```
+
+Both `makeapp` and its short alias `ma` invoke the same command.
+
+## Quick start
+
+```bash
+ma new shiny_app ./shiny-app --description "My app" --author "I am" --no-prompt
+cd shiny-app
+ma tests
+```
+
+The default scaffold contains a `src`-layout package, tests, project metadata, a changelog, and MkDocs documentation.
+The non-interactive command also initializes Git and runs `uv sync` to create `.venv`.
+
+Bundled templates can extend the default scaffold:
+
+- `console` for an `argparse` command-line application;
+- `click` for a Click command-line application;
+- `django` for a reusable Django application;
+- `pytestplugin` for a pytest plugin;
+- `webscaff` for a Linux-hosted Django/Webscaff project.
+
+For example:
+
+```bash
+ma new shiny_cli ./shiny-cli -t click --no-prompt
+```
+
+## Project workflow
+
+```bash
+ma up              # Synchronize the development environment.
+ma style           # Run Ruff checks and apply safe fixes.
+ma tests           # Run the configured test matrix.
+ma docs --build    # Build documentation without starting a server.
+ma change "+ Add a feature"  # Update the changelog and commit modified files.
+ma release         # Prepare a release and optionally publish it.
+```
+
+Review changes before running `ma change`: it stages and commits modified tracked files together with the changelog.
+
+## Documentation
+
+The full user and extension documentation is available at <https://makeapp.readthedocs.io/>.
+
+- [Quickstart](https://makeapp.readthedocs.io/en/latest/quickstart/)
+- [CLI reference](https://makeapp.readthedocs.io/en/latest/cli_reference/)
+- [Template authoring](https://makeapp.readthedocs.io/en/latest/template_authoring/)
+- [Publishing](https://makeapp.readthedocs.io/en/latest/publishing/)
+Issues and feature requests are welcome in the [GitHub issue tracker](https://github.com/idlesign/makeapp/issues).

makeapp-2.4.0/README.md

@@ -0,0 +1,68 @@
+# makeapp
+
+[![PyPI - Version](https://img.shields.io/pypi/v/makeapp)](https://pypi.org/project/makeapp/)
+[![License](https://img.shields.io/pypi/l/makeapp)](https://pypi.org/project/makeapp/)
+[![Coverage](https://img.shields.io/coverallsCoverage/github/idlesign/makeapp)](https://coveralls.io/github/idlesign/makeapp)
+[![Docs](https://img.shields.io/readthedocs/makeapp)](https://makeapp.readthedocs.io/)
+
+`makeapp` scaffolds Python projects and provides one CLI for their common development tasks. It can create a project
+from composable templates, initialize Git and a virtual environment, run a GitHub Actions test matrix locally, maintain
+a changelog, and publish releases.
+
+## Install
+
+Python 3.11 or newer and [uv](https://docs.astral.sh/uv/getting-started/installation/) are required.
+
+```bash
+uv tool install makeapp
+```
+
+Both `makeapp` and its short alias `ma` invoke the same command.
+
+## Quick start
+
+```bash
+ma new shiny_app ./shiny-app --description "My app" --author "I am" --no-prompt
+cd shiny-app
+ma tests
+```
+
+The default scaffold contains a `src`-layout package, tests, project metadata, a changelog, and MkDocs documentation.
+The non-interactive command also initializes Git and runs `uv sync` to create `.venv`.
+
+Bundled templates can extend the default scaffold:
+
+- `console` for an `argparse` command-line application;
+- `click` for a Click command-line application;
+- `django` for a reusable Django application;
+- `pytestplugin` for a pytest plugin;
+- `webscaff` for a Linux-hosted Django/Webscaff project.
+
+For example:
+
+```bash
+ma new shiny_cli ./shiny-cli -t click --no-prompt
+```
+
+## Project workflow
+
+```bash
+ma up              # Synchronize the development environment.
+ma style           # Run Ruff checks and apply safe fixes.
+ma tests           # Run the configured test matrix.
+ma docs --build    # Build documentation without starting a server.
+ma change "+ Add a feature"  # Update the changelog and commit modified files.
+ma release         # Prepare a release and optionally publish it.
+```
+
+Review changes before running `ma change`: it stages and commits modified tracked files together with the changelog.
+
+## Documentation
+
+The full user and extension documentation is available at <https://makeapp.readthedocs.io/>.
+
+- [Quickstart](https://makeapp.readthedocs.io/en/latest/quickstart/)
+- [CLI reference](https://makeapp.readthedocs.io/en/latest/cli_reference/)
+- [Template authoring](https://makeapp.readthedocs.io/en/latest/template_authoring/)
+- [Publishing](https://makeapp.readthedocs.io/en/latest/publishing/)
+Issues and feature requests are welcome in the [GitHub issue tracker](https://github.com/idlesign/makeapp/issues).

makeapp-2.4.0/src/makeapp/__init__.py

@@ -0,0 +1,3 @@
+
+VERSION = '2.4.0'
+"""Application version number tuple."""

{makeapp-2.2.0 → makeapp-2.4.0}/src/makeapp/app_templates/__default__/.github/workflows/python-package.yml

@@ -2,9 +2,7 @@ name: Python package
 
 on:
   push:
-    branches: [ master ]
   pull_request:
-    branches: [ master ]
 
 jobs:
   build:

{makeapp-2.2.0 → makeapp-2.4.0}/src/makeapp/app_templates/__default__/.gitignore

@@ -11,5 +11,6 @@ __pycache__
 .mypy_cache
 .ruff_cache
 .pytest_cache
+.ma-*
 .env
-{% endblock %}
+{% endblock %}

makeapp-2.4.0/src/makeapp/app_templates/__default__/INSTALL.md

@@ -0,0 +1,35 @@
+# Installing {{ app_name }}
+
+Python {{ python_version }} or newer and [uv](https://docs.astral.sh/uv/) are required.
+
+## From PyPI
+
+Add the package to a project:
+
+```bash
+uv add {{ app_name }}
+```
+
+If the package exposes a command-line application, install it as an isolated tool:
+
+```bash
+uv tool install {{ app_name }}
+```
+
+Upgrade the tool with:
+
+```bash
+uv tool upgrade {{ app_name }}
+```
+
+## From source
+
+Clone the repository and synchronize its development environment:
+
+```bash
+git clone https://example.com/owner/repository.git {{ app_name }}
+cd {{ app_name }}
+uv sync
+```
+
+Replace the example repository URL with the source repository. Run commands in the project environment with `uv run`.

makeapp-2.4.0/src/makeapp/app_templates/__default__/README.md

@@ -0,0 +1,33 @@
+# {{ app_name }}
+
+[![PyPI - Version](https://img.shields.io/pypi/v/{{ app_name }})](https://pypi.org/project/{{ app_name }}/)
+[![License](https://img.shields.io/pypi/l/{{ app_name }})](https://pypi.org/project/{{ app_name }}/)
+[![Docs](https://img.shields.io/readthedocs/{{ app_name }})](https://{{ app_name }}.readthedocs.io/)
+{% block badges %}
+{% endblock %}
+
+*{{ description }}*
+
+Project homepage: <{{ url }}>
+
+## Install
+
+```bash
+uv add {{ app_name }}
+```
+
+See [INSTALL.md](INSTALL.md) for installation from source and tool installation.
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+uv run mkdocs build --strict
+```
+
+Project documentation is available at <https://{{ app_name }}.readthedocs.io/>.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) before submitting an issue or pull request.

makeapp-2.4.0/src/makeapp/app_templates/__default__/docs/index.md

@@ -0,0 +1,21 @@
+# {{ app_name }}
+
+*{{ description }}*
+
+## Requirements
+
+- Python {{ python_version }} or newer
+- [uv](https://docs.astral.sh/uv/)
+
+## Install
+
+```bash
+uv add {{ app_name }}
+```
+
+Continue with the [quickstart](quickstart.md) to verify the installation and run the project checks.
+
+## Project links
+
+- [Source and issue tracker]({{ url }})
+- [PyPI](https://pypi.org/project/{{ app_name }}/)

makeapp-2.4.0/src/makeapp/app_templates/__default__/docs/quickstart.md

@@ -0,0 +1,21 @@
+# Quickstart
+
+Install {{ app_name }} in an existing uv project:
+
+```bash
+uv add {{ app_name }}
+```
+
+To work on the source checkout, synchronize dependencies and run the checks:
+
+```bash
+uv sync
+uv run pytest
+uv run mkdocs build --strict
+```
+
+Start the local documentation server with:
+
+```bash
+uv run mkdocs serve
+```

{makeapp-2.2.0 → makeapp-2.4.0}/src/makeapp/app_templates/__default__/pyproject.toml

@@ -40,11 +40,15 @@ Homepage = "{{ url }}"
 
 [dependency-groups]
 dev = [
+    {include-group = "docs"},
     {include-group = "linters"},
     {include-group = "tests"},
 {% block deps_dev %}
 {% endblock %}
 ]
+docs = [
+    "mkdocs-material",
+]
 linters = [
 {% block deps_linters %}
 {% endblock %}

makeapp-2.4.0/src/makeapp/app_templates/__default__/tests/test_basic.py

@@ -0,0 +1,11 @@
+import pytest
+
+
+class TestApp:
+
+    def test_method(self):
+
+        assert 1 == 1
+
+        with pytest.raises(ValueError, match='Tested!'):
+            raise ValueError('Tested!')

{makeapp-2.2.0 → makeapp-2.4.0}/src/makeapp/app_templates/webscaff/makeappconf.py

@@ -10,8 +10,6 @@ join = os.path.join  # Short alias
 
 class WebscaffConfig(Config):
 
-    parent_template = ['pytest']
-
     domain = ConfigSetting(title='Domain Name', default='')
     email = ConfigSetting(title='Admin E-mail')
     host = ConfigSetting(title='Remote Host IP')
@@ -51,21 +49,21 @@ class WebscaffConfig(Config):
 
         # Install into venv the package itself not to conflict
         # with Django's `startproject` command.
-        run_command('. venv/bin/activate && pip install -e .')
+        run_command(['venv/bin/pip', 'install', '-e', '.'])
 
         # Initialize local sqlite DB.
-        run_command(f'venv/bin/{package_name} makemigrations')
-        run_command(f'venv/bin/{package_name} migrate')
+        run_command([f'venv/bin/{package_name}', 'makemigrations'])
+        run_command([f'venv/bin/{package_name}', 'migrate'])
 
     def prepare_venv(self):
         self.logger.info('Bootstrapping virtual environment for project ...')
 
-        run_command('python3 -m venv venv/')
+        run_command(['python3', '-m', 'venv', 'venv/'])
 
-        cmd_install = '. venv/bin/activate && pip install -r '
+        cmd_install = ['venv/bin/pip', 'install', '-r']
 
-        run_command(cmd_install + 'requirements.txt')
-        run_command(cmd_install + 'tests/requirements.txt')
+        run_command([*cmd_install, 'requirements.txt'])
+        run_command([*cmd_install, 'tests/requirements.txt'])
 
     def prepare_django_settings_base(self, dir_tmp):
 
@@ -107,10 +105,10 @@ class WebscaffConfig(Config):
         dir_package = self.dir_package_root
         package_name = self.package_name
 
-        command_django_admin = './venv/bin/django-admin'
+        command_django_admin = 'venv/bin/django-admin'
 
         with temp_dir() as dir_tmp:
-            run_command(f'{command_django_admin} startproject {package_name} {dir_tmp}')
+            run_command([command_django_admin, 'startproject', package_name, dir_tmp])
 
             # We'd replace settings module paths.
             replace = partial(
@@ -131,7 +129,7 @@ class WebscaffConfig(Config):
 
         # Create basic app.
         dir_app = join(dir_package, 'core')
-        run_command(f'{command_django_admin} startapp core {dir_app}')
+        run_command([command_django_admin, 'startapp', 'core', dir_app])
         replace_infile(
             join(dir_app, 'apps.py'),
             {

{makeapp-2.2.0 → makeapp-2.4.0}/src/makeapp/appmaker.py

@@ -1,3 +1,4 @@
+import keyword
 import logging
 import os
 import re
@@ -13,7 +14,7 @@ from .exceptions import AppMakerException
 from .helpers.vcs import VcsHelper
 from .helpers.venvs import VenvHelper
 from .rendering import Renderer
-from .utils import PYTHON_VERSION, configure_logging, get_user_dir, read_ini
+from .utils import PYTHON_MIN_VERSION, configure_logging, get_user_dir, read_ini
 
 RE_UNKNOWN_MARKER = re.compile(r'{{ [^}]+ }}')
 BASE_PATH = os.path.dirname(__file__)
@@ -68,7 +69,7 @@ class AppMaker:
         'license_ident': LICENSES[default_license][1],
         'vcs': default_vcs,
         'vcs_remote': None,
-        'python_version': '.'.join(map(str, PYTHON_VERSION[:2])),
+        'python_version': '.'.join(map(str, PYTHON_MIN_VERSION)),
     }
 
     app_template_default: AppTemplate = None
@@ -113,7 +114,7 @@ class AppMaker:
 
         # Support for user-supplied template directories.
         for template in templates_to_use or []:
-            if '/' in template:
+            if os.sep in template:
                 parent = str(Path(template).parent)
                 if parent not in search_paths:
                     search_paths.append(parent)
@@ -225,13 +226,24 @@ class AppMaker:
         name_available = True
 
         for label, url in sites_registry.items():
-            response = requests.get(url)
+            try:
+                response = requests.get(url, timeout=5)
+            except requests.RequestException as e:
+                raise AppMakerException(
+                    f'Unable to check application name at {label}: {e}.'
+                ) from e
 
             if response.status_code == 200:
                 self.logger.warning(f'Application name seems to be in use: {label} - {url}')
                 name_available = False
                 break
 
+            if response.status_code != 404:
+                raise AppMakerException(
+                    f'Unable to check application name at {label}: '
+                    f'HTTP {response.status_code}.'
+                )
+
         if name_available:
             self.logger.info(
                 f"Application name `{self.settings['app_name']}` seems "
@@ -302,6 +314,7 @@ class AppMaker:
         :param remote_push: Whether to push to remote.
 
         """
+        dest = os.path.abspath(dest)
         self.logger.info(f'Application target path: {dest}')
 
         # Make remote available for hooks.
@@ -329,8 +342,18 @@ class AppMaker:
             self._hook_run('rollout_pre')
 
         files = self._get_template_files()
+        dest_path = Path(dest).resolve()
         for target, template_file in files.items():
-            target = os.path.join(dest, target)
+            target_path = (dest_path / target).resolve()
+
+            try:
+                target_path.relative_to(dest_path)
+            except ValueError as e:
+                raise AppMakerException(
+                    f'Template target path escapes destination: {target}.'
+                ) from e
+
+            target = f'{target_path}'
 
             if not os.path.exists(target) or overwrite:
 
@@ -377,11 +400,7 @@ class AppMaker:
 
         """
         with open(path, 'w') as f:
-
-            f.write(contents)
-
-            if contents.endswith('\n'):
-                f.write('\n')
+            f.write(contents.rstrip('\n') + '\n')
 
     def _copy_file(self, src: TemplateFile, dest: str, prepend_data: str = None):
         """Copies a file from `src` to `dest` replacing settings markers
@@ -579,6 +598,12 @@ class AppMaker:
         for name, val in settings_base.items():
             settings_base[name] = self._replace_settings_markers(val, settings=settings_base)
 
+        package_name = settings_base['package_name']
+        if not package_name or not package_name.isidentifier() or keyword.iskeyword(package_name):
+            raise AppMakerException(
+                f'Invalid Python package name: `{package_name}`.'
+            )
+
         self._validate_setting('license', list(self.LICENSES), settings_base)
 
         license = self.LICENSES[settings_base['license']]

{makeapp-2.2.0 → makeapp-2.4.0}/src/makeapp/apptemplate.py

@@ -120,12 +120,12 @@ class AppTemplate:
 
                 full_path = os.path.join(path, fname)
 
-                rel_path = full_path.replace(templates_path, '').lstrip('/')
+                rel_path = os.path.relpath(full_path, templates_path)
 
                 template_file = TemplateFile(
                     template=self,
                     path_full=full_path,
-                    path_rel=rel_path,
+                    path_rel=rel_path.replace(os.sep, '/'),
                 )
 
                 rel_path = rel_path.replace(maker.package_dir_marker, maker.settings['package_name'])
@@ -174,9 +174,9 @@ class AppTemplate:
 
         """
         for supposed_path in search_paths:
-            if '/' in supposed_path and os.path.exists(supposed_path):
+            if os.sep in supposed_path and os.path.exists(supposed_path):
                 path = str(os.path.abspath(supposed_path))
-                return path.split('/')[-1], path
+                return path.split(os.sep)[-1], path
 
         raise AppMakerException(
             f"Unable to find application template {name_or_path}. "
@@ -221,7 +221,7 @@ class TemplateFile:
 
             if os.path.exists(path_full):
                 # Check parent file exists in template.
-                paths.append(os.path.join(parent.name, path_rel))
+                paths.append(f'{parent.name}/{path_rel}')
 
             if parent.is_default:
                 break