feat: Added python tools

Author: kevinwang5658

src/resources/python/pip-sync/pip-sync.ts

@@ -1,4 +1,4 @@
-import { CreatePlan, DestroyPlan, getPty, RefreshContext, Resource, ResourceSettings } from '@codifycli/plugin-core';
+import { CreatePlan, DestroyPlan, ExampleConfig, getPty, RefreshContext, Resource, ResourceSettings } from '@codifycli/plugin-core';
 import { OS, ResourceConfig } from '@codifycli/schemas';
 
 import schema from './pip-sync-schema.json'
@@ -10,10 +10,30 @@ export interface PipSyncConfig extends ResourceConfig {
   cwd?: string;
 }
 
+const defaultConfig: Partial<PipSyncConfig> = {
+  requirementFiles: ['requirements.txt'],
+  cwd: '<Replace me here!>'
+}
+
+const exampleWithVirtualenv: ExampleConfig = {
+  title: 'Sync packages into a virtualenv',
+  description: 'Install pip-tools and sync dependencies from a compiled requirements file into a dedicated virtualenv.',
+  configs: [{
+    type: 'pip-sync',
+    requirementFiles: ['requirements.txt'],
+    virtualEnv: '.venv',
+    cwd: '<Replace me here!>',
+  }]
+}
+
 export class PipSync extends Resource<PipSyncConfig> {
   getSettings(): ResourceSettings<PipSyncConfig> {
     return {
       id: 'pip-sync',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleWithVirtualenv,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema,
       parameterSettings: {

src/resources/python/pip/pip.ts

@@ -1,6 +1,7 @@
 import {
   CreatePlan,
   DestroyPlan,
+  ExampleConfig,
   ModifyPlan,
   ParameterChange,
   Resource,
@@ -23,11 +24,55 @@ export interface PipResourceConfig extends ResourceConfig {
   virtualEnv?: string;
 }
 
+const defaultConfig: Partial<PipResourceConfig> = {
+  install: [],
+  installFiles: [],
+}
+
+const exampleBasic: ExampleConfig = {
+  title: 'Install packages with pip',
+  description: 'Install a set of Python packages globally using pip.',
+  configs: [{
+    type: 'pip',
+    install: ['requests', 'boto3', 'click'],
+  }]
+}
+
+const exampleWithPyenvAndVirtualenv: ExampleConfig = {
+  title: 'Full Python setup with pyenv, virtualenv, and pip',
+  description: 'Install Python via pyenv, create a project virtualenv, then install packages into it with pip.',
+  configs: [
+    {
+      type: 'pyenv',
+      pythonVersions: ['3.12'],
+      global: '3.12',
+    },
+    {
+      type: 'virtualenv-project',
+      dest: '.venv',
+      cwd: '<Replace me here!>',
+      automaticallyInstallRequirementsTxt: false,
+      dependsOn: ['pyenv'],
+    },
+    {
+      type: 'pip',
+      install: ['requests', 'boto3', 'click'],
+      virtualEnv: '.venv',
+      dependsOn: ['virtualenv-project'],
+    },
+  ]
+}
+
 export class Pip extends Resource<PipResourceConfig> {
 
   getSettings(): ResourceSettings<PipResourceConfig> {
     return {
       id: 'pip',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleBasic,
+        example2: exampleWithPyenvAndVirtualenv,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema,
       parameterSettings: {

src/resources/python/pyenv/pyenv.ts

@@ -1,4 +1,4 @@
-import { getPty, Resource, ResourceSettings, SpawnStatus, Utils } from '@codifycli/plugin-core';
+import { ExampleConfig, getPty, Resource, ResourceSettings, SpawnStatus, Utils } from '@codifycli/plugin-core';
 import { OS, ResourceConfig } from '@codifycli/schemas';
 import * as fs from 'node:fs';
 import os from 'node:os';
@@ -15,10 +15,39 @@ export interface PyenvConfig extends ResourceConfig {
   // TODO: Add option here to use homebrew to install instead. Default to true. Maybe add option to set default values to resource config.
 }
 
+const defaultConfig: Partial<PyenvConfig> = {
+  pythonVersions: [],
+}
+
+const exampleBasic: ExampleConfig = {
+  title: 'Install pyenv with a Python version',
+  description: 'Install pyenv and pin a Python version as the global default.',
+  configs: [{
+    type: 'pyenv',
+    pythonVersions: ['3.12'],
+    global: '3.12',
+  }]
+}
+
+const exampleMultiVersion: ExampleConfig = {
+  title: 'Install pyenv with multiple Python versions',
+  description: 'Install pyenv with several Python versions available, pinning one as the global default.',
+  configs: [{
+    type: 'pyenv',
+    pythonVersions: ['3.12', '3.11', '3.10'],
+    global: '3.12',
+  }]
+}
+
 export class PyenvResource extends Resource<PyenvConfig> {
   getSettings(): ResourceSettings<PyenvConfig> {
     return {
       id: 'pyenv',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleBasic,
+        example2: exampleMultiVersion,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema: Schema,
       parameterSettings: {

src/resources/python/uv/uv.ts

@@ -1,4 +1,4 @@
-import { FileUtils, getPty, Resource, ResourceSettings, SpawnStatus, z } from '@codifycli/plugin-core';
+import { ExampleConfig, FileUtils, getPty, Resource, ResourceSettings, SpawnStatus, z } from '@codifycli/plugin-core';
 import { OS } from '@codifycli/schemas';
 import fs from 'node:fs/promises';
 import os from 'node:os';
@@ -26,10 +26,39 @@ const schema = z.object({
 
 export type UvConfig = z.infer<typeof schema>;
 
+const defaultConfig: Partial<UvConfig> = {
+  pythonVersions: [],
+  tools: [],
+}
+
+const examplePython: ExampleConfig = {
+  title: 'Install uv with Python versions',
+  description: 'Install uv and pin one or more Python versions for use across projects.',
+  configs: [{
+    type: 'uv',
+    pythonVersions: ['3.12', '3.11'],
+  }]
+}
+
+const exampleWithTools: ExampleConfig = {
+  title: 'Install uv with Python and global tools',
+  description: 'Install uv, pin a Python version, and install commonly used global CLI tools like ruff and black.',
+  configs: [{
+    type: 'uv',
+    pythonVersions: ['3.12'],
+    tools: ['ruff', 'black', 'httpie'],
+  }]
+}
+
 export class UvResource extends Resource<UvConfig> {
   getSettings(): ResourceSettings<UvConfig> {
     return {
       id: 'uv',
+      defaultConfig,
+      exampleConfigs: {
+        example1: examplePython,
+        example2: exampleWithTools,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema,
       parameterSettings: {

src/resources/python/venv/venv-project.ts

@@ -1,6 +1,7 @@
 import {
   CreatePlan,
   DestroyPlan,
+  ExampleConfig,
   Resource,
   ResourceSettings,
   getPty
@@ -26,11 +27,54 @@ export interface VenvProjectConfig extends ResourceConfig {
   automaticallyInstallRequirementsTxt?: boolean;
 }
 
+const defaultConfig: Partial<VenvProjectConfig> = {
+  envDir: '.venv',
+  upgradeDeps: true,
+  automaticallyInstallRequirementsTxt: true,
+}
+
+const exampleBasic: ExampleConfig = {
+  title: 'Create a virtual environment',
+  description: 'Create a Python virtual environment in the project directory and automatically install dependencies from requirements.txt.',
+  configs: [{
+    type: 'venv-project',
+    envDir: '.venv',
+    cwd: '~/projects/my-project',
+    automaticallyInstallRequirementsTxt: true,
+    upgradeDeps: true,
+  }]
+}
+
+const exampleWithRepo: ExampleConfig = {
+  title: 'Clone a repo and set up a virtual environment',
+  description: 'Clone a Python project and immediately create a virtual environment with its dependencies installed.',
+  configs: [
+    {
+      type: 'git-repository',
+      repository: 'git@github.com:org/my-python-project.git',
+      directory: '~/projects/my-python-project',
+    },
+    {
+      type: 'venv-project',
+      envDir: '.venv',
+      cwd: '~/projects/my-python-project',
+      automaticallyInstallRequirementsTxt: true,
+      upgradeDeps: true,
+      dependsOn: ['git-repository'],
+    },
+  ]
+}
+
 export class VenvProject extends Resource<VenvProjectConfig> {
 
   getSettings(): ResourceSettings<VenvProjectConfig> {
     return {
       id: 'venv-project',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleBasic,
+        example2: exampleWithRepo,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema,
       parameterSettings: {

src/resources/python/virtualenv/virtualenv-project.ts

@@ -1,5 +1,5 @@
 import {
-  CreatePlan, DestroyPlan, ModifyPlan, ParameterChange, RefreshContext, Resource,
+  CreatePlan, DestroyPlan, ExampleConfig, ModifyPlan, ParameterChange, RefreshContext, Resource,
   ResourceSettings,
   getPty
 } from '@codifycli/plugin-core';
@@ -20,12 +20,50 @@ export interface VirtualenvProjectConfig extends ResourceConfig {
   automaticallyInstallRequirementsTxt?: boolean;
 }
 
+const defaultConfig: Partial<VirtualenvProjectConfig> = {
+  dest: '.venv',
+  automaticallyInstallRequirementsTxt: true,
+}
+
+const exampleBasic: ExampleConfig = {
+  title: 'Create a virtualenv environment for a project',
+  description: 'Create an isolated Python environment in a project directory and install dependencies from requirements.txt.',
+  configs: [{
+    type: 'virtualenv-project',
+    dest: '.venv',
+    cwd: '~/projects/my-python-project',
+    automaticallyInstallRequirementsTxt: true,
+  }]
+}
+
+const exampleWithVirtualenv: ExampleConfig = {
+  title: 'Install virtualenv and set up a project environment',
+  description: 'Install virtualenv and create an isolated environment for a Python project, automatically installing dependencies from requirements.txt.',
+  configs: [
+    {
+      type: 'virtualenv',
+    },
+    {
+      type: 'virtualenv-project',
+      dest: '.venv',
+      cwd: '~/projects/my-python-project',
+      automaticallyInstallRequirementsTxt: true,
+      dependsOn: ['virtualenv'],
+    },
+  ]
+}
+
 // TODO: Remove path.resolve from cwd.
 export class VirtualenvProject extends Resource<VirtualenvProjectConfig> {
 
   getSettings(): ResourceSettings<VirtualenvProjectConfig> {
     return {
       id: 'virtualenv-project',
+      defaultConfig,
+      exampleConfigs: {
+        example1: exampleBasic,
+        example2: exampleWithVirtualenv,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema,
       parameterSettings: {

src/resources/python/virtualenv/virtualenv.ts

@@ -1,15 +1,35 @@
-import { CreatePlan, DestroyPlan, getPty, Resource, ResourceSettings, Utils } from '@codifycli/plugin-core';
+import { CreatePlan, DestroyPlan, ExampleConfig, getPty, Resource, ResourceSettings, Utils } from '@codifycli/plugin-core';
 import { OS, ResourceConfig } from '@codifycli/schemas';
 
 import schema from './virtualenv-schema.json';
 
 export interface VirtualenvConfig extends ResourceConfig {}
 
+const exampleWithProject: ExampleConfig = {
+  title: 'Install virtualenv and set up a project environment',
+  description: 'Install virtualenv and create an isolated environment for a Python project, automatically installing dependencies from requirements.txt.',
+  configs: [
+    {
+      type: 'virtualenv',
+    },
+    {
+      type: 'virtualenv-project',
+      dest: '.venv',
+      cwd: '~/projects/my-python-project',
+      automaticallyInstallRequirementsTxt: true,
+      dependsOn: ['virtualenv'],
+    },
+  ]
+}
+
 export class Virtualenv extends Resource<VirtualenvConfig> {
 
   getSettings(): ResourceSettings<VirtualenvConfig> {
     return {
       id: 'virtualenv',
+      exampleConfigs: {
+        example1: exampleWithProject,
+      },
       operatingSystems: [OS.Darwin, OS.Linux],
       schema,
       dependencies: ['homebrew'],