Skip to content

kraken.std.buffrs

kraken.std.buffrs

buffrs_install 

buffrs_install(
    *, project: Project | None = None
) -> BuffrsInstallTask

Installs buffrs dependencies defined in the Proto.toml

Source code in kraken/std/buffrs/__init__.py 
42
43
44
45
46
def buffrs_install(*, project: Project | None = None) -> BuffrsInstallTask:
    """Installs buffrs dependencies defined in the `Proto.toml`"""

    project = project or Project.current()
    return project.task("buffrsInstall", BuffrsInstallTask)

buffrs_login 

buffrs_login(
    *,
    project: Project | None = None,
    registry: str,
    token: str
) -> BuffrsLoginTask

Create a task to log into an Artifactory registry with Buffrs. The task is created in the root project regardless from where it is called. Note that currently we only support a single registry to push to, because we always use buffrsLogin as the task name.

Source code in kraken/std/buffrs/__init__.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def buffrs_login(
    *,
    project: Project | None = None,
    registry: str,
    token: str,
) -> BuffrsLoginTask:
    """Create a task to log into an Artifactory registry with Buffrs. The task is created in the root project
    regardless from where it is called. Note that currently we only support a single registry to push to, because
    we always use `buffrsLogin` as the task name."""

    project = project or Project.current()
    root_project = project.context.root_project

    if "buffrsLogin" in root_project.tasks():
        task = cast(BuffrsLoginTask, root_project.task("buffrsLogin"))
        if task.registry.get() != registry or task.token.get() != token:
            raise RuntimeError("multiple buffrs_login() calls with different registry/token not currently supported")
    else:
        task = root_project.task("buffrsLogin", BuffrsLoginTask)
        task.registry = registry
        task.token = token

    return task

buffrs_publish 

buffrs_publish(
    *,
    project: Project | None = None,
    registry: str,
    repository: str,
    version: str | None = None
) -> BuffrsPublishTask

Publishes the buffrs package to the repository of the project.

Source code in kraken/std/buffrs/__init__.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def buffrs_publish(
    *,
    project: Project | None = None,
    registry: str,
    repository: str,
    version: str | None = None,
) -> BuffrsPublishTask:
    """Publishes the buffrs package to the repository of the project."""

    project = project or Project.current()

    task = project.task("buffrsPublish", BuffrsPublishTask)
    task.registry = registry
    task.repository = repository
    task.version = version
    return task