Skip to main content

ProjectTemplateService

Struct ProjectTemplateService 

Source
pub struct ProjectTemplateService { /* private fields */ }
Expand description

Service for generating project template files

§Examples

ⓘ
use mecha10_cli::services::ProjectTemplateService;

let service = ProjectTemplateService::new();

// Generate all project files
service.create_readme(&project_path, "my-robot").await?;
service.create_cargo_toml(&project_path, "my-robot").await?;

Implementations§

Source§

impl ProjectTemplateService

Source

pub fn new() -> ProjectTemplateService

Create a new ProjectTemplateService

Source

pub async fn create_readme( &self, path: &Path, project_name: &str, ) -> Result<(), Error>

Create README.md for the project

Source

pub async fn create_gitignore(&self, path: &Path) -> Result<(), Error>

Create .gitignore for the project

Source

pub async fn create_cargo_toml( &self, path: &Path, project_name: &str, ) -> Result<(), Error>

Create Cargo.toml for the project

§Arguments
  • path - Project root path
  • project_name - Name of the project
Source

pub async fn create_main_rs( &self, path: &Path, project_name: &str, ) -> Result<(), Error>

Create src/main.rs for the project

Source

pub async fn create_build_rs(&self, path: &Path) -> Result<(), Error>

Create build.rs for the project

This build script generates:

  1. node_registry.rs - Node dispatcher based on mecha10.json
Source

pub async fn create_env_example( &self, path: &Path, project_name: &str, ) -> Result<(), Error>

Create .env.example for the project

§Arguments
  • path - Project root path
  • project_name - Name of the project
Source

pub async fn create_rustfmt_toml(&self, path: &Path) -> Result<(), Error>

Create rustfmt.toml for the project

Source

pub async fn create_docker_compose( &self, path: &Path, project_name: &str, ) -> Result<(), Error>

Create docker-compose.yml for the project

Generates a Docker Compose file with Redis and optional PostgreSQL services for local development and deployment.

§Arguments
  • path - Project root path
  • project_name - Name of the project (used for container naming)
Source

pub async fn create_remote_docker_files(&self, path: &Path) -> Result<(), Error>

Create remote node Docker files

Creates docker-compose.remote.yml and Dockerfile.remote for running AI/ML nodes in containers. These are used when nodes are configured in targets.remote in mecha10.json.

§Arguments
  • path - Project root path
Source

pub async fn create_package_json( &self, path: &Path, project_name: &str, ) -> Result<(), Error>

Create package.json for npm dependencies

Includes @mecha10/simulation-models and @mecha10/simulation-environments dependencies, resolved via node_modules/@mecha10/* (requires npm install).

§Arguments
  • path - Project root path
  • project_name - Name of the project
Source

pub async fn create_requirements_txt(&self, path: &Path) -> Result<(), Error>

Create requirements.txt for Python dependencies

Includes Python packages needed for AI nodes (onnx, onnxruntime). Install with: mecha10 setup or pip install -r requirements.txt

§Arguments
  • path - Project root path
Source

pub async fn create_rl_training_bundle(&self, path: &Path) -> Result<(), Error>

Create the standard RL training bundle (LAB-1743, Kestra flows added in LAB-1765) for a rover template project

Bundles the Phase 2 rover env / ppo algorithm (packages/rl-trainer, packages/rl-task-runner, registered via the mecha10_rl.envs/mecha10_rl.algorithms entry-points registry, LAB-1732/1733) into three pieces:

  • configs/rl/local.yml - the default sentinel-override config for the combination (LAB-1734’s rl_task_runner.local_config pattern).
  • requirements.txt - appended with the two packages’ dependencies, since both already register their entry points in their own pyproject.toml (nothing else to declare).
  • kestra/README.md and kestra/flows/ml-pipeline/*.yml - the real train/tune/ tune-then-train/train-from-tune/resume-run Kestra flows (LAB-1745), embedded and bundled by LAB-1765 so new projects get working flows out of the box.

Callers should invoke create_requirements_txt first — this appends to that file rather than creating it.

§Arguments
  • path - Project root path
Source

pub async fn create_simulation_model_json( &self, path: &Path, ) -> Result<(), Error>

Create simulation/models/model.json

Generates the rover robot physical model configuration from embedded template.

§Arguments
  • path - Project root directory
Source

pub async fn create_simulation_environment_json( &self, path: &Path, ) -> Result<(), Error>

Create simulation/environments/basic_arena/environment.json

Generates the basic arena environment configuration from embedded template.

§Arguments
  • path - Project root directory

Trait Implementations§

Source§

impl Default for ProjectTemplateService

Source§

fn default() -> ProjectTemplateService

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more