Add "new" command

.gitignore

@@ -5,4 +5,6 @@ __pycache__
 !sample.mp4
 *.egg-info
 *.blend
-build/
+build/
+blender_driver_debug.py
+pkvid.yaml

README.md

@@ -6,50 +6,71 @@ See the docs site at [docs.pkvid.pagekey.io](https://docs.pkvid.pagekey.io/).
 
 ## Getting Started
 
-1. Build the Docker image. It will take a while. Final image will be huge, ~10-15 GB.
+1. Ensure blender is installed on your system and on your PATH as `blender`. If you can run `blender --version` in a terminal, you're good to go.
+
+2. Install `pkvid`. You must have at least Python 3.9 for this.
 
 ```bash
-docker-compose build
+pip install pkvid
 ```
 
-2. Install the helper script.
+3. Generate a new project:
 
 ```bash
-sudo ./scripts/install.sh
+pkvid new
 ```
 
-3. Run pkvid in a directory with `pkvid.yaml`.
+4. You should now see `pkvid.yaml` in the current directory. Run:
+
+```bash
+pkvid render
+```
+
+5. Check the `build/` folder for your rendered project. You may also open the Blender project file to explore/debug.
+
+
+## Building Blender with Sound in Docker (Advanced)
+
+1. Build the Docker image. It will take a while. Final image will be huge, ~10-15 GB.
 
 ```bash
-cd your-project
-pkvid
+docker-compose build
 ```
 
 ## Developer Instructions
 
-Run the test suite:
+1. Install poetry.
 
 ```bash
-docker-compose run dev pytest
+pip install poetry
 ```
 
-Run integration test:
+2. Install dependencies.
 
 ```bash
-docker-compose run dev pkvid test/integration/pkvid.yaml
+poetry install --with dev --with filters
 ```
 
-Get a shell:
+3. Run the test suite:
 
 ```bash
-docker-compose run dev bash
+poetry run pytest
 ```
 
-## Usage without Docker (Not Recommended)
+4. Run integration test:
+
+```bash
+cd test/integration
+poetry run pkvid render
+```
+
+## Old GUides
+
+Do not follow these guides. I need to find a better place to put them, or just delete them.
 
 These are old guides - leaving them here in case they're useful at some point.
 
-### Installation Guide 
+### OLD Installation Guide 
 
 This package is not meant to be installed in a regular Python environment. Instead, you must install it from the Python that is embedded in Blender.
 
@@ -82,15 +103,15 @@ $BLENDER_PYTHON -m pip install --upgrade pip
 $BLENDER_PYTHON -m pip install pkvid
 ```
 
-### Development Install
+### OLD Development Install
 
 Same process, but for the last step, run this instead:
 
 ```bash
 $BLENDER_PYTHON -m pip install -e .
 ```
 
-### Example Run Command
+### OLD Example Run Command
 
 ```bash
 blender -b -P pkvid/__main__.py test/sample_config.json 
@@ -104,3 +125,4 @@ Building Blender from scratch:
 - [Blender Community YouTube video](https://www.youtube.com/watch?v=WBAnd-r_x64)
 - [Building on Ubuntu](https://wiki.blender.org/wiki/Building_Blender/Linux/Ubuntu)
 - [Building bpy module](https://wiki.blender.org/wiki/Building_Blender/Other/BlenderAsPyModule)
+

docs/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [2.0.1](https://gitlab.com/pagekey/apps/pkvid/pkvid/compare/2.0.0...2.0.1) (2024-03-22)
+
+# [2.0.0](https://gitlab.com/pagekey/apps/pkvid/pkvid/compare/1.0.0...2.0.0) (2024-03-10)
+
 # 1.0.0 (2024-02-09)
 
 

docs/site.yaml

@@ -3,3 +3,4 @@ copyright: '2024, PageKey'
 author: 'Steve'
 release: 'latest'
 package: '../../../pkvid'
+template: sphinx

pkvid/cli.py

@@ -1,28 +1,54 @@
 import argparse
 import os
+import shutil
 import sys
 
-import pkvid.blender as blender
-from pkvid.config import get_config
-from pkvid.project import Project
+from pkvid.project import ProjectConfig, Text, Video
 
 
 def main(cli_args=sys.argv[1:]):
     parser = argparse.ArgumentParser(description='Video editing toolkit')
-    parser.add_argument('filename', help='Name of config file')
+    subparsers = parser.add_subparsers(dest='command')
+
+    new_parser = subparsers.add_parser('new', help='Create a new project')
+
+    render_parser = subparsers.add_parser('render', help='Render a project')
+    render_parser.add_argument('-f', '--filename', help='Name of config file', default='pkvid.yaml')
+
     args = parser.parse_args(cli_args)
 
-    if args.filename:
-        project_config = get_config(args.filename)
-        project = Project(project_config)
-        print(f"Successfully parsed project: {project.config.name}")
-        dirname = os.path.dirname(args.filename)
-        if len(dirname) > 0:
-            # if not already in that dir, go to it
-            os.chdir(os.path.dirname(args.filename))
-        os.makedirs('render', exist_ok=True)
-        os.chdir('render')
-        project.render()
+    if args.command == 'new':
+        print("Create a new project here")
+        # Read a string for the name from the user
+        name = input("What is the name of the project? ")
+        config = ProjectConfig(name=name, clips=[])
+        while input("Add a clip? (y/n) ") == 'y':
+            print("Choose a clip type:")
+            print("v) Video")
+            print("t) Text")
+            clip_type = input("> ")
+            if clip_type == 'v':
+                path = input("Enter path to video: ")
+                config.clips.append(Video(path=path))
+            elif clip_type == 't':
+                body = input("Enter text: ")
+                config.clips.append(Text(body=body))
+            else:
+                print("Invalid clip type")
+        config.save('pkvid.yaml')
+    elif args.command == 'render':
+        print("render", args.filename)
+        config = ProjectConfig.load(args.filename)
+        print(f"Successfully parsed project: {config.name}")
+        # Set up build directory
+        shutil.rmtree('build', ignore_errors=True)
+        orig_dir = os.getcwd()
+        os.makedirs('build', exist_ok=True)
+        os.chdir('build')
+        # Perform render of project
+        config.render()
+        # Restore original directory
+        os.chdir(orig_dir)
     else:
         parser.print_usage()