shiryu
Installation
Entrypoint
Types
DaggerSdkinterface
Shiryu
- sdk()

shiryu

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/fvonbergen/shiryu@1a06a67f65fa7494d4a66c6a99db512370b6d46c

Entrypoint

Return Type

Shiryu !

Example

dagger -m github.com/fvonbergen/shiryu@1a06a67f65fa7494d4a66c6a99db512370b6d46c call \

func (m *myModule) example() *Shiryu  {
	return dag.
			Shiryu()
}

@function
def example() -> dag.Shiryu:
	return (
		dag.shiryu()
	)

@func()
example(): Shiryu {
	return dag
		.shiryu()
}

Types

DaggerSdkinterface 🔗

SDKInterface class.

sdkLanguage() 🔗

Software Development Kit programming language

Return Type

Enum !

Example

dagger -m github.com/fvonbergen/shiryu@1a06a67f65fa7494d4a66c6a99db512370b6d46c call \
 sdk \
 sdk-language

func (m *myModule) example(language )   {
	return dag.
			Shiryu().
			Sdk(language).
			SdkLanguage()
}

@function
def example(language: ) -> :
	return (
		dag.shiryu()
		.sdk(language)
		.sdk_language()
	)

@func()
example(language: ):  {
	return dag
		.shiryu()
		.sdk(language)
		.sdkLanguage()
}

build() 🔗

Run build in the project of the provided source Directory.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
project	Directory	-	Project location
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container

Example

dagger -m github.com/fvonbergen/shiryu@1a06a67f65fa7494d4a66c6a99db512370b6d46c call \
 sdk \
 build --platform string

func (m *myModule) example(language , platform string) *Directory  {
	return dag.
			Shiryu().
			Sdk(language).
			Build(platform)
}

@function
def example(language: , platform: str) -> dagger.Directory:
	return (
		dag.shiryu()
		.sdk(language)
		.build(platform)
	)

@func()
example(language: , platform: string): Directory {
	return dag
		.shiryu()
		.sdk(language)
		.build(platform)
}

check() 🔗

Run type checks in the project of the provided source Directory.

Return Type

String !

Arguments

Name	Type	Default Value	Description
project	Directory	-	Project location
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container

Example

dagger -m github.com/fvonbergen/shiryu@1a06a67f65fa7494d4a66c6a99db512370b6d46c call \
 sdk \
 check --platform string

func (m *myModule) example(ctx context.Context, language , platform string) string  {
	return dag.
			Shiryu().
			Sdk(language).
			Check(ctxplatform)
}

@function
async def example(language: , platform: str) -> str:
	return await (
		dag.shiryu()
		.sdk(language)
		.check(platform)
	)

@func()
async example(language: , platform: string): Promise<string> {
	return dag
		.shiryu()
		.sdk(language)
		.check(platform)
}

init() 🔗

Returns a directory with a new project initialized.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
projectName	String !	-	Project name
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container

Example

dagger -m github.com/fvonbergen/shiryu@1a06a67f65fa7494d4a66c6a99db512370b6d46c call \
 sdk \
 init --project-name string --platform string

func (m *myModule) example(language , projectName string, platform string) *Directory  {
	return dag.
			Shiryu().
			Sdk(language).
			Init(projectName, platform)
}

@function
def example(language: , project_name: str, platform: str) -> dagger.Directory:
	return (
		dag.shiryu()
		.sdk(language)
		.init(project_name, platform)
	)

@func()
example(language: , projectName: string, platform: string): Directory {
	return dag
		.shiryu()
		.sdk(language)
		.init(projectName, platform)
}

lint() 🔗

Run lint checks in the project of the provided source Directory.

Return Type

String !

Arguments

Name	Type	Default Value	Description
project	Directory	-	Project location
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container

Example

dagger -m github.com/fvonbergen/shiryu@1a06a67f65fa7494d4a66c6a99db512370b6d46c call \
 sdk \
 lint --platform string

func (m *myModule) example(ctx context.Context, language , platform string) string  {
	return dag.
			Shiryu().
			Sdk(language).
			Lint(ctxplatform)
}

@function
async def example(language: , platform: str) -> str:
	return await (
		dag.shiryu()
		.sdk(language)
		.lint(platform)
	)

@func()
async example(language: , platform: string): Promise<string> {
	return dag
		.shiryu()
		.sdk(language)
		.lint(platform)
}

lintFix() 🔗

Run lint fixes in the project of the provided source Directory.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
project	Directory	-	Project location
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container

Example

dagger -m github.com/fvonbergen/shiryu@1a06a67f65fa7494d4a66c6a99db512370b6d46c call \
 sdk \
 lint-fix --platform string

func (m *myModule) example(language , platform string) *Directory  {
	return dag.
			Shiryu().
			Sdk(language).
			LintFix(platform)
}

@function
def example(language: , platform: str) -> dagger.Directory:
	return (
		dag.shiryu()
		.sdk(language)
		.lint_fix(platform)
	)

@func()
example(language: , platform: string): Directory {
	return dag
		.shiryu()
		.sdk(language)
		.lintFix(platform)
}

quality() 🔗

Run quality checks in the project of the provided source Directory.

Return Type

String !

Arguments

Name	Type	Default Value	Description
project	Directory	-	Project location
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container

Example

dagger -m github.com/fvonbergen/shiryu@1a06a67f65fa7494d4a66c6a99db512370b6d46c call \
 sdk \
 quality --platform string

func (m *myModule) example(ctx context.Context, language , platform string) string  {
	return dag.
			Shiryu().
			Sdk(language).
			Quality(ctxplatform)
}

@function
async def example(language: , platform: str) -> str:
	return await (
		dag.shiryu()
		.sdk(language)
		.quality(platform)
	)

@func()
async example(language: , platform: string): Promise<string> {
	return dag
		.shiryu()
		.sdk(language)
		.quality(platform)
}

testInstall() 🔗

Test the project installation process.

Return Type

String !

Arguments

Name	Type	Default Value	Description
project	Directory	-	Project location
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container

Example

dagger -m github.com/fvonbergen/shiryu@1a06a67f65fa7494d4a66c6a99db512370b6d46c call \
 sdk \
 test-install --platform string

func (m *myModule) example(ctx context.Context, language , platform string) string  {
	return dag.
			Shiryu().
			Sdk(language).
			TestInstall(ctxplatform)
}

@function
async def example(language: , platform: str) -> str:
	return await (
		dag.shiryu()
		.sdk(language)
		.test_install(platform)
	)

@func()
async example(language: , platform: string): Promise<string> {
	return dag
		.shiryu()
		.sdk(language)
		.testInstall(platform)
}

Shiryu 🔗

Shiryu class.

sdk() 🔗

Shiryu SDK.

Return Type

DaggerSdkinterface !

Arguments

Name	Type	Default Value	Description
language	Enum !	"python"	Software Development Kit programming language

Example

dagger -m github.com/fvonbergen/shiryu@1a06a67f65fa7494d4a66c6a99db512370b6d46c call \
 sdk

func (m *myModule) example(language ) *ShiryuDaggerSdkinterface  {
	return dag.
			Shiryu().
			Sdk(language)
}

@function
def example(language: ) -> dag.ShiryuDaggerSdkinterface:
	return (
		dag.shiryu()
		.sdk(language)
	)

@func()
example(language: ): ShiryuDaggerSdkinterface {
	return dag
		.shiryu()
		.sdk(language)
}