Skip to content

Projects

Project-related functionality is accessed through client.projects. For example:

from pyodk.client import Client

client = Client()
projects = client.projects.list()

create_app_users(display_names, forms=None, project_id=None)

Create new project app users and optionally assign forms to them.

Parameters:

Name Type Description Default
display_names Iterable[str]

The friendly nicknames of the app users to be created.

required
forms Iterable[str] | None

The xmlFormIds of the forms to assign the app users to.

None
project_id int | None

The id of the project this form belongs to.

None

get(project_id=None)

Read all Project details.

Parameters:

Name Type Description Default
project_id int | None

The id of the project to read.

None

Returns:

Type Description
Project

An object representation of the Project's metadata.

list()

Read Project details.

Returns:

Type Description
list[Project]

An list of object representations of the Projects' metadata.