matrx-dream-service 1.0.3

Matrx service

AI Matrx Service

1. Matrx Microservice Generator

Overview

The MicroserviceGenerator class is a tool for generating microservice projects based on a configuration file or dictionary.

Key features:

• Config-driven generation (merge user config with defaults).
• Supports local file output or direct push to a GitHub repo in an organization.
• Validates config for restricted task_names, service_names, field_names for socket schema

Setup

1. Install dependencies via uv venv
2. Activate the generated environment
3. Sync dependencies using uv sync
4. Import the class: from matrx_dream_service.matrx_microservice import MicroserviceGenerator.
5. Setup a environment with variables with actual values:

GITHUB_PAT=your-personal-access-token # Personal Access token of org owner or a memeber with priviliges to manage repositories.
GITHUB_ORG_NAME="org-name"
BASE_DIR=current-working-dir
GITHUB_BOT_ACCOUNT_USERNAME="username" # initial contributions to the repo will show up with this username
GITHUB_BOT_EMAIL="[e-mail]"

Parameters

• config_path (str, optional): Path to JSON config file.
• output_dir (str, optional): Directory for generated files.
• create_github_repo (bool, default=False): If True, creates and pushes to a GitHub repo.
• github_project_name (str, optional): Base name for GitHub repo (auto-appends suffix if needed).
• github_access (list[dict], optional): List of collaborator access objects, e.g., [ {"username": "user1", "permission": {"admin": True}}, {"username": "user2", "permission": {"push": True}} ]. Permissions map to GitHub roles (admin, maintain, triage, push, pull).
• config (dict, optional): Direct config dict (bypasses file load).
• github_project_description (str, optional): Description for GitHub repo.
• debug (bool, default=False): Enable verbose logging.

Return Value

generate_microservice() returns a dict with GitHub details if create_github_repo=True (e.g., {'repo_name': '...', 'repo_url': '...', 'repo_id': ..., 'dev_branch': 'dev', 'main_branch': 'main'}), else None.

Usage Examples

1. Basic Local Generation (From Config File)

Generate microservice files locally without GitHub.

from dotenv import load_dotenv
load_dotenv()

from matrx_dream_service.matrx_microservice import MicroserviceGenerator

generator = MicroserviceGenerator(
    config_path="path/to/config.json",
    output_dir="path/to/output",
    debug=True
)
generator.generate_microservice()

2. Local Generation with Direct Config Dict

Use a config dict instead of a file.

from dotenv import load_dotenv
load_dotenv()

from matrx_dream_service.matrx_microservice import MicroserviceGenerator

sample_config = {
    "settings": {"app_name": "MyApp"},
    # ... other config keys ...
}

generator = MicroserviceGenerator(
    config=sample_config,
    output_dir="path/to/output",
    debug=False
)
generator.generate_microservice()

3. Generation with GitHub Repo Creation (No Collaborators)

Create and push to a GitHub repo.

from dotenv import load_dotenv
load_dotenv()

from matrx_dream_service.matrx_microservice import MicroserviceGenerator

resp = MicroserviceGenerator(
    config_path="path/to/config.json",
    output_dir="path/to/output",
    create_github_repo=True,
    github_project_name="my-project",
    github_project_description="My microservice project"
).generate_microservice()

print(resp)  # {'repo_name': '...', 'repo_url': '...', ...}

4. Generation with GitHub and Collaborator Access

Add collaborators with specific permissions during repo creation.

from dotenv import load_dotenv
load_dotenv()

from matrx_dream_service.matrx_microservice import MicroserviceGenerator

sample_access = [
    {"username": "jatin-dot-py", "permission": {"admin": True}},
    {"username": "matrx-bot", "permission": {"push": True}}
]

resp = MicroserviceGenerator(
    config_path="path/to/config.json",
    output_dir="path/to/output",
    create_github_repo=True,
    github_project_name="my-scraper",
    github_access=sample_access,
    github_project_description="Scraper microservice"
).generate_microservice()

print(resp)  # Includes repo details

5. Debug Mode with All Options

Full usage with debug enabled.

from dotenv import load_dotenv
load_dotenv()

from matrx_dream_service.matrx_microservice import MicroserviceGenerator

sample_access = [
    {"username": "testuser", "permission": {"maintain": True}},
    {"username": "botuser", "permission": {"triage": True, "push": True}}
]

sample_config = {
    # ... config dict ...
}

resp = MicroserviceGenerator(
    config=sample_config,
    output_dir="path/to/output",
    create_github_repo=True,
    github_project_name="advanced-project",
    github_access=sample_access,
    github_project_description="Advanced example",
    debug=True
).generate_microservice()

print(resp)

6. CLI Usage

Create a new microservice project from a config file.

Usage:

matrx create-microservice --config <path> --output_dir <dir> [options]

Required Arguments:

• --config: Path to the JSON config file (e.g., --config path/to/config.json).
• --output_dir: Output directory for generated files (e.g., --output_dir path/to/output).

Optional Arguments:

• --create_github_repo: Flag to create and push to a GitHub repo (e.g., --create_github_repo).
• --github_project_name: Base name for the GitHub repo (required if --create_github_repo is set; e.g., --github_project_name my-project).
• --github_project_description: Description for the GitHub repo (e.g., --github_project_description "My microservice").
• --github_access_file: Path to JSON file for collaborator access (e.g., --github_access_file path/to/access.json). Format: [{"username": "user1", "permission": {"admin": true}}, ...].
• --debug: Enable debug mode for this command.

Examples:

1. Basic local generation:

   matrx create-microservice --config path/to/config.json --output_dir path/to/output
   

2. With GitHub repo creation:

   matrx create-microservice --config path/to/config.json --output_dir path/to/output --create_github_repo --github_project_name my-project --github_project_description "Example project"
   

3. With collaborators from JSON file and debug:

   matrx create-microservice --config path/to/config.json --output_dir path/to/output --create_github_repo --github_project_name my-project --github_access_file path/to/access.json --debug
   

Installation

From PyPI (recommended)

pip install matrx-dream-service
# or with uv
uv add matrx-dream-service

From GitHub (for development)

pip install git+https://github.com/armanisadeghi/matrx-dream-service.git

Publishing a New Version

Automated PyPI Publishing (Current Process)

The package automatically publishes to PyPI when you push a version tag. Here's the workflow:

1. Make and test your changes locally

   # Test your changes
   

2. Update the version in pyproject.toml

   version = "1.0.4"  # Increment appropriately
   

3. Commit and push changes

   git add .
   git commit -m "Add new feature - v1.0.4"
   git push origin main
   

4. Create and push the version tag

   git tag v1.0.4
   git push origin v1.0.4
   

5. GitHub Actions automatically:

   • Verifies the tag matches pyproject.toml version
   • Builds the package
   • Publishes to PyPI

6. Update dependent projects

   In projects like AI Dream, simply update the version:

   uv add matrx-dream-service@1.0.4
   # or manually in pyproject.toml:
   # matrx-dream-service = "^1.0.4"
   

Version History

Check current tags: git tag

Example output:

v1.0.0
v1.0.1
v1.0.2
v1.0.3

Important Notes

• Always update pyproject.toml version before tagging
• The GitHub Action will fail if tag version ≠ pyproject.toml version
• Semantic versioning: MAJOR.MINOR.PATCH (e.g., v1.0.4)
• Tags trigger automatic PyPI publishing