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@bd61b363fc3f3df27441855a4cb15c43a65ac0b9

Entrypoint

Return Type

Shiryu !

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 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
project	Directory	-	Project location
isUpdate	Boolean !	false	Whether to update project files or not.
scm	[Enum ! ] !	["GITLAB"]	Project Source Code Management (SCM) list to be targeted or configured.
platform	Scalar !	"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	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 builder \
 build

func (m *MyModule) Example(platform ) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Builder().
			Build(platform)
}

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

@func()
example(platform: ): 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	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

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

func (m *MyModule) Example(ctx context.Context, repositoryUrl string, repositoryUser string, repositoryPassword *dagger.Secret, platform ) 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:
	return await (
		dag.shiryu()
		.python()
		.builder()
		.deploy(repository_url, repository_user, repository_password, platform)
	)

@func()
async example(repositoryUrl: string, repositoryUser: string, repositoryPassword: Secret, platform: ): 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
project	Directory	-	Project location
isUpdate	Boolean !	false	Whether to update project files or not.
scm	[Enum ! ] !	["GITLAB"]	Project Source Code Management (SCM) list to be targeted or configured.
platform	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 builder \
 init --project-name string --is-update boolean

func (m *MyModule) Example(projectName string, isUpdate bool, scm [], platform ) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Builder().
			Init(projectName, isUpdate, scm, platform)
}

@function
def example(project_name: str, is_update: bool, scm: List[], platform: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.builder()
		.init(project_name, is_update, scm, platform)
	)

@func()
example(projectName: string, isUpdate: boolean, scm: [], platform: ): Directory {
	return dag
		.shiryu()
		.python()
		.builder()
		.init(projectName, isUpdate, scm, 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	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 builder \
 test

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

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

@func()
async example(platform: ): 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	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 checker \
 check

func (m *MyModule) Example(ctx context.Context, platform ) string  {
	return dag.
			Shiryu().
			Python().
			Checker().
			Check(ctxplatform)
}

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

@func()
async example(platform: ): 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
project	Directory	-	Project location
isUpdate	Boolean !	false	Whether to update project files or not.
scm	[Enum ! ] !	["GITLAB"]	Project Source Code Management (SCM) list to be targeted or configured.
platform	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 checker \
 init --project-name string --is-update boolean

func (m *MyModule) Example(projectName string, isUpdate bool, scm [], platform ) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Checker().
			Init(projectName, isUpdate, scm, platform)
}

@function
def example(project_name: str, is_update: bool, scm: List[], platform: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.checker()
		.init(project_name, is_update, scm, platform)
	)

@func()
example(projectName: string, isUpdate: boolean, scm: [], platform: ): Directory {
	return dag
		.shiryu()
		.python()
		.checker()
		.init(projectName, isUpdate, scm, 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	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 documenter \
 document

func (m *MyModule) Example(platform ) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Documenter().
			Document(platform)
}

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

@func()
example(platform: ): 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
project	Directory	-	Project location
isUpdate	Boolean !	false	Whether to update project files or not.
scm	[Enum ! ] !	["GITLAB"]	Project Source Code Management (SCM) list to be targeted or configured.
platform	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 documenter \
 init --project-name string --is-update boolean

func (m *MyModule) Example(projectName string, isUpdate bool, scm [], platform ) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Documenter().
			Init(projectName, isUpdate, scm, platform)
}

@function
def example(project_name: str, is_update: bool, scm: List[], platform: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.documenter()
		.init(project_name, is_update, scm, platform)
	)

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

Jupyter 🔗

Python SDK jupyter.

init() 🔗

Returns an initialized directory for the SDK module.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
projectName	String !	-	Project name
project	Directory	-	Project location
isUpdate	Boolean !	false	Whether to update project files or not.
scm	[Enum ! ] !	["GITLAB"]	Project Source Code Management (SCM) list to be targeted or configured.
platform	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 jupyter \
 init --project-name string --is-update boolean

func (m *MyModule) Example(projectName string, isUpdate bool, scm [], platform ) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Jupyter().
			Init(projectName, isUpdate, scm, platform)
}

@function
def example(project_name: str, is_update: bool, scm: List[], platform: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.jupyter()
		.init(project_name, is_update, scm, platform)
	)

@func()
example(projectName: string, isUpdate: boolean, scm: [], platform: ): Directory {
	return dag
		.shiryu()
		.python()
		.jupyter()
		.init(projectName, isUpdate, scm, platform)
}

notebooks() 🔗

Returns jupyter notebooks Directory.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
platform	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 jupyter \
 notebooks

func (m *MyModule) Example(platform ) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Jupyter().
			Notebooks(platform)
}

@function
def example(platform: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.jupyter()
		.notebooks(platform)
	)

@func()
example(platform: ): Directory {
	return dag
		.shiryu()
		.python()
		.jupyter()
		.notebooks(platform)
}

service() 🔗

Returns a jupyter notebooks service with the project of the provided source Directory.

Return Type

Service !

Arguments

Name	Type	Default Value	Description
project	Directory	-	Project location
backendPort	Integer !	8888	Jupyter notebooks port
platform	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 jupyter \
 service --backend-port integer

