get_project

Retrieve a dbnl Project

dbnl.get_project(
    *,
    name: str,
) -> Project:

Parameters

Arguments	Description
name	The name for the existing dbnl Project. An error will be raised if there is no Project with the given name.

Returns

Type	Description
Project	The dbnl Project with the given name.

Examples

import dbnl
dbnl.login()


proj_1 = dbnl.create_project(name="test_p1")
proj_2 = dbnl.get_project(name="test_p1")

# Calling get_project will yield same Project object
assert proj_1.id == proj_2.id

# DBNLProjectNotFoundError: A dnnl Project with name not_exist does not exist
proj_3 = dbnl.get_project(name="not_exist")