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

Documents auth in the guides, in the view API page, and also types the Blocks.config object #8720

Merged
merged 14 commits into from
Jul 9, 2024

Conversation

abidlabs
Copy link
Member

@abidlabs abidlabs commented Jul 8, 2024

This PR does a few different things:

  • In the Client Guides, it includes sections explaining how to connect to a Gradio app with auth
  • In the view API page, if you look at the sample code with the clients, it includes the auth parameter if the gradio app includes auth

Closes: #8700

  • It also adds typing for the Blocks.config attribute in the backend. I believe should be good to closes: [docs] document /config #2376, because (1) the information that the original user was asking for is already available in the /info route, in the .view_api() method, and in the view API page / docs. (2) in terms of documenting the /config route, I don't think it makes sense to add to our docs / guide, but now we at least have a well-defined typeddict that we point users to.

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Jul 8, 2024

🪼 branch checks and previews

Name Status URL
Spaces ready! Spaces preview
Website ready! Website preview
Storybook ready! Storybook preview
🦄 Changes detected! Details

Install Gradio from this PR

pip install https://gradio-builds.s3.amazonaws.com/597fea76a4ef69722fee193fa7e308817a91e9ad/gradio-4.37.2-py3-none-any.whl

Install Gradio Python Client from this PR

pip install "gradio-client @ git+https://github.com/gradio-app/gradio@597fea76a4ef69722fee193fa7e308817a91e9ad#subdirectory=client/python"

Install Gradio JS Client from this PR

npm install https://gradio-builds.s3.amazonaws.com/597fea76a4ef69722fee193fa7e308817a91e9ad/gradio-client-1.2.1.tgz

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Jul 8, 2024

🦄 change detected

This Pull Request includes changes to the following packages.

Package Version
@gradio/app patch
@gradio/client patch
gradio patch
  • Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

Documents auth in the guides, in the view API page, and also types the Blocks.config object

Maintainers or the PR author can modify the PR title to modify this entry.

Something isn't right?

  • Maintainers can change the version label to modify the version bump.
  • If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

@abidlabs abidlabs added the v: patch A change that requires a patch release label Jul 8, 2024
@abidlabs abidlabs changed the title Fixes auth and documents /config Documents auth in the guides, in the view API page, and also documents the Blocks.config object Jul 8, 2024
@abidlabs abidlabs changed the title Documents auth in the guides, in the view API page, and also documents the Blocks.config object Documents auth in the guides, in the view API page, and also documents the /config route Jul 8, 2024
@abidlabs abidlabs changed the title Documents auth in the guides, in the view API page, and also documents the /config route Documents auth in the guides, in the view API page, and also structures the Blocks.config object Jul 8, 2024
@abidlabs abidlabs changed the title Documents auth in the guides, in the view API page, and also structures the Blocks.config object Documents auth in the guides, in the view API page, and also types the Blocks.config object Jul 8, 2024
@abidlabs abidlabs marked this pull request as ready for review July 8, 2024 21:00
@abidlabs abidlabs requested a review from aliabd July 8, 2024 21:00
Copy link
Collaborator

@aliabd aliabd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good @abidlabs!

Though why so many # type: ignore ?

@abidlabs
Copy link
Member Author

abidlabs commented Jul 9, 2024

Thanks @aliabd! The type: ignore's are needed because we don't populate all of the keys of the BlocksConfig at once and so there are parts where the typing doesn't exactly match up. We can potentially refactor the code so that we have a valid BlocksConfig from the very beginning but I don't think its a huge priority

@abidlabs abidlabs merged commit 936c713 into main Jul 9, 2024
8 checks passed
@abidlabs abidlabs deleted the auth branch July 9, 2024 01:58
@pngwn pngwn mentioned this pull request Jul 8, 2024
dawoodkhan82 pushed a commit that referenced this pull request Jul 10, 2024
…e Blocks.config object (#8720)

* auth docs

* changes

* add changeset

* add changeset

* add changeset

* type

* changes

* snippets

* import

* add changeset

* changes

* fix typing

---------

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>
dawoodkhan82 added a commit that referenced this pull request Jul 11, 2024
* latex fix

* format

* add changeset

* fix demo (#8696)

* Better spacing for codeblocks on docs (#8686)

* styling for codeblocks

* add changeset

* formatting

* add changeset

* changes

---------

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>
Co-authored-by: Abubakar Abid <abubakar@huggingface.co>

* Add search to website (#8624)

* Update action.yml (#8702)

* Model3D point cloud and wireframe display modes (#8687)

* display modes

* add changeset

* test fixes

* lint

* Update gradio/components/model3d.py

Co-authored-by: Abubakar Abid <abubakar@huggingface.co>

* solid

---------

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>
Co-authored-by: Abubakar Abid <abubakar@huggingface.co>

* Fix playground to display errors (#8689)

* Fix the Playground on the website to trigger run_code() and install() with debounce and to display errors

* Remove an unused function, make_full_screen()

* Format demo/hello_world/run.py

* Update notebook

* add changeset

* add changeset

---------

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>

* GRADIO_ALLOWED_PATHS & GRADIO_BLOCKED_PATHS comma separated environme… (#8705)

* GRADIO_ALLOWED_PATHS & GRADIO_BLOCKED_PATHS comma separated environment variables

* GRADIO_ALLOWED_PATHS & GRADIO_BLOCKED_PATHS comma separated environment variables

* add changeset

* Document GRADIO_ALLOWED_PATHS and GRADIO_BLOCKED_PATHS

---------

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>
Co-authored-by: Abubakar Abid <abubakar@huggingface.co>

* Ensure JS client `status_callback` functionality works and improve status messages (#8699)

* * bind handle_space_success
* ensure status callbacks work correctly

* add changeset

* test fixes + refactor

* tweak

* test

* Revert "test"

This reverts commit db1afc4.

---------

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>

* Documents auth in the guides, in the view API page, and also types the Blocks.config object  (#8720)

* auth docs

* changes

* add changeset

* add changeset

* add changeset

* type

* changes

* snippets

* import

* add changeset

* changes

* fix typing

---------

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>

* remove on mount

* merge

* remove onmount

---------

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>
Co-authored-by: pngwn <hello@pngwn.io>
Co-authored-by: Ali Abdalla <ali.si3luwa@gmail.com>
Co-authored-by: Abubakar Abid <abubakar@huggingface.co>
Co-authored-by: Yuichiro Tachibana (Tsuchiya) <t.yic.yt@gmail.com>
Co-authored-by: cocktailpeanut <121128867+cocktailpeanut@users.noreply.github.com>
Co-authored-by: Hannah <hannahblair@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v: patch A change that requires a patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API Docs do not support auth [docs] document /config
3 participants