Add unified up command.

Author: idlesign

CHANGELOG.md

@@ -6,7 +6,7 @@
 * ++ Add 'ma' alias for 'makeapp' command.
 * ++ Added virtual environment creation on project rollout.
 * ++ CLI. Add 'publish' command.
-* ++ CLI. Added 'venv reset' command.
+* ++ CLI. Added 'up' command.
 * ++ CLI. Descriptions passed to 'change' command all go into a commit messages.
 * ** Added QA for Py 3.11, 3.12, 3.13.
 * ** Dropped QA for Py 3.7, 3.8, 3.9.

README.md

@@ -9,7 +9,7 @@ https://github.com/idlesign/makeapp
 
 ## Description
 
-*Simplifies Python application rollout and publishing.*
+*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.
@@ -18,7 +18,7 @@ https://github.com/idlesign/makeapp
 * 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.
 
 ## Application scaffolding
 
@@ -73,6 +73,17 @@ This will automatically:
 * 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 `up` initialize the environment to develop that application. 
+
+``` bash
+ma up
+```
+
 ## Documentation
 
 https://makeapp.readthedocs.io/

docs/040_development.md

@@ -0,0 +1,32 @@
+# Developer tools
+
+Makeapp gives you some tools to further facilitate the development process.
+
+## Bootstrap virtual environment
+
+When you've got an app sources and want to initialize the environment to develop the app 
+use `up` command (inside the directory with `pyproject.toml`).
+
+```bash
+ma up
+```
+
+## Register the CLI application as a tool
+
+If your application has a CLI (e.g. exposes `project.scripts`) you can register
+it as a tool. So that the command issued in terminal will invoke just the code you develop.
+
+```bash
+ma up -t
+# or ma up --tool
+```
+
+## Regenerate the environment
+
+Sometimes something may go wrong with the virtual environment so that you may want 
+to drop the old one altogether and create a new one. Use the following command: 
+
+```bash
+ma up -r
+# or ma up --reset
+```

docs/index.md

@@ -4,7 +4,7 @@
 
 ## Description
 
-*Simplifies Python application rollout and publishing.*
+*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.
@@ -13,6 +13,7 @@
 * 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 single command.
+* Easily bootstrap your development environment.
 
 
 ## Requirements

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "makeapp"
 dynamic = ["version"]
-description = "Simplifies Python application rollout and publishing."
+description = "Simplifies routine Python application development processes."
 authors = [
     { name = "Igor Starikov", email = "[email protected]" }
 ]

src/makeapp/apptools.py

@@ -501,10 +501,9 @@ def publish(self):
             self.vcs.push()
             DistHelper.upload()
 
-    def venv_init(self, *, reset: bool = False, register: bool = False):
-        LOG.info(f'Initializing virtual environment [{reset=}, {register=}] ...')
+    def venv_init(self, *, reset: bool = False, register_tool: bool = False):
+        LOG.info(f'Initializing virtual environment [{reset=}, {register_tool=}] ...')
 
         self.venv.initialize(reset=reset)
 
-        if register:
-            self.venv.register_tool()
+        register_tool and self.venv.register_tool()

src/makeapp/cli.py

@@ -195,16 +195,21 @@ def change(debug, description):
     click.secho('Done', fg='green')
 
 
-@entry_point.group()
-def venv():
-    """Virtual environment related commands."""
-
-
-@venv.command()
+@entry_point.command()
 @option_debug
-def reset(debug):
-    """Remove old virtual environment and generate a new one."""
-    Project(log_level=logging.DEBUG if debug else logging.INFO).venv_init(reset=True)
+@click.option(
+    '-t', '--tool',
+    help='Register application CLI as a tool', is_flag=True
+)
+@click.option(
+    '-r', '--reset',
+    help='Remove virtual environment files before bootstrap', is_flag=True
+)
+def up(debug, tool, reset):
+    """Bootstrap environment for development."""
+    project = Project(log_level=logging.DEBUG if debug else logging.INFO)
+    project.venv_init(reset=reset, register_tool=tool)
+    click.secho('Done', fg='green')
 
 
 def main():