sungen 2024.9.7.2

TODO

It appears that sungen is a utility package derived from dspygen, but it does not have a direct command for generating modules like dspygen module. Instead, it offers several other commands such as api, cmd, deploy, and others for managing different tasks.

Updated README for sungen

Here's an updated README for sungen based on the provided directory structure and the available commands:

---

sungen

sungen is a utility package extracted from dspygen that provides a suite of tools and utilities for AI development, project management, and workflow automation. sungen offers a set of command-line tools to streamline the development process, automate repetitive tasks, and enhance productivity in managing AI projects.

Features

• Command-Line Interface (CLI): Simplifies interaction with various tools via a user-friendly CLI.
• Workflow Automation: Supports BPMN (Business Process Model and Notation) and YAML workflows.
• Code Generation and Management: Provides tools to generate, optimize, and deploy code and manage projects.
• Project Initialization: Offers commands to quickly initialize and configure new projects.
• Integrated Development Environment (IDE) Support: Seamlessly integrates with Docker, VS Code, and other tools for development.

Installing

To install this package, run:

pip install sungen

Using

To view the CLI help information, run:

sungen --help

Available Commands

sungen offers several commands, each serving a specific purpose:

• init: Initialize a new sungen project.
• cmd: Generate new subcommands or add to existing ones.
• api: Handle API-related tasks.
• deploy: Deploy projects or services.
• fgn: Handle foreign tasks or integrations.
• inhabitant: Manage inhabitants or entities within the system.
• issue: Manage issues or tasks.
• marketplace: Interact with the marketplace for plugins or extensions.
• optimize: Optimize code, workflows, or configurations.
• pln: Plan and manage project tasks.
• pr: Manage pull requests.
• project: Manage project settings or configurations.
• proposal: Manage project proposals or requests.
• repo: Handle repository tasks.
• support: Provide support-related commands.
• ticket: Manage tickets or support requests.

Contributing

We welcome contributions to sungen! To set up your development environment, follow these steps:

Prerequisites

1. Set up Git to use SSH

   • Generate an SSH key and add the SSH key to your GitHub account.
   • Configure SSH to automatically load your SSH keys:

   cat << EOF >> ~/.ssh/config
   
   Host *
     AddKeysToAgent yes
     IgnoreUnknown UseKeychain
     UseKeychain yes
     ForwardAgent yes
   EOF
   

2. Install Docker

   • Install Docker Desktop.
   • Linux only: Export your user ID and group ID:

   cat << EOF >> ~/.bashrc
   
   export UID=$(id --user)
   export GID=$(id --group)
   EOF
   

3. Install VS Code or PyCharm

   • Install VS Code and VS Code's Dev Containers extension, or install PyCharm.

Development environments

You can develop using the following environments:

1. GitHub Codespaces: Start a Dev Container with GitHub Codespaces.
2. Dev Container (with container volume): Clone this repository into a container volume using VS Code.
3. VS Code: Open the repository with VS Code and use the Dev Containers: Reopen in Container command.
4. PyCharm: Use Docker Compose as a remote interpreter.
5. Terminal: Use Docker Compose commands to manage development environments.

Developing

• poe: Run poe within the development environment to list available tasks.
• poetry add {package}: Install runtime dependencies.
• poetry update: Upgrade all dependencies to the latest versions.

License

This project is licensed under the MIT License. See the LICENSE file for more details.