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.

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

docs: retrieve user by ID #5044

Closed
wants to merge 33 commits into from

Conversation

datapumpernickel
Copy link

Description

Retrieving a user by ID works only when passing in an ID of class UUID. This has been updated in the docs, as well as in the function examples and one error message of the users.py functions.

Closes #5011

  • Documentation update

How Has This Been Tested

Not tested yet.

Checklist

  • I added relevant documentation
  • I followed the style guidelines of this project
  • I did a self-review of my code
  • I made corresponding changes to the documentation
  • My changes generate no new warnings
  • I filled out the contributor form (see text above)
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

@datapumpernickel datapumpernickel changed the title Documentation update docs: retrieve user by ID Jun 18, 2024
@sdiazlor
Copy link
Contributor

Thanks @datapumpernickel, could you change the branch to main?

@datapumpernickel datapumpernickel changed the base branch from develop to main June 19, 2024 07:49
@davidberenstein1957 davidberenstein1957 changed the base branch from main to develop June 19, 2024 07:53
@davidberenstein1957
Copy link
Member

@datapumpernickel, would you be able to change the code so we can obtain users either by str or UUID?

@datapumpernickel datapumpernickel changed the base branch from develop to main June 19, 2024 07:55
@datapumpernickel datapumpernickel changed the base branch from main to develop June 19, 2024 07:56
@datapumpernickel
Copy link
Author

datapumpernickel commented Jun 19, 2024

Woopsie, I was trying to change this to the main branch and did not see your reply @davidberenstein1957 in the meantime. Sorry about the mess.
I could look at it, probably not this week, as I will be off until Mid-July. But then I can give it a try!

@davidberenstein1957
Copy link
Member

davidberenstein1957 commented Jun 19, 2024

Hi @datapumpernickel, no problem. Your contribution is great. I think it might be nicer for users to be able to pass either an id or UUID. @frascuchon @burtenshaw WDYT? Either way, Enjoy the holidays :)

@datapumpernickel
Copy link
Author

Definitely more convenient to be able to pass both -thanks for the hint. It actually seemed pretty straight forward, to I just put in a commit with a small change that checks if the ID is of instance uuid.UUID, if not, it tries to convert it to an instance of uuid.UUID. It returns an error if that fails for some reason.

@davidberenstein1957
Copy link
Member

@datapumpernickel , I realised this had become stale. Sorry for that. Would you be able to resolve the merge conflict? Also, I think the client.datasets and client.workspaces have similar methods that need to be tackled.

@davidberenstein1957 davidberenstein1957 added this to the v2.4.0 milestone Oct 17, 2024
frascuchon and others added 4 commits October 29, 2024 10:53
…rgilla-io#5644)

# Description

Following the discussion at
https://discord.com/channels/879548962464493619/1300627522135916604 we
have removed unnecessary exposed ports at our Docker compose file,
increasing the security.

**Type of change**

- Improvement (change adding some improvement to an existing
functionality)

**How Has This Been Tested**

- [x] Running docker compose manually.

**Checklist**

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
@frascuchon frascuchon modified the milestones: v2.4.0, v2.5.0 Oct 29, 2024
frascuchon and others added 21 commits October 29, 2024 13:32
…o#5647)

# Description
<!-- Please include a summary of the changes and the related issue.
Please also include relevant motivation and context. List any
dependencies that are required for this change. -->

This change will allow at least to run the frontend build pipeline.
Currently, we have no permissions to deploy on gcp from GitHub actions,
so the PR preview is not available.

cc @leiyre @damianpumar @Amelie-V @nataliaElv 

**Type of change**
<!-- Please delete options that are not relevant. Remember to title the
PR according to the type of change -->


**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
# Description
<!-- Please include a summary of the changes and the related issue.
Please also include relevant motivation and context. List any
dependencies that are required for this change. -->

Closes #<issue_number>

**Type of change**
<!-- Please delete options that are not relevant. Remember to title the
PR according to the type of change -->

- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- Refactor (change restructuring the codebase without changing
functionality)
- Improvement (change adding some improvement to an existing
functionality)
- Documentation update

**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
# Description

Adding some updates for our `CHANGELOG.md` for release `2.4.0`

**Type of change**

- Documentation update

**How Has This Been Tested**

- [x] Rendering markdowns 😄 

**Checklist**

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)

---------

Co-authored-by: Paco Aranda <[email protected]>
Co-authored-by: Francisco Aranda <[email protected]>
…file (argilla-io#5651)

# Description

Small improvement moving the install of some dependencies before
cleaning up.

**Type of change**

- Improvement (change adding some improvement to an existing
functionality)

**How Has This Been Tested**

- [ ] Deploying it to a new HF space.

**Checklist**

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
…not available (argilla-io#5654)

# Description

This should fix errors raised by our pre-commit actions when trying to
run `helm lint` and the `helm` command is not available.

I have tried to add `helm` as additional dependency for the `helmlint`
hook but is not possible so disabling it by now on CI. It is available
when running it locally and you have `helm` installed.

**Type of change**

- Improvement (change adding some improvement to an existing
functionality)

**How Has This Been Tested**

- [ ] GitHub Actions with pre-commit should now work as expected without
errors.

**Checklist**

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
# Description
<!-- Please include a summary of the changes and the related issue.
Please also include relevant motivation and context. List any
dependencies that are required for this change. -->

Closes #<issue_number>

**Type of change**
<!-- Please delete options that are not relevant. Remember to title the
PR according to the type of change -->

- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- Refactor (change restructuring the codebase without changing
functionality)
- Improvement (change adding some improvement to an existing
functionality)
- Documentation update

**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)

---------

Co-authored-by: Leire Aguirre <[email protected]>
Co-authored-by: José Francisco Calvo <[email protected]>
Co-authored-by: José Francisco Calvo <[email protected]>
Co-authored-by: Paco Aranda <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Damián Pumar <[email protected]>
Co-authored-by: Francisco Aranda <[email protected]>
Co-authored-by: burtenshaw <[email protected]>
@datapumpernickel
Copy link
Author

Hi @davidberenstein1957, sorry, I was not able to look at this in the past weeks. I just wanted to resolve the conflicts but upon testing it again, I realised that somehow this error has been patched:

This works now. 🎊 🚀

retrieved_user = client.users(id="0d05d426-294e-4524-b391-3d8db415537c")
retrieved_user

All the best for the upcoming release and thanks again!

@davidberenstein1957
Copy link
Member

@datapumpernickel, no problem. Thanks for the effort. Hope to be able to follow up a bit better with your next PR. Take care :)

@davidberenstein1957 davidberenstein1957 removed this from the v2.5.0 milestone Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] pulling user by ID does not work as specified in the docs
7 participants