spokane-tech
Installation
Entrypoint
Types
SpokaneTechLinter
SpokaneTech

spokane-tech

No long description provided.

Installation

dagger install github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674

Entrypoint

Return Type

SpokaneTech !

Arguments

Name	Type	Description
src	Directory	No description provided
isDev	Boolean !	No description provided

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 --is-dev boolean

func (m *myModule) example(isDev bool) *SpokaneTech  {
	return dag.
			SpokaneTech(isDev)
}

@function
def example(is_dev: bool) -> dag.SpokaneTech:
	return (
		dag.spokane_tech(is_dev)
	)

@func()
example(isDev: boolean): SpokaneTech {
	return dag
		.spokaneTech(isDev)
}

Types

SpokaneTechLinter 🔗

checkDjango() 🔗

Run Django system checks.

Return Type

String !

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 linters \
 check-django

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			SpokaneTech().
			Linters().
			CheckDjango(ctx)
}

@function
async def example() -> str:
	return await (
		dag.spokane_tech()
		.linters()
		.check_django()
	)

@func()
async example(): Promise<string> {
	return dag
		.spokaneTech()
		.linters()
		.checkDjango()
}

check() 🔗

Flake8 style checks using ruff.

Return Type

String !

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 linters \
 check

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			SpokaneTech().
			Linters().
			Check(ctx)
}

@function
async def example() -> str:
	return await (
		dag.spokane_tech()
		.linters()
		.check()
	)

@func()
async example(): Promise<string> {
	return dag
		.spokaneTech()
		.linters()
		.check()
}

format() 🔗

Check if the code is formatted correctly.

Return Type

String !

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 linters \
 format

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			SpokaneTech().
			Linters().
			Format(ctx)
}

@function
async def example() -> str:
	return await (
		dag.spokane_tech()
		.linters()
		.format()
	)

@func()
async example(): Promise<string> {
	return dag
		.spokaneTech()
		.linters()
		.format()
}

bandit() 🔗

Check for security issues using Bandit.

Return Type

String !

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 linters \
 bandit

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			SpokaneTech().
			Linters().
			Bandit(ctx)
}

@function
async def example() -> str:
	return await (
		dag.spokane_tech()
		.linters()
		.bandit()
	)

@func()
async example(): Promise<string> {
	return dag
		.spokaneTech()
		.linters()
		.bandit()
}

test() 🔗

Run tests using Pytest.

Return Type

String !

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 linters \
 test

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			SpokaneTech().
			Linters().
			Test(ctx)
}

@function
async def example() -> str:
	return await (
		dag.spokane_tech()
		.linters()
		.test()
	)

@func()
async example(): Promise<string> {
	return dag
		.spokaneTech()
		.linters()
		.test()
}

all() 🔗

Runs all the liners and shows a summary.

Return Type

String !

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 linters \
 all

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			SpokaneTech().
			Linters().
			All(ctx)
}

@function
async def example() -> str:
	return await (
		dag.spokane_tech()
		.linters()
		.all()
	)

@func()
async example(): Promise<string> {
	return dag
		.spokaneTech()
		.linters()
		.all()
}

SpokaneTech 🔗

baseContainer() 🔗

The base container that all other containers are built off of.

Return Type

Container !

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 --is-dev boolean base-container

func (m *myModule) example(isDev bool) *Container  {
	return dag.
			SpokaneTech(isDev).
			BaseContainer()
}

@function
def example(is_dev: bool) -> dagger.Container:
	return (
		dag.spokane_tech(is_dev)
		.base_container()
	)

@func()
example(isDev: boolean): Container {
	return dag
		.spokaneTech(isDev)
		.baseContainer()
}

linters() 🔗

Return Type

SpokaneTechLinter !

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 --is-dev boolean linters

func (m *myModule) example(isDev bool) *SpokaneTechLinter  {
	return dag.
			SpokaneTech(isDev).
			Linters()
}

@function
def example(is_dev: bool) -> dag.SpokaneTechLinter:
	return (
		dag.spokane_tech(is_dev)
		.linters()
	)

@func()
example(isDev: boolean): SpokaneTechLinter {
	return dag
		.spokaneTech(isDev)
		.linters()
}

dev() 🔗

A container that represents the dev environment. Celery (and Redis) services are started and attached. An Admin user with username/password ‘dagger’/‘dagger’ is created.

If --run is passed, the Django server will be started.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
run	Boolean !	false	No description provided
freshDatabase	Boolean !	false	No description provided

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 --is-dev boolean dev --run boolean --fresh-database boolean

func (m *myModule) example(isDev bool, run bool, freshDatabase bool) *Container  {
	return dag.
			SpokaneTech(isDev).
			Dev(run, freshDatabase)
}

@function
def example(is_dev: bool, run: bool, fresh_database: bool) -> dagger.Container:
	return (
		dag.spokane_tech(is_dev)
		.dev(run, fresh_database)
	)

@func()
example(isDev: boolean, run: boolean, freshDatabase: boolean): Container {
	return dag
		.spokaneTech(isDev)
		.dev(run, freshDatabase)
}

up() 🔗

Convenience wrapper around dagger call dev --run as-service up

Return Type

Service !

Arguments

Name	Type	Default Value	Description
freshDatabase	Boolean !	false	No description provided

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 --is-dev boolean up --fresh-database boolean

func (m *myModule) example(isDev bool, freshDatabase bool) *Service  {
	return dag.
			SpokaneTech(isDev).
			Up(freshDatabase)
}

@function
def example(is_dev: bool, fresh_database: bool) -> dagger.Service:
	return (
		dag.spokane_tech(is_dev)
		.up(fresh_database)
	)

@func()
example(isDev: boolean, freshDatabase: boolean): Service {
	return dag
		.spokaneTech(isDev)
		.up(freshDatabase)
}

prod() 🔗

A production-ready container.

Return Type

Container !

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 --is-dev boolean prod

func (m *myModule) example(isDev bool) *Container  {
	return dag.
			SpokaneTech(isDev).
			Prod()
}

@function
def example(is_dev: bool) -> dagger.Container:
	return (
		dag.spokane_tech(is_dev)
		.prod()
	)

@func()
example(isDev: boolean): Container {
	return dag
		.spokaneTech(isDev)
		.prod()
}

docs() 🔗

Run the documentation server locally, without needing to install cairo.

When calling this function use --src ./docs and --req ./requirements/dev.txt.

Return Type

Service !

Example

dagger -m github.com/SpokaneTech/SpokaneTech_py@d4eb605c1209c902c317c9c16e37419a6a11a674 call \
 --is-dev boolean docs

func (m *myModule) example(isDev bool) *Service  {
	return dag.
			SpokaneTech(isDev).
			Docs()
}

@function
def example(is_dev: bool) -> dagger.Service:
	return (
		dag.spokane_tech(is_dev)
		.docs()
	)

@func()
example(isDev: boolean): Service {
	return dag
		.spokaneTech(isDev)
		.docs()
}