func (m *MyModule) Example(backendPort int, platform ) *dagger.Service  {
	return dag.
			Shiryu().
			Python().
			Jupyter().
			Service(backendPort, platform)
}

@function
def example(backend_port: int, platform: ) -> dagger.Service:
	return (
		dag.shiryu()
		.python()
		.jupyter()
		.service(backend_port, platform)
	)

@func()
example(backendPort: number, platform: ): Service {
	return dag
		.shiryu()
		.python()
		.jupyter()
		.service(backendPort, 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	Scalar !	-	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 linter \
 fix

func (m *MyModule) Example(platform ) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Linter().
			Fix(platform)
}

@function
def example(platform: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.linter()
		.fix(platform)
	)

@func()
example(platform: ): 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
project	Directory	-	Project location
isUpdate	Boolean !	false	Whether to update project files or not.
scm	[Enum ! ] !	["GITLAB"]	Project Source Code Management (SCM) list to be targeted or configured.
platform	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 linter \
 init --project-name string --is-update boolean

func (m *MyModule) Example(projectName string, isUpdate bool, scm [], platform ) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Linter().
			Init(projectName, isUpdate, scm, platform)
}

@function
def example(project_name: str, is_update: bool, scm: List[], platform: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.linter()
		.init(project_name, is_update, scm, platform)
	)

@func()
example(projectName: string, isUpdate: boolean, scm: [], platform: ): Directory {
	return dag
		.shiryu()
		.python()
		.linter()
		.init(projectName, isUpdate, scm, 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	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 linter \
 lint

func (m *MyModule) Example(ctx context.Context, platform ) string  {
	return dag.
			Shiryu().
			Python().
			Linter().
			Lint(ctxplatform)
}

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

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

Tester 🔗

Python SDK tester.

init() 🔗

Returns an initialized directory for the SDK module.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
projectName	String !	-	Project name
project	Directory	-	Project location
isUpdate	Boolean !	false	Whether to update project files or not.
scm	[Enum ! ] !	["GITLAB"]	Project Source Code Management (SCM) list to be targeted or configured.
platform	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 tester \
 init --project-name string --is-update boolean

func (m *MyModule) Example(projectName string, isUpdate bool, scm [], platform ) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Tester().
			Init(projectName, isUpdate, scm, platform)
}

@function
def example(project_name: str, is_update: bool, scm: List[], platform: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.tester()
		.init(project_name, is_update, scm, platform)
	)

@func()
example(projectName: string, isUpdate: boolean, scm: [], platform: ): Directory {
	return dag
		.shiryu()
		.python()
		.tester()
		.init(projectName, isUpdate, scm, platform)
}

unit() 🔗

Run unit tests in the project of the provided source Directory.

Return Type

String !

Arguments

Name	Type	Default Value	Description
project	Directory	-	Project location
keyword	String	null	Run tests that match substring expression
platform	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 tester \
 unit

func (m *MyModule) Example(ctx context.Context, platform ) string  {
	return dag.
			Shiryu().
			Python().
			Tester().
			Unit(ctxplatform)
}

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

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

Python 🔗

Python SDK.

builder() 🔗

Python SDK builder.

Return Type

Builder !

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 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@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 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@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 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
project	Directory	-	Project location
isUpdate	Boolean !	false	Whether to update project files or not.
scm	[Enum ! ] !	["GITLAB"]	Project Source Code Management (SCM) list to be targeted or configured.
platform	Scalar !	"linux/amd64"	Platform config OS and architecture in a Container.
modules	[String ! ]	null	Python SDK modules to initialize (options linter, documenter, tester, jupyter, checker, builder). (default None)

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 init --project-name string --is-update boolean

func (m *MyModule) Example(projectName string, isUpdate bool, scm [], platform ) *dagger.Directory  {
	return dag.
			Shiryu().
			Python().
			Init(projectName, isUpdate, scm, platform)
}

@function
def example(project_name: str, is_update: bool, scm: List[], platform: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.python()
		.init(project_name, is_update, scm, platform)
	)

@func()
example(projectName: string, isUpdate: boolean, scm: [], platform: ): Directory {
	return dag
		.shiryu()
		.python()
		.init(projectName, isUpdate, scm, platform)
}

jupyter() 🔗

Python SDK jupyter.

Return Type

Jupyter !

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 jupyter

func (m *MyModule) Example() *dagger.ShiryuJupyter  {
	return dag.
			Shiryu().
			Python().
			Jupyter()
}

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

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

linter() 🔗

Python SDK linter.

Return Type

Linter !

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 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()
}

tester() 🔗

Python SDK tester.

Return Type

Tester !

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 call \
 python \
 tester

func (m *MyModule) Example() *dagger.ShiryuTester  {
	return dag.
			Shiryu().
			Python().
			Tester()
}

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

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

Shiryu 🔗

Shiryu class.

python() 🔗

Python SDK.

Return Type

Python !

Example

dagger -m github.com/fvonbergen/shiryu@bd61b363fc3f3df27441855a4cb15c43a65ac0b9 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()
}