CHANGELOG updated

Author: idlesign

CHANGELOG

@@ -2,6 +2,13 @@ makeapp changelog
 =================
 
 
+Unreleased
+----------
++ Added virtual environment creation on project rollout.
++ CLI. Added  command.
+* Fixed package name availability check.
+
+
 v1.9.1 [2023-05-19]
 -------------------
 * Added '-i' shortcut for '--increment' option of 'release' command.

makeapp/appmaker.py

@@ -11,6 +11,7 @@
 from .apptemplate import TemplateFile, AppTemplate
 from .exceptions import AppMakerException
 from .helpers.vcs import VcsHelper
+from .helpers.venvs import VenvHelper
 from .rendering import Renderer
 from .utils import chdir, configure_logging, PYTHON_VERSION
 
@@ -276,9 +277,11 @@ def _hook_run(self, hook_name: str) -> Dict[AppTemplate, bool]:
 
     def rollout(
             self,
-            dest: str, *,
+            dest: str,
+            *,
             overwrite: bool = False,
             init_repository: bool = False,
+            init_venv: bool = False,
             remote_address: str = None,
             remote_push: bool = False
     ):
@@ -290,6 +293,8 @@ def rollout(
 
         :param init_repository: Whether to initialize a repository.
 
+        :param init_venv: Whether to initialize a virtual environment.
+
         :param remote_address: Remote repository address to add to DVCS.
 
         :param remote_push: Whether to push to remote.
@@ -338,12 +343,15 @@ def rollout(
         with chdir(dest):
             self._hook_run('rollout_post')
 
-        if init_repository:
-            self._vcs_init(
-                dest,
-                add_files=bool(files.keys()),
-                remote_address=remote_address,
-                remote_push=remote_push)
+            if init_venv:
+                VenvHelper(dest).initialize()
+
+            if init_repository:
+                self._vcs_init(
+                    dest,
+                    add_files=bool(files.keys()),
+                    remote_address=remote_address,
+                    remote_push=remote_push)
 
     @staticmethod
     def _comment_out(text: Optional[str]) -> Optional[str]:

makeapp/apptools.py

@@ -9,6 +9,7 @@
 from .helpers.dist import DistHelper
 from .helpers.files import FileHelper
 from .helpers.vcs import VcsHelper
+from .helpers.venvs import VenvHelper
 from .utils import chdir
 
 LOG = logging.getLogger(__name__)
@@ -337,10 +338,12 @@ def __init__(self, project_path: str = None):
         :param project_path: Application root (containing setup.py) path.
 
         """
-        self.project_path = project_path or os.getcwd()
+        project_path = project_path or os.getcwd()
+        self.project_path = project_path
         self.package: Optional[PackageData] = None
         self.changelog: Optional[ChangelogData] = None
         self.vcs = VcsHelper.get(project_path)
+        self.venv = VenvHelper(project_path)
 
         with chdir(self.project_path):
             self._gather_data()
@@ -472,3 +475,7 @@ def publish(self):
         with chdir(self.project_path):
             self.vcs.push()
             DistHelper.upload()
+
+    def venv_init(self, *, reset: bool = False):
+        LOG.info(f'Initializing virtual environment [{reset=}] ...')
+        self.venv.initialize(reset=reset)

makeapp/cli.py

@@ -106,6 +106,7 @@ def process_custom_args(args):
     click.secho(app_maker.get_settings_string(), fg='green')
 
     init_repo = True
+    init_venv = True
     remote_address = app_maker.settings['vcs_remote'] or ''
     remote_push = False
 
@@ -129,10 +130,14 @@ def process_custom_args(args):
             if remote_address:
                 remote_push = click.confirm('Do you want to commit and push files to remote?', default=False)
 
+        init_venv = click.confirm(
+            'Do you want to initialize a virtual environment in the application directory?', default=True)
+
     app_maker.rollout(
         target_path,
         overwrite=overwrite_on_conflict,
         init_repository=init_repo,
+        init_venv=init_venv,
         remote_address=remote_address,
         remote_push=remote_push,
     )
@@ -185,6 +190,17 @@ def change(description):
     click.secho('Done', fg='green')
 
 
+@entry_point.group()
+def venv():
+    """Virtual environment related commands."""
+
+
+@venv.command()
+def reset():
+    """Remove old virtual environment and generate a new one."""
+    Project().venv_init(reset=True)
+
+
 def main():
     try:
         entry_point(obj={})

makeapp/helpers/venvs.py

@@ -0,0 +1,24 @@
+import logging
+from pathlib import Path
+from shutil import rmtree
+
+from ..utils import run_command
+
+LOG = logging.getLogger(__name__)
+
+
+class VenvHelper:
+    """Encapsulates virtual environment related functions."""
+
+    def __init__(self, project_path: str):
+        self.venv_path = Path(project_path) / 'venv'
+
+    def initialize(self, *, reset: bool = False):
+        path = self.venv_path
+
+        if reset:
+            LOG.debug(f'Remove {path} ...')
+            rmtree(f'{path}', ignore_errors=True)
+
+        run_command('python3 -m venv venv')
+        run_command(f'{path}/bin/python -m pip install -e .')

tests/conftest.py

@@ -4,7 +4,7 @@
 @pytest.fixture
 def get_appmaker():
 
-    def get_appmaker_(app_name='dummy', templates=None, *, rollout=True):
+    def get_appmaker_(app_name='dummy', templates=None, *, rollout=True, init_venv=False):
 
         from makeapp.appmaker import AppMaker
 
@@ -26,6 +26,7 @@ def get_appmaker_(app_name='dummy', templates=None, *, rollout=True):
                 '.',
                 overwrite=True,
                 init_repository=True,
+                init_venv=init_venv,
                 remote_address='[email protected]',
                 remote_push=False,
             )

tests/test_appmaker.py

@@ -6,7 +6,7 @@ def test_default(tmpdir, get_appmaker, assert_content):
 
     with tmpdir.as_cwd():
 
-        app_maker = get_appmaker()
+        app_maker = get_appmaker(init_venv=True)
 
         settings_str = app_maker.get_settings_string()
 
@@ -41,6 +41,10 @@ def test_default(tmpdir, get_appmaker, assert_content):
             'from dummy import VERSION_STR',
         ])
 
+        assert_content(tmpdir / 'venv', 'pyvenv.cfg', [
+            'executable ='
+        ])
+
 
 def test_tpl_userdefined(tmpdir, get_appmaker, assert_content):
 

tests/test_apptools.py

@@ -49,3 +49,25 @@ def dummy_communicate(self, *args, **kwargs):
             'python3 setup.py clean --all sdist bdist_wheel',
             'twine upload dist/*'
         ]
+
+
+def test_venv(tmpdir, get_appmaker, assert_content):
+
+    with tmpdir.as_cwd():
+
+        get_appmaker()
+
+        vcs = VcsHelper.get()
+        vcs.commit('initial')
+
+        project = Project()
+
+        project.venv_init()
+        assert_content(tmpdir / 'venv', 'pyvenv.cfg', [
+            'executable ='
+        ])
+
+        project.venv_init(reset=True)
+        assert_content(tmpdir / 'venv', 'pyvenv.cfg', [
+            'executable ='
+        ])