Merge pull request #119 from finch-tensor/wma/develop-script

Wma/develop script

Author: willow-ahrens

README.md

@@ -26,6 +26,18 @@ poetry install --with test
 ```
 to install the current project and dev dependencies.
 
+### Working with a local copy of Finch.jl
+The `develop.py ` script can be used to set up a local copy of Finch.jl for development.
+
+```
+Usage:
+    develop.py [--restore] [--path <path>]
+
+Options:
+    --restore   Restore the original juliapkg.json file.
+    --path      Path to the local copy of Finch.jl [default: ../Finch.jl].
+```
+
 ### Publishing
 
 The "Publish" GitHub Action is a manual workflow for publishing Python packages to PyPI using Poetry. It handles the version management based on the `pyproject.toml` file and automates tagging and creating GitHub releases.

develop.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env poetry run python
+import shutil
+import juliapkg
+import argparse
+import os
+
+
+script_dir = os.path.dirname(os.path.abspath(__file__))
+source_file = os.path.join(script_dir, 'src/finch/juliapkg.json')
+backup_file = os.path.join(script_dir, 'src/finch/juliapkg.json.orig')
+
+# Parse command-line arguments
+usage = """
+Usage:
+    develop.py [--restore] [--path <path>]
+
+Options:
+    --restore   Restore the original juliapkg.json file.
+    --path      Path to the local copy of Finch.jl [default: ../Finch.jl].
+"""
+parser = argparse.ArgumentParser(description="Development script for Finch. This script allows you to specify the location of a local copy of Finch.jl.", usage=usage)
+parser.add_argument("--path", default=os.path.join(script_dir, "../Finch.jl"), help="Path to the Finch.jl package.")
+parser.add_argument("--restore", action="store_true", help="Restore the original juliapkg.json file.")
+args = parser.parse_args()
+
+# Handle the --restore flag
+if args.restore:
+    try:
+        shutil.copy(backup_file, source_file)
+        print("Restored src/finch/juliapkg.json from backup.")
+    except FileNotFoundError:
+        print("Error: Backup file src/finch/juliapkg.json.orig does not exist.")
+    except Exception as e:
+        print(f"An error occurred: {e}")
+    exit()
+
+# Set the Finch path
+finch_path = os.path.abspath(args.path)
+
+# Define source and destination file paths and copy the file
+try:
+    if not os.path.exists(backup_file):
+        shutil.copy(source_file, backup_file)
+except Exception as e:
+    print(f"An error occurred: {e}")
+
+#Checkout Finch for development
+
+juliapkg.rm("Finch", target='src/finch/juliapkg.json')
+juliapkg.add("Finch", "9177782c-1635-4eb9-9bfb-d9dfa25e6bce", dev=True, path=finch_path, target='src/finch/juliapkg.json')

src/finch/julia.py

@@ -1,6 +1,7 @@
 import juliapkg
 #To change the version of Finch used, see the documentation for pyjuliapkg here: https://github.com/JuliaPy/pyjuliapkg
 #Use pyjuliapkg to modify the `juliapkg.json` file in the root of this repo.
+#You can also run `develop.py` to quickly use a local copy of Finch.jl.
 #An example development json is found in `juliapkg_dev.json`
 import juliacall as jc  # noqa