Dagger
Search

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@383d8474c90c63ee88f11a5c02d6be0a2933073b

Entrypoint

Return Type 
Shiryu !
Example
dagger -m github.com/fvonbergen/shiryu@383d8474c90c63ee88f11a5c02d6be0a2933073b call \

func (m *myModule) example() *Shiryu  {
	return dag.
			Shiryu()
}
@function
def example() -> dag.Shiryu:
	return (
		dag.shiryu()
	)
@func()
example(): Shiryu {
	return dag
		.shiryu()
}

Types

Sdkmodule 🔗

SDKModule class.

init() 🔗

Returns an initialized directory for the SDK module.

Return Type 
Directory !
Arguments
NameTypeDefault ValueDescription
projectNameString !-Project name
platformString !"linux/amd64"Platform config OS and architecture in a Container
Example
Function ShiryuSdkmodule.init is not accessible from the shiryu module
Function ShiryuSdkmodule.init is not accessible from the shiryu module
Function ShiryuSdkmodule.init is not accessible from the shiryu module
Function ShiryuSdkmodule.init is not accessible from the shiryu module

Sdk 🔗

SDK class.

Checker 🔗

Python SDK checker.

check() 🔗

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

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
projectDirectory -Project location
platformString !"linux/amd64"Platform config OS and architecture in a Container
Example
dagger -m github.com/fvonbergen/shiryu@383d8474c90c63ee88f11a5c02d6be0a2933073b call \
 python \
 checker \
 check --platform string
func (m *myModule) example(ctx context.Context, platform string) string  {
	return dag.
			Shiryu().
			Python().
			Checker().
			Check(ctxplatform)
}
@function
async def example(platform: str) -> str:
	return await (
		dag.shiryu()
		.python()
		.checker()
		.check(platform)
	)
@func()
async example(platform: string): Promise<string> {
	return dag
		.shiryu()
		.python()
		.checker()
		.check(platform)
}

init() 🔗

Returns an initialized directory for the SDK module.

Return Type 
Directory !
Arguments
NameTypeDefault ValueDescription
projectNameString !-Project name
platformString !"linux/amd64"Platform config OS and architecture in a Container
Example
dagger -m github.com/fvonbergen/shiryu@383d8474c90c63ee88f11a5c02d6be0a2933073b call \
 python \
 checker \
 init --project-name string --platform string
func (m *myModule) example(projectName string, platform string) *Directory  {
	return dag.
			Shiryu().
			Python().
			Checker().
			Init(projectName, platform)
}
@function
def example(project_name: str, platform: str) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.checker()
		.init(project_name, platform)
	)
@func()
example(projectName: string, platform: string): Directory {
	return dag
		.shiryu()
		.python()
		.checker()
		.init(projectName, platform)
}

Linter 🔗

Python SDK linter.

fix() 🔗

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

Return Type 
Directory !
Arguments
NameTypeDefault ValueDescription
projectDirectory -Project location
platformString !-Platform config OS and architecture in a Container
Example
dagger -m github.com/fvonbergen/shiryu@383d8474c90c63ee88f11a5c02d6be0a2933073b call \
 python \
 linter \
 fix --platform string
func (m *myModule) example(platform string) *Directory  {
	return dag.
			Shiryu().
			Python().
			Linter().
			Fix(platform)
}
@function
def example(platform: str) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.linter()
		.fix(platform)
	)
@func()
example(platform: string): Directory {
	return dag
		.shiryu()
		.python()
		.linter()
		.fix(platform)
}

init() 🔗

Returns an initialized directory for the SDK module.

Return Type 
Directory !
Arguments
NameTypeDefault ValueDescription
projectNameString !-Project name
platformString !"linux/amd64"Platform config OS and architecture in a Container
Example
dagger -m github.com/fvonbergen/shiryu@383d8474c90c63ee88f11a5c02d6be0a2933073b call \
 python \
 linter \
 init --project-name string --platform string
func (m *myModule) example(projectName string, platform string) *Directory  {
	return dag.
			Shiryu().
			Python().
			Linter().
			Init(projectName, platform)
}
@function
def example(project_name: str, platform: str) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.linter()
		.init(project_name, platform)
	)
@func()
example(projectName: string, platform: string): Directory {
	return dag
		.shiryu()
		.python()
		.linter()
		.init(projectName, platform)
}

lint() 🔗

Run linter analysis in the project of the provided source Directory.

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
projectDirectory -Project location
platformString !"linux/amd64"Platform config OS and architecture in a Container
Example
dagger -m github.com/fvonbergen/shiryu@383d8474c90c63ee88f11a5c02d6be0a2933073b call \
 python \
 linter \
 lint --platform string
func (m *myModule) example(ctx context.Context, platform string) string  {
	return dag.
			Shiryu().
			Python().
			Linter().
			Lint(ctxplatform)
}
@function
async def example(platform: str) -> str:
	return await (
		dag.shiryu()
		.python()
		.linter()
		.lint(platform)
	)
@func()
async example(platform: string): Promise<string> {
	return dag
		.shiryu()
		.python()
		.linter()
		.lint(platform)
}

Python 🔗

Python SDK.

checker() 🔗

Python SDK checker.

Return Type 
Checker !
Example
dagger -m github.com/fvonbergen/shiryu@383d8474c90c63ee88f11a5c02d6be0a2933073b call \
 python \
 checker
func (m *myModule) example() *ShiryuChecker  {
	return dag.
			Shiryu().
			Python().
			Checker()
}
@function
def example() -> dag.ShiryuChecker:
	return (
		dag.shiryu()
		.python()
		.checker()
	)
@func()
example(): ShiryuChecker {
	return dag
		.shiryu()
		.python()
		.checker()
}

init() 🔗

Python SDK initializer.

Return Type 
Directory !
Arguments
NameTypeDefault ValueDescription
projectNameString !-Project name
platformString !"linux/amd64"Platform config OS and architecture in a Container
modules[String ! ] nullPython SDK modules to initialize (options checker, linter) (default None).
Example
dagger -m github.com/fvonbergen/shiryu@383d8474c90c63ee88f11a5c02d6be0a2933073b call \
 python \
 init --project-name string --platform string
func (m *myModule) example(projectName string, platform string) *Directory  {
	return dag.
			Shiryu().
			Python().
			Init(projectName, platform)
}
@function
def example(project_name: str, platform: str) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.init(project_name, platform)
	)
@func()
example(projectName: string, platform: string): Directory {
	return dag
		.shiryu()
		.python()
		.init(projectName, platform)
}

linter() 🔗

Python SDK linter.

Return Type 
Linter !
Example
dagger -m github.com/fvonbergen/shiryu@383d8474c90c63ee88f11a5c02d6be0a2933073b call \
 python \
 linter
func (m *myModule) example() *ShiryuLinter  {
	return dag.
			Shiryu().
			Python().
			Linter()
}
@function
def example() -> dag.ShiryuLinter:
	return (
		dag.shiryu()
		.python()
		.linter()
	)
@func()
example(): ShiryuLinter {
	return dag
		.shiryu()
		.python()
		.linter()
}

Shiryu 🔗

Shiryu class.

python() 🔗

Python SDK.

Return Type 
Python !
Example
dagger -m github.com/fvonbergen/shiryu@383d8474c90c63ee88f11a5c02d6be0a2933073b call \
 python
func (m *myModule) example() *ShiryuPython  {
	return dag.
			Shiryu().
			Python()
}
@function
def example() -> dag.ShiryuPython:
	return (
		dag.shiryu()
		.python()
	)
@func()
example(): ShiryuPython {
	return dag
		.shiryu()
		.python()
}