makeapp 1.9.0__tar.gz → 2.0.0__tar.gz

makeapp-1.9.0/makeapp/app_templates/__default__/.hgignore → makeapp-2.0.0/.gitignore

@@ -1,12 +1,13 @@
-syntax:glob
-{% block contents %}
 .project
 .pydevproject
 .idea
 .tox
+.venv
 __pycache__
 *.pyc
 *.pyo
 *.egg-info
-docs/_build/
-{% endblock %}
+.mypy_cache
+.ruff_cache
+.pytest_cache
+.env

{makeapp-1.9.0 → makeapp-2.0.0}/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2023, Igor `idle sign` Starikov
+Copyright (c) 2013-2025, Igor `idle sign` Starikov
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

makeapp-2.0.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: makeapp
+Version: 2.0.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.10
+Requires-Dist: click
+Requires-Dist: jinja2~=3.1
+Requires-Dist: requests
+Description-Content-Type: text/markdown
+
+# makeapp
+
+https://github.com/idlesign/makeapp
+
+[![PyPI - Version](https://img.shields.io/pypi/v/makeapp)](https://pypi.python.org/pypi/makeapp)
+[![License](https://img.shields.io/pypi/l/makeapp)](https://pypi.python.org/pypi/makeapp)
+[![Coverage](https://img.shields.io/coverallsCoverage/github/idlesign/makeapp)](https://coveralls.io/r/idlesign/makeapp)
+[![Docs](https://img.shields.io/readthedocs/makeapp)](https://makeapp.readthedocs.io/)
+
+## Description
+
+*Simplifies routine Python application development processes.*
+
+* Make a skeleton for your new application with one console command.
+* Automatically create a VCS repository for your application.
+* Automatically check whether the chosen application name is not already in use.
+* Customize new application layouts with skeleton templates.
+* Put some skeleton default settings into a configuration file not to mess with command line switches anymore.
+* Easily add entries to your changelog.
+* Publish your application to remotes (VCS, PyPI) with a single command.
+* Easily bootstrap your development environment.
+* Run code styling/linting.
+
+## Application scaffolding
+
+Scaffold a new application:
+
+``` bash
+ma new shiny_app /home/librarian/shiny/ --description "My app." --author "I am"
+```
+
+!!! note
+    `ma` is a convenient alias for `makeapp` command.
+
+This will create a decent application skeleton using the default skeleton template (``pyproject.toml``, docs, tests, etc.)
+and initialize Git repository.
+
+`makeapp` also bundles templates for commonly used application types:
+
+* `click` powered app
+* `pytest` plugin
+* `Django` app
+* `webscaff` project [here](https://github.com/idlesign/webscaff)
+* etc.
+
+Multiple templates can be used together. Complete list of featured templates can be found in the documentation.
+User-made templates are also supported.
+
+
+## Adding changes
+
+When you're ready to add another entry to your changelog use `change` command:
+
+``` bash
+ma change "+ New 'change' command implemented"
+```
+
+This will also stage and commit all changed files.
+
+## Application publishing
+
+When you're ready to publish issue the following command:
+
+``` bash
+ma release
+; Bump version number part manually: major, minor, patch
+ma release --increment major
+```
+
+This will automatically:
+
+* bump up application version number
+* tag version in VCS
+* push sources to remote repository
+* upload application package to PyPI
+
+
+## Dev environment bootstrap
+
+Or you just want to participate in the development of some other app.
+
+Use `tools` and `up` commands to initialize tools and the environment to develop the application. 
+
+``` bash
+ma tools
+ma up
+```
+
+## Code style
+
+Apply code style with `style` command:
+
+``` bash
+ma style
+```
+
+## Documentation
+
+https://makeapp.readthedocs.io/

makeapp-2.0.0/README.md

@@ -0,0 +1,99 @@
+# makeapp
+
+https://github.com/idlesign/makeapp
+
+[![PyPI - Version](https://img.shields.io/pypi/v/makeapp)](https://pypi.python.org/pypi/makeapp)
+[![License](https://img.shields.io/pypi/l/makeapp)](https://pypi.python.org/pypi/makeapp)
+[![Coverage](https://img.shields.io/coverallsCoverage/github/idlesign/makeapp)](https://coveralls.io/r/idlesign/makeapp)
+[![Docs](https://img.shields.io/readthedocs/makeapp)](https://makeapp.readthedocs.io/)
+
+## Description
+
+*Simplifies routine Python application development processes.*
+
+* Make a skeleton for your new application with one console command.
+* Automatically create a VCS repository for your application.
+* Automatically check whether the chosen application name is not already in use.
+* Customize new application layouts with skeleton templates.
+* Put some skeleton default settings into a configuration file not to mess with command line switches anymore.
+* Easily add entries to your changelog.
+* Publish your application to remotes (VCS, PyPI) with a single command.
+* Easily bootstrap your development environment.
+* Run code styling/linting.
+
+## Application scaffolding
+
+Scaffold a new application:
+
+``` bash
+ma new shiny_app /home/librarian/shiny/ --description "My app." --author "I am"
+```
+
+!!! note
+    `ma` is a convenient alias for `makeapp` command.
+
+This will create a decent application skeleton using the default skeleton template (``pyproject.toml``, docs, tests, etc.)
+and initialize Git repository.
+
+`makeapp` also bundles templates for commonly used application types:
+
+* `click` powered app
+* `pytest` plugin
+* `Django` app
+* `webscaff` project [here](https://github.com/idlesign/webscaff)
+* etc.
+
+Multiple templates can be used together. Complete list of featured templates can be found in the documentation.
+User-made templates are also supported.
+
+
+## Adding changes
+
+When you're ready to add another entry to your changelog use `change` command:
+
+``` bash
+ma change "+ New 'change' command implemented"
+```
+
+This will also stage and commit all changed files.
+
+## Application publishing
+
+When you're ready to publish issue the following command:
+
+``` bash
+ma release
+; Bump version number part manually: major, minor, patch
+ma release --increment major
+```
+
+This will automatically:
+
+* bump up application version number
+* tag version in VCS
+* push sources to remote repository
+* upload application package to PyPI
+
+
+## Dev environment bootstrap
+
+Or you just want to participate in the development of some other app.
+
+Use `tools` and `up` commands to initialize tools and the environment to develop the application. 
+
+``` bash
+ma tools
+ma up
+```
+
+## Code style
+
+Apply code style with `style` command:
+
+``` bash
+ma style
+```
+
+## Documentation
+
+https://makeapp.readthedocs.io/

makeapp-2.0.0/pyproject.toml

@@ -0,0 +1,91 @@
+[project]
+name = "makeapp"
+dynamic = ["version"]
+description = "Simplifies routine Python application development processes."
+authors = [
+    { name = "Igor Starikov", email = "idlesign@yandex.ru" }
+]
+readme = "README.md"
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+keywords = ["scaffolding", "development"]
+dependencies = [
+    "requests",
+    "click",
+    "jinja2~=3.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/idlesign/makeapp"
+Documentation = "https://makeapp.readthedocs.io/"
+
+[project.scripts]
+makeapp = "makeapp.cli:main"
+ma = "makeapp.cli:main"
+
+[dependency-groups]
+dev = [
+    {include-group = "docs"},
+    {include-group = "linters"},
+    {include-group = "tests"},
+]
+docs = [
+    "mkdocs-material",
+    "mkdocs-navsorted-plugin",
+]
+linters = [
+]
+tests = [
+    "pytest",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/makeapp/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/makeapp"]
+
+[tool.hatch.build.targets.sdist]
+packages = ["src/"]
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
+
+[tool.coverage.run]
+source = [
+    "src/",
+]
+omit = [
+    "*/app_templates/*",
+    "*/license_templates/*",
+    "*/cli.py",
+]
+
+[tool.coverage.report]
+fail_under = 90.00
+exclude_also = [
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+]
+
+[tool.tox]
+skip_missing_interpreters = true
+env_list = [
+  "py310",
+  "py311",
+  "py312",
+  "py313",
+]
+
+[tool.tox.env_run_base]
+dependency_groups = ["tests"]
+commands = [
+  ["pytest", { replace = "posargs", default = ["tests"], extend = true }],
+]

makeapp-2.0.0/src/makeapp/__init__.py

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

{makeapp-1.9.0 → makeapp-2.0.0/src}/makeapp/app_templates/__default__/.gitignore

@@ -3,9 +3,13 @@
 .pydevproject
 .idea
 .tox
+.venv
 __pycache__
 *.pyc
 *.pyo
 *.egg-info
-docs/_build/
+.mypy_cache
+.ruff_cache
+.pytest_cache
+.env
 {% endblock %}

makeapp-2.0.0/src/makeapp/app_templates/__default__/AUTHORS.md

@@ -0,0 +1,13 @@
+# {{ app_name }} authors
+
+Created by {{ author }}.
+
+
+## Contributors
+
+Here could be your name.
+
+
+## Translators
+
+Here could be your name.

makeapp-2.0.0/src/makeapp/app_templates/__default__/CHANGELOG.md

@@ -0,0 +1,5 @@
+# {{ app_name }} changelog
+
+
+### Unreleased
+* ++ Basic functionality.

makeapp-1.9.0/makeapp/app_templates/__default__/CONTRIBUTING → makeapp-2.0.0/src/makeapp/app_templates/__default__/CONTRIBUTING.md

@@ -1,22 +1,20 @@
-{{ get_app_title_rst('contributing') }}
+# contributing {{ app_name }}
 
 
-Submit issues
--------------
+## Submit issues
 
 If you spotted something weird in application behavior or want to propose a feature you are welcome.
 
 
-Write code
-----------
+## Write code
+
 If you are eager to participate in application development and to work on an existing issue (whether it should
 be a bugfix or a feature implementation), fork, write code, and make a pull request right from the forked project page.
 
 
-Spread the word
----------------
+## Spread the word
 
-If you have some tips and tricks or any other words that you think might be of interest for the others — publish it
+If you have some tips and tricks or any other words that you think might be of interest for the others --- publish it
 wherever you find convenient.
 
 

makeapp-1.9.0/makeapp/app_templates/__default__/INSTALL → makeapp-2.0.0/src/makeapp/app_templates/__default__/INSTALL.md

@@ -1,23 +1,18 @@
-{{ get_app_title_rst('installation') }}
+# {{ app_name }} installation
 
 
 Python ``pip`` package is required to install ``{{ app_name }}``.
 
 
-From sources
-------------
+## From sources
 
-Use the following command line to install ``{{ app_name }}`` from sources directory (containing setup.py):
 
-    pip install .
-
-or
+Use the following command line to install ``{{ app_name }}`` from sources directory (containing ``pyproject.toml``):
 
-    python setup.py install
+    pip install .
 
 
-From PyPI
----------
+## From PyPI
 
 Alternatively you can install ``{{ app_name }}`` from PyPI:
 

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

@@ -0,0 +1,22 @@
+# {{ app_name }}
+
+{{ url }}
+
+[![PyPI - Version](https://img.shields.io/pypi/v/{{ app_name }})](https://pypi.python.org/pypi/{{ app_name }})
+[![License](https://img.shields.io/pypi/l/{{ app_name }})](https://pypi.python.org/pypi/{{ app_name }})
+[![Docs](https://img.shields.io/readthedocs/{{ app_name }})](https://{{ app_name }}.readthedocs.io/)
+{% block badges %}
+{% endblock %}
+
+**Work in progress. Stay tuned.**
+
+## Description
+
+*{{ description }}*
+
+Here will be an introductory description.
+
+
+## Documentation
+
+https://{{ app_name }}.readthedocs.io/

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

@@ -0,0 +1,37 @@
+# Introduction
+
+<{{ url }}>
+
+
+## Description
+
+*{{ description }}*
+
+Here will be an introductory description.
+
+
+## Requirements
+
+1. Python {{ python_version }}+
+
+## Installation
+
+``` shell
+pip install {{ app_name }}
+```
+
+
+## Get involved into {{ app_name }}
+
+!!! success "Submit issues"
+    If you spotted something weird in application behavior or want to propose a feature you are welcome.
+
+!!! tip "Write code"
+    If you are eager to participate in application development, 
+    fork it, write 
+    your code, whether it should be a bugfix or a feature implementation,
+    and make a pull request right from the forked project page.
+
+!!! info "Spread the word"
+    If you have some tips and tricks or any other words in mind that 
+    you think might be of interest for the others --- publish it.

makeapp-1.9.0/makeapp/app_templates/__default__/docs/source/quickstart.rst → makeapp-2.0.0/src/makeapp/app_templates/__default__/docs/quickstart.md

@@ -1,5 +1,3 @@
-Quickstart
-==========
+# Quickstart
 
 Here will be a short and basic usage sample.
-

makeapp-2.0.0/src/makeapp/app_templates/__default__/mkdocs.yml

@@ -0,0 +1,33 @@
+site_name: {{ app_name }}
+#site_url: !ENV READTHEDOCS_CANONICAL_URL
+
+copyright: Copyright © {{ year }}, {{ author }}
+
+#repo_url: https://some.com/user/repo
+#edit_uri: edit/master/docs/
+
+plugins:
+  - search
+
+theme:
+  name: material
+  palette:
+    primary: indigo
+  features:
+    - navigation.top
+    - toc.follow
+    - content.action.view
+    - content.action.edit
+    - content.code.copy
+
+markdown_extensions:
+  - admonition
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - toc:
+      permalink: true

makeapp-2.0.0/src/makeapp/app_templates/__default__/pyproject.toml

@@ -0,0 +1,114 @@
+[project]
+name = "{{ app_name }}"
+dynamic = ["version"]
+description = "{{ description }}"
+authors = [
+    { name = "{{ author }}", email = "{{ author_email }}" }
+]
+readme = "README.md"
+
+classifiers = [
+{% block classifiers %}
+    "Development Status :: 4 - Beta", #   3 - Alpha; 5 - Production/Stable
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: {{ python_version }}",
+{% endblock %}
+]
+
+license = "{{ license_ident }}"
+license-files = ["LICENSE"]
+
+requires-python = ">={{ python_version }}"
+dependencies = [
+{% block deps %}
+{% endblock %}
+]
+
+[project.urls]
+Homepage = "{{ url }}"
+
+[project.scripts]
+{% block scripts %}
+{% endblock %}
+
+{% block entry_points_custom %}{% endblock %}
+
+[project.optional-dependencies]
+{% block deps_opts %}
+{% endblock %}
+
+[dependency-groups]
+dev = [
+    {include-group = "linters"},
+    {include-group = "tests"},
+{% block deps_dev %}
+{% endblock %}
+]
+linters = [
+{% block deps_linters %}
+{% endblock %}
+]
+tests = [
+    {% block deps_tests %}
+    "pytest",
+    {% endblock %}
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/{{ package_name }}/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/{{ package_name }}"]
+
+[tool.hatch.build.targets.sdist]
+packages = ["src/"]
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
+
+[tool.coverage.run]
+source = [
+    "src/",
+]
+omit = [
+{% block cov_omit %}
+{% endblock %}
+]
+
+[tool.coverage.report]
+fail_under = 90.00
+exclude_also = [
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+]
+
+[tool.tox]
+skip_missing_interpreters = true
+env_list = [
+{% block tox_envlist %}
+  "py310",
+  "py311",
+  "py312",
+  "py313",
+{% endblock %}
+]
+
+[tool.tox.env_run_base]
+dependency_groups = ["tests"]
+deps = [
+{% block tox_deps %}
+{% endblock %}
+]
+commands = [
+  ["pytest", { replace = "posargs", default = ["tests"], extend = true }],
+]
+
+{% block tools_ext %}
+{% endblock %}

makeapp-2.0.0/src/makeapp/app_templates/__default__/ruff.toml

@@ -0,0 +1,44 @@
+target-version = "py310"
+line-length = 120
+
+[format]
+quote-style = "single"
+exclude = []
+
+[lint]
+select = [
+    "B",  # possible bugs
+    "BLE",  # broad exception
+    "C4",  # comprehensions
+    "DTZ",  # work with datetimes
+    "E",  # code style
+    "ERA",  # commented code
+    "EXE",  # check executables
+    "F",  # misc
+    "FA",  # future annotations
+    "FBT",  # booleans
+    "FURB",  # modernizing
+    "G",  # logging format
+    "I",  # imports
+    "ICN",  # import conventions
+    "INT",  # i18n
+    "ISC",  # stringc concat
+    "PERF",  # perfomance
+    "PIE",  # misc
+    "PLC",  # misc
+    "PLE",  # misc err
+    "PT",  # pytest
+    "PTH",  # pathlib
+    "PYI",  # typing
+    "RSE", # exc raise
+    "RUF",  # misc
+    "SLOT",  # slots related
+    "TC",  # typing
+    "UP",  # py upgrade
+]
+
+ignore = []
+
+
+[lint.extend-per-file-ignores]
+"tests/*" = []