TODO
Project description
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 newsungen
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
-
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
-
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
-
Install VS Code or PyCharm
Development environments
You can develop using the following environments:
- GitHub Codespaces: Start a Dev Container with GitHub Codespaces.
- Dev Container (with container volume): Clone this repository into a container volume using VS Code.
- VS Code: Open the repository with VS Code and use the Dev Containers: Reopen in Container command.
- PyCharm: Use Docker Compose as a remote interpreter.
- Terminal: Use Docker Compose commands to manage development environments.
Developing
poe
: Runpoe
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sungen-2024.9.7.3.tar.gz
.
File metadata
- Download URL: sungen-2024.9.7.3.tar.gz
- Upload date:
- Size: 68.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.5 Darwin/23.5.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec5899a34f4cb2118e9bb77e0a7af71e38d2f367977061cd2fd44732e37a95f8 |
|
MD5 | e2d7c2d7215602918af08a4e6580680c |
|
BLAKE2b-256 | e632ba3bd3792791553cbecbc74eb9fdcad3fe16b0c4ffff8e4f19ebae00cad0 |
File details
Details for the file sungen-2024.9.7.3-py3-none-any.whl
.
File metadata
- Download URL: sungen-2024.9.7.3-py3-none-any.whl
- Upload date:
- Size: 91.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.5 Darwin/23.5.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a430b45be68db82332c6906532adacaa1ed6014a913f7c151cac5a277aa9ae4 |
|
MD5 | 1feaa78b8b4f101329b767357ae45f0c |
|
BLAKE2b-256 | 072433de4342994381e80b8307d98d251e45490978ff9458799ef03f3754e3d0 |