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@2414e45c85068998a8c64027190883ce8398d7ed

Entrypoint

Return Type

Shiryu !

Example

dagger -m github.com/fvonbergen/shiryu@2414e45c85068998a8c64027190883ce8398d7ed call \

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

@function
def example() -> dagger.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

Name	Type	Default Value	Description
projectName	String !	-	Project name
platform	String !	"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.

Builder 🔗

Python SDK builder.

build() 🔗

Build project distributable 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@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 builder \
 build --platform string

func (m *myModule) example(platform string) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Builder().
			Build(platform)
}

@function
def example(platform: str) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.builder()
		.build(platform)
	)

@func()
example(platform: string): Directory {
	return dag
		.shiryu()
		.python()
		.builder()
		.build(platform)
}

deploy() 🔗

Build and deploy project distributable of the provided source Directory.

Return Type

String !

Arguments

Name	Type	Default Value	Description
project	Directory	-	Project location
repositoryUrl	String !	-	Repository to push distributable
repositoryUser	String !	-	Repository user
repositoryPassword	Secret !	-	Repository password
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container

Example

dagger -m github.com/fvonbergen/shiryu@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 builder \
 deploy --repository-url string --repository-user string --repository-password env:MYSECRET --platform string

func (m *myModule) example(ctx context.Context, repositoryUrl string, repositoryUser string, repositoryPassword *dagger.Secret, platform string) string  {
	return dag.
			Shiryu().
			Python().
			Builder().
			Deploy(ctxrepositoryUrl, repositoryUser, repositoryPassword, platform)
}

@function
async def example(repository_url: str, repository_user: str, repository_password: dagger.Secret, platform: str) -> str:
	return await (
		dag.shiryu()
		.python()
		.builder()
		.deploy(repository_url, repository_user, repository_password, platform)
	)

@func()
async example(repositoryUrl: string, repositoryUser: string, repositoryPassword: Secret, platform: string): Promise<string> {
	return dag
		.shiryu()
		.python()
		.builder()
		.deploy(repositoryUrl, repositoryUser, repositoryPassword, platform)
}

init() 🔗

Returns an initialized directory for the SDK module.

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@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 builder \
 init --project-name string --platform string

func (m *myModule) example(projectName string, platform string) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Builder().
			Init(projectName, platform)
}

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

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

test() 🔗

Test the project installation process for 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@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 builder \
 test --platform string

func (m *myModule) example(ctx context.Context, platform string) string  {
	return dag.
			Shiryu().
			Python().
			Builder().
			Test(ctxplatform)
}

@function
async def example(platform: str) -> str:
	return await (
		dag.shiryu()
		.python()
		.builder()
		.test(platform)
	)

@func()
async example(platform: string): Promise<string> {
	return dag
		.shiryu()
		.python()
		.builder()
		.test(platform)
}

Checker 🔗

Python SDK checker.

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@2414e45c85068998a8c64027190883ce8398d7ed 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

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@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 checker \
 init --project-name string --platform string

func (m *myModule) example(projectName string, platform string) *dagger.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)
}

Documenter 🔗

Python SDK documenter.

document() 🔗

Run documenter document 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@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 documenter \
 document --platform string

func (m *myModule) example(platform string) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Documenter().
			Document(platform)
}

@function
def example(platform: str) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.documenter()
		.document(platform)
	)

@func()
example(platform: string): Directory {
	return dag
		.shiryu()
		.python()
		.documenter()
		.document(platform)
}

init() 🔗

Returns an initialized directory for the SDK module.

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@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 documenter \
 init --project-name string --platform string

func (m *myModule) example(projectName string, platform string) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Documenter().
			Init(projectName, platform)
}

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

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

Linter 🔗

Python SDK linter.

fix() 🔗

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

Return Type

Directory !

Arguments

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

Example

dagger -m github.com/fvonbergen/shiryu@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 linter \
 fix --platform string

func (m *myModule) example(platform string) *dagger.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

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@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 linter \
 init --project-name string --platform string

func (m *myModule) example(projectName string, platform string) *dagger.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

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@2414e45c85068998a8c64027190883ce8398d7ed 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.

builder() 🔗

Python SDK builder.

Return Type

Builder !

Example

dagger -m github.com/fvonbergen/shiryu@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 builder

func (m *myModule) example() *dagger.ShiryuBuilder  {
	return dag.
			Shiryu().
			Python().
			Builder()
}

@function
def example() -> dagger.ShiryuBuilder:
	return (
		dag.shiryu()
		.python()
		.builder()
	)

@func()
example(): ShiryuBuilder {
	return dag
		.shiryu()
		.python()
		.builder()
}

checker() 🔗

Python SDK checker.

Return Type

Checker !

Example

dagger -m github.com/fvonbergen/shiryu@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 checker

func (m *myModule) example() *dagger.ShiryuChecker  {
	return dag.
			Shiryu().
			Python().
			Checker()
}

@function
def example() -> dagger.ShiryuChecker:
	return (
		dag.shiryu()
		.python()
		.checker()
	)

@func()
example(): ShiryuChecker {
	return dag
		.shiryu()
		.python()
		.checker()
}

documenter() 🔗

Python SDK documenter.

Return Type

Documenter !

Example

dagger -m github.com/fvonbergen/shiryu@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 documenter

func (m *myModule) example() *dagger.ShiryuDocumenter  {
	return dag.
			Shiryu().
			Python().
			Documenter()
}

@function
def example() -> dagger.ShiryuDocumenter:
	return (
		dag.shiryu()
		.python()
		.documenter()
	)

@func()
example(): ShiryuDocumenter {
	return dag
		.shiryu()
		.python()
		.documenter()
}

init() 🔗

Python SDK initializer.

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
modules	[String ! ]	null	Python SDK modules to initialize (options linter, documenter, checker, builder) (default None).

Example

dagger -m github.com/fvonbergen/shiryu@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 init --project-name string --platform string

func (m *myModule) example(projectName string, platform string) *dagger.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@2414e45c85068998a8c64027190883ce8398d7ed call \
 python \
 linter

func (m *myModule) example() *dagger.ShiryuLinter  {
	return dag.
			Shiryu().
			Python().
			Linter()
}

@function
def example() -> dagger.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@2414e45c85068998a8c64027190883ce8398d7ed call \
 python

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

@function
def example() -> dagger.ShiryuPython:
	return (
		dag.shiryu()
		.python()
	)

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