Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to User client #451

Merged
merged 1 commit into from
Oct 18, 2023
Merged

Updates to User client #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/source/general_concepts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ The user authenticated to interact with the |company| platform.
The user has access to the resources and capabilities that are also available on the |platform|.
For a |platform| specific description of capabilities, please refer to the :xref:`docs_main_entry`.

> 👍 Tip
>For collaborative teams using our SDK, we recommend creating shared service accounts and creating SSH keys for those shared accounts. For example, to have several people create ontologies, datasets, and projects programatically, create an email account for use with Encord (for example, [email protected]) and generate an SSH for that email account.

Laverne-Encord marked this conversation as resolved.
Show resolved Hide resolved
Dataset
=======
The space where the data itself lives.
Expand Down
3 changes: 3 additions & 0 deletions docs/source/tutorials/projects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@ Users can be added to an existing project using their emails.
You can specify the role of the users being added using the :class:`.ProjectUserRole` enum.
You can find more details of the different roles in the :class:`doc-strings <.ProjectUserRole>`.

> 👍 Tip
>For collaborative teams using our SDK, we recommend creating shared service accounts and creating SSH keys for those shared accounts. For example, to have several people create ontologies, datasets, and projects programatically, create an email account for use with Encord (for example, [email protected]) and generate an SSH for that email account.

Below is an example of how to add two new annotators to the project.
Note how all users get assigned the same role.

Expand Down
4 changes: 2 additions & 2 deletions encord/user_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ def get_dataset(
self, dataset_hash: str, dataset_access_settings: DatasetAccessSettings = DEFAULT_DATASET_ACCESS_SETTINGS
) -> Dataset:
"""
Get the Project class to access project fields and manipulate a project.
Get the Dataset class to access dataset fields and manipulate a dataset.

You will only have access to this project if you are one of the following
You only have access to this project if you are one of the following

* Dataset admin

Expand Down