calkit-python 0.21.4__tar.gz → 0.21.5__tar.gz

{calkit_python-0.21.4 → calkit_python-0.21.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: calkit-python
-Version: 0.21.4
+Version: 0.21.5
 Summary: Reproducibility simplified.
 Project-URL: Homepage, https://calkit.org
 Project-URL: Issues, https://github.com/calkit/calkit/issues
@@ -74,17 +74,19 @@ which is typically a good idea,
 that should also be installed.
 For Python, we recommend
 [Miniforge](https://conda-forge.org/miniforge/).
-If you're a Windows user and decide to install Miniforge or any other
-Conda-based distribution,
-e.g., Anaconda, you'll probably want to ensure that environment is
-[activated by default in Git Bash](https://discuss.codecademy.com/t/setting-up-conda-in-git-bash/534473).
 
-After Python is installed, run
+After Python is installed, run:
 
 ```sh
 pip install calkit-python
 ```
 
+For Windows users, the
+[Calkit Assistant](https://github.com/calkit/calkit-assistant)
+app is the easiest way to get everything set up and ready to work in
+VS Code, which can then be used as the primary app for working on
+all scientific or analytical computing projects.
+
 ## Cloud integration
 
 The Calkit Cloud ([calkit.io](https://calkit.io)) serves as a project

{calkit_python-0.21.4 → calkit_python-0.21.5}/README.md

@@ -36,17 +36,19 @@ which is typically a good idea,
 that should also be installed.
 For Python, we recommend
 [Miniforge](https://conda-forge.org/miniforge/).
-If you're a Windows user and decide to install Miniforge or any other
-Conda-based distribution,
-e.g., Anaconda, you'll probably want to ensure that environment is
-[activated by default in Git Bash](https://discuss.codecademy.com/t/setting-up-conda-in-git-bash/534473).
 
-After Python is installed, run
+After Python is installed, run:
 
 ```sh
 pip install calkit-python
 ```
 
+For Windows users, the
+[Calkit Assistant](https://github.com/calkit/calkit-assistant)
+app is the easiest way to get everything set up and ready to work in
+VS Code, which can then be used as the primary app for working on
+all scientific or analytical computing projects.
+
 ## Cloud integration
 
 The Calkit Cloud ([calkit.io](https://calkit.io)) serves as a project

{calkit_python-0.21.4 → calkit_python-0.21.5}/calkit/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.21.4"
+__version__ = "0.21.5"
 
 from .core import *
 from . import git

{calkit_python-0.21.4 → calkit_python-0.21.5}/calkit/cli/new.py

@@ -104,15 +104,48 @@ def new_project(
     abs_path = os.path.abspath(path)
     if template and os.path.exists(abs_path):
         raise_error("Must specify a new directory if using --template")
-    if cloud and os.path.isdir(os.path.join(abs_path, ".git")):
-        raise_error("Must not already be a Git repo to use --cloud")
+    try:
+        repo = git.Repo(abs_path)
+    except InvalidGitRepositoryError:
+        repo = None
+    if repo is not None and git_repo_url is None:
+        try:
+            git_repo_url = repo.remotes.origin.url
+            # Convert to HTTPS if it's SSH
+            if git_repo_url.startswith("git@"):
+                git_repo_url = git_repo_url.replace(
+                    "git@github.com:", "https://github.com/"
+                )
+            git_repo_url = git_repo_url.removesuffix(".git")
+        except Exception as e:
+            git_repo_url = None
+            raise_error(
+                f"Could not detect Git repo URL from existing repo: {e}"
+            )
+        # If this isn't a DVC repo, run `dvc init`
+        if not os.path.isfile(os.path.join(abs_path, ".dvc", "config")):
+            typer.echo("Initializing DVC repository")
+            try:
+                subprocess.run(
+                    ["dvc", "init", "-q"],
+                    cwd=abs_path,
+                    capture_output=True,
+                    check=True,
+                    text=True,
+                )
+            except subprocess.CalledProcessError as e:
+                raise_error(f"Failed to initialize DVC repository: {e.stderr}")
+            # Commit the DVC init changes
+            if not no_commit:
+                repo.git.add(".dvc")
+                repo.git.commit(["-m", "Initialize DVC"])
     ck_info_fpath = os.path.join(abs_path, "calkit.yaml")
     if os.path.isfile(ck_info_fpath) and not overwrite:
         raise_error(
             "Destination is already a Calkit project; "
             "use --overwrite to continue"
         )
-    if os.path.isdir(abs_path) and os.listdir(abs_path):
+    if os.path.isdir(abs_path) and os.listdir(abs_path) and repo is None:
         warn(f"{abs_path} is not empty")
     if name is None:
         name = calkit.to_kebab_case(os.path.basename(abs_path))
@@ -127,6 +160,7 @@ def new_project(
         # Cloud should allow None, which will allow us to post just the name
         # NOTE: This will fail if the user hasn't logged into the Calkit Cloud
         # in 6 months, since their GitHub refresh token stored is expired
+        typer.echo("Creating project in Calkit Cloud")
         try:
             resp = calkit.cloud.post(
                 "/projects",
@@ -144,8 +178,8 @@ def new_project(
         # Now clone here
         if not os.path.isdir(abs_path):
             subprocess.run(["git", "clone", resp["git_repo_url"], abs_path])
-        else:
-            typer.echo("Fetching from newly create Git repo")
+        elif repo is None:
+            typer.echo("Fetching from newly created Git repo")
             repo = git.Repo.init(abs_path, initial_branch="main")
             repo.git.remote(["add", "origin", resp["git_repo_url"]])
             repo.git.fetch()
@@ -156,6 +190,25 @@ def new_project(
                 repo.git.checkout(checkout_cmd)
             except GitCommandError as e:
                 raise_error(f"Failed to check out main branch: {e}")
+        else:
+            # Create a calkit.yaml file if one does not exist
+            calkit_fpath = os.path.join(abs_path, "calkit.yaml")
+            if not os.path.isfile(calkit_fpath):
+                typer.echo("Creating calkit.yaml file")
+                with open(calkit_fpath, "w") as f:
+                    ryaml.dump(
+                        dict(
+                            owner=resp["owner_account_name"],
+                            name=resp["name"],
+                            title=resp["title"],
+                            description=resp["description"],
+                            git_repo_url=resp["git_repo_url"],
+                        ),
+                        f,
+                    )
+                repo.git.add("calkit.yaml")
+                if not no_commit:
+                    repo.git.commit(["-m", "Create calkit.yaml"])
         try:
             calkit.dvc.set_remote_auth(wdir=abs_path)
         except Exception:
@@ -287,8 +340,11 @@ def new_project(
     # Setup Calkit Cloud DVC remote
     if repo.remotes:
         typer.echo("Setting up Calkit Cloud DVC remote")
-        calkit.dvc.configure_remote(wdir=abs_path)
-        calkit.dvc.set_remote_auth(wdir=abs_path)
+        try:
+            calkit.dvc.configure_remote(wdir=abs_path)
+            calkit.dvc.set_remote_auth(wdir=abs_path)
+        except Exception as e:
+            warn(f"Failed to set up Calkit Cloud DVC remote: {e}")
     if repo.git.diff("--staged") and not no_commit:
         repo.git.commit(["-m", "Initialize Calkit project"])
     typer.echo(success_message)

{calkit_python-0.21.4 → calkit_python-0.21.5}/calkit/tests/cli/test_new.py

@@ -216,6 +216,40 @@ def test_new_uv_venv(tmp_dir):
 
 
 def test_new_project(tmp_dir):
+    subprocess.check_call(
+        ["calkit", "new", "project", ".", "--title", "My new project"]
+    )
+    repo = git.Repo()
+    assert repo.git.ls_files("calkit.yaml")
+    assert repo.git.ls_files("README.md")
+    assert repo.git.ls_files(".devcontainer")
+    ck_info = calkit.load_calkit_info()
+    assert ck_info["title"] == "My new project"
+
+
+def test_new_project_existing_repo(tmp_dir):
+    subprocess.check_call(["git", "init"])
+    subprocess.check_call(
+        [
+            "git",
+            "remote",
+            "add",
+            "origin",
+            "https://github.com/someone/somerepo.git",
+        ]
+    )
+    subprocess.check_call(
+        ["calkit", "new", "project", ".", "--title", "My new project"]
+    )
+    repo = git.Repo()
+    assert repo.git.ls_files("calkit.yaml")
+    assert repo.git.ls_files("README.md")
+    assert repo.git.ls_files(".devcontainer")
+    ck_info = calkit.load_calkit_info()
+    assert ck_info["title"] == "My new project"
+
+
+def test_new_project_existing_files(tmp_dir):
     subprocess.check_call(["touch", "some-existing-file.txt"])
     subprocess.check_call(
         ["calkit", "new", "project", ".", "--title", "My new project"]

calkit_python-0.21.5/docs/installation.md

@@ -0,0 +1,22 @@
+# Installation
+
+To install Calkit, [Git](https://git-scm.com) and Python must be installed.
+If you want to use [Docker](https://docker.com) containers,
+which is typically a good idea,
+that should also be installed.
+For Python, we recommend
+[Miniforge](https://conda-forge.org/miniforge/).
+
+After Python is installed, execute:
+
+```sh
+pip install calkit-python
+```
+
+For Windows users, the
+[Calkit Assistant](https://github.com/calkit/calkit-assistant)
+app is the easiest way to get everything set up and ready to work in
+VS Code, which can then be used as the primary app for working on
+all scientific or analytical computing projects.
+
+![Calkit Assistant](https://github.com/calkit/calkit-assistant/blob/main/resources/screenshot.png?raw=true)

calkit_python-0.21.4/docs/installation.md

@@ -1,18 +0,0 @@
-# Installation
-
-To install Calkit, [Git](https://git-scm.com) and Python must be installed.
-If you want to use [Docker](https://docker.com) containers,
-which is typically a good idea,
-that should also be installed.
-For Python, we recommend
-[Miniforge](https://conda-forge.org/miniforge/).
-If you're a Windows user and decide to install Miniforge or any other
-Conda-based distribution,
-e.g., Anaconda, you'll probably want to ensure that environment is
-[activated by default in Git Bash](https://discuss.codecademy.com/t/setting-up-conda-in-git-bash/534473).
-
-After Python is installed, execute:
-
-```sh
-pip install calkit-python
-```