Skip to content

Conversation

@hanouticelina
Copy link
Contributor

@hanouticelina hanouticelina commented Sep 19, 2025

Resolves #3373
This PR adds cross-platform installers for the CLI so MacOS/Linux/Windows users can install hf CLI with a single command. a new workflow is also introduced running both installers on Ubuntu and Windows to make sure it works correctly.
Key features (subject to change):

  • --force: optional reinstall flag to wipe and rebuild the virtualenv for a clean recovery.
  • --version: install a specific huggingface_hub release instead of latest (default).
  • -v/--verbose: verbose mode surfacing full pip output for debugging.
  • env variable support letting users tune pip behavior without rewriting the script.
  • post-install verification that runs hf immediately to confirm it’s callable.
  • Uninstall instructions printed at the end for easy cleanup. (maybe not useful?)

TODO

  • Update all docs to highlight the new cross platform installer commands.

Notes

  • Both files are expected to be served from https://hf.co/install.sh and https://hf.co/install.ps1.
  • both scripts are based on an initial version here (private) and fixed with the help of GPT-5 (especially for the windows one!).
  • No strong opinion on where to put them in the repo 😄

Usage

(with temporary GH links)

### macOS / Linux
curl -LsSf https://raw.githubusercontent.com/huggingface/huggingface_hub/e5b3d11d4e868172e7f299b7d4cfcfe531219bc4/utils/installers/install.sh | sh

# Force reinstall:
curl -LsSf https://raw.githubusercontent.com/huggingface/huggingface_hub/e5b3d11d4e868172e7f299b7d4cfcfe531219bc4/utils/installers/install.sh | sh -s -- --force

### Windows (PowerShell 5+ or pwsh)
powershell -NoProfile -ExecutionPolicy Bypass -Command "irm https://raw.githubusercontent.com/huggingface/huggingface_hub/
  e5b3d11d4e868172e7f299b7d4cfcfe531219bc4/utils/installers/install.ps1 | iex"

# Force reinstall:
powershell -NoProfile -ExecutionPolicy Bypass -Command "irm https://raw.githubusercontent.com/huggingface/huggingface_hub/
  e5b3d11d4e868172e7f299b7d4cfcfe531219bc4/utils/installers/install.ps1 | iex -force"

Wauplin and others added 19 commits September 10, 2025 15:29
* first httpx integration

* more migration

* some fixes

* download workflow should work

* Fix repocard and error utils tests

* fix hf-file-system

* gix http utils tests

* more fixes

* fix some inference tests

* fix test_file_download tests

* async inference client

* async code should be good

* Define RemoteEntryFileNotFound explicitly (+some fixes)

* fix async code quality

* torch ok

* fix hf_file_system

* fix errors tests

* mock

* fix test_cli mock

* fix commit scheduler

* add fileno test

* no more requests anywhere

* fix test_file_download

* tmp requests

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/hf_file_system.py

Co-authored-by: célina <hanouticelina@gmail.com>

* not async

* fix tests

---------

Co-authored-by: célina <hanouticelina@gmail.com>
* Bump minimal version to Python3.9

* use built-in generics

* code quality

* new batch

* yet another btach

* fix dataclass_with_extra

* fix

* keep Type for strict dataclasses

* fix test
* Remove HfFolder

* Remove InferenceAPI

* more recent gradio

* bump pytest

* fix python 3.9?

* install gradio only on python 3.10+

* fix tests

* fix tests

* fix
* remove constants.-hf_cache_home

* remove smoothly_deprecate_use_auth_token

* remove get_token_permission

* remove update_repo_visibility

* remove is_write_action arg

* remove write_permission arg from login methods

* new parameter skip_if_logged_in in login methods

* Remove resume_download / force_filename parameters

* Remove deprecated local_dir_use_symlinks parameter

* Remove deprecated language, library, task, tags from list_models

* Return commit URL in upload_file/upload_folder (previously url to file/folder on the Hub)

* fix upload_file/upload_folder tests

* smoothly_deprecate_legacy_arguments everywhere

* code quality

* fix tests

* fix xet tests
* Remove Repository class + adapt docs

* remove fr git_vs_http
* Remove imports kept only for backward compatibility

* fix tests
* Remove keras2 utilities

* remove keras from init
* Remove anything tensorflow-related + deps

* init

* fix tests

* fix conflicts in tests
* HTTP configuration docs

* http configuration docs

* refactored git_vs_http

* fix import

* fix docs?

* Update docs/source/en/package_reference/utilities.md

Co-authored-by: célina <hanouticelina@gmail.com>

---------

Co-authored-by: célina <hanouticelina@gmail.com>
* Refactor CLI implementation using Typer (#3365)

* migrate CLI to typer

* (#3364) disable rich in all cases

* update tests

* make typer-slim a required dep

* use Annotated

* fix linting issues

* fix tests

* refactoring

* update docs

* use built in types

* fix mypy

* call whoami directly

* lint

* Apply suggestions from code review

Co-authored-by: Lucain <lucain@huggingface.co>

* import Annotated from typing

* Use Enums

* set verbosity globally

* refactor scan cache and update version docstring

* centralize where Typer is defined

* no need for ...

* rename enum

* no need for extra param name

* docstring

* revert

* centralize arguments and options definition

* add library version when initializing HfApi

* add auto-completion

* sort commands alphabetically

* suggestions

* centralize jobs params and HfApi initialization

* fix

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* update docs

---------

Co-authored-by: Lucain <lucain@huggingface.co>
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

hanouticelina and others added 9 commits September 19, 2025 18:16
* first httpx integration

* more migration

* some fixes

* download workflow should work

* Fix repocard and error utils tests

* fix hf-file-system

* gix http utils tests

* more fixes

* fix some inference tests

* fix test_file_download tests

* async inference client

* async code should be good

* Define RemoteEntryFileNotFound explicitly (+some fixes)

* fix async code quality

* torch ok

* fix hf_file_system

* fix errors tests

* mock

* fix test_cli mock

* fix commit scheduler

* add fileno test

* no more requests anywhere

* fix test_file_download

* tmp requests

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/hf_file_system.py

Co-authored-by: célina <hanouticelina@gmail.com>

* not async

* fix tests

---------

Co-authored-by: célina <hanouticelina@gmail.com>
Wauplin and others added 10 commits September 24, 2025 15:19
* Remove imports kept only for backward compatibility

* fix tests
* Remove keras2 utilities

* remove keras from init
* Remove anything tensorflow-related + deps

* init

* fix tests

* fix conflicts in tests
* HTTP configuration docs

* http configuration docs

* refactored git_vs_http

* fix import

* fix docs?

* Update docs/source/en/package_reference/utilities.md

Co-authored-by: célina <hanouticelina@gmail.com>

---------

Co-authored-by: célina <hanouticelina@gmail.com>
* Refactor CLI implementation using Typer (#3365)

* migrate CLI to typer

* (#3364) disable rich in all cases

* update tests

* make typer-slim a required dep

* use Annotated

* fix linting issues

* fix tests

* refactoring

* update docs

* use built in types

* fix mypy

* call whoami directly

* lint

* Apply suggestions from code review

Co-authored-by: Lucain <lucain@huggingface.co>

* import Annotated from typing

* Use Enums

* set verbosity globally

* refactor scan cache and update version docstring

* centralize where Typer is defined

* no need for ...

* rename enum

* no need for extra param name

* docstring

* revert

* centralize arguments and options definition

* add library version when initializing HfApi

* add auto-completion

* sort commands alphabetically

* suggestions

* centralize jobs params and HfApi initialization

* fix

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* update docs

---------

Co-authored-by: Lucain <lucain@huggingface.co>
Copy link
Contributor

@Wauplin Wauplin left a comment

Choose a reason for hiding this comment

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

Left a few minor comments but unix installer looks good to me 👍

About powershell, let's ask copilot opinion 😄 (it seems to work in the CI but definitely not familiar here)

@Wauplin Wauplin requested a review from Copilot September 25, 2025 16:24
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds cross-platform CLI installers for the Hugging Face CLI, allowing users on macOS, Linux, and Windows to install the hf CLI with a single command. The installers create isolated virtual environments and provide comprehensive configuration options.

  • Bash script for macOS/Linux with automatic shell detection and PATH management
  • PowerShell script for Windows with user PATH integration
  • GitHub Actions workflow to validate both installers on Ubuntu and Windows

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 14 comments.

File Description
utils/installers/install.sh Cross-platform bash installer with virtual environment management, PATH updates, and comprehensive logging
utils/installers/install.ps1 Windows PowerShell installer with similar functionality adapted for Windows environment
.github/workflows/check-installers.yml CI workflow to test both installers automatically on push and PR

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@hanouticelina hanouticelina merged commit 21edca8 into v1.0-release Sep 29, 2025
20 checks passed
@hanouticelina hanouticelina deleted the cli-installer branch September 29, 2025 12:45
hanouticelina added a commit that referenced this pull request Oct 14, 2025
* [1.0] Httpx migration (#3328)

* first httpx integration

* more migration

* some fixes

* download workflow should work

* Fix repocard and error utils tests

* fix hf-file-system

* gix http utils tests

* more fixes

* fix some inference tests

* fix test_file_download tests

* async inference client

* async code should be good

* Define RemoteEntryFileNotFound explicitly (+some fixes)

* fix async code quality

* torch ok

* fix hf_file_system

* fix errors tests

* mock

* fix test_cli mock

* fix commit scheduler

* add fileno test

* no more requests anywhere

* fix test_file_download

* tmp requests

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/hf_file_system.py

Co-authored-by: célina <hanouticelina@gmail.com>

* not async

* fix tests

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Bump minimal version to Python3.9 (#3343)

* Bump minimal version to Python3.9

* use built-in generics

* code quality

* new batch

* yet another btach

* fix dataclass_with_extra

* fix

* keep Type for strict dataclasses

* fix test

* Remove `HfFolder` and `InferenceAPI` classes (#3344)

* Remove HfFolder

* Remove InferenceAPI

* more recent gradio

* bump pytest

* fix python 3.9?

* install gradio only on python 3.10+

* fix tests

* fix tests

* fix

* [v1.0] Remove more deprecated stuff (#3345)

* remove constants.-hf_cache_home

* remove smoothly_deprecate_use_auth_token

* remove get_token_permission

* remove update_repo_visibility

* remove is_write_action arg

* remove write_permission arg from login methods

* new parameter skip_if_logged_in in login methods

* Remove resume_download / force_filename parameters

* Remove deprecated local_dir_use_symlinks parameter

* Remove deprecated language, library, task, tags from list_models

* Return commit URL in upload_file/upload_folder (previously url to file/folder on the Hub)

* fix upload_file/upload_folder tests

* smoothly_deprecate_legacy_arguments everywhere

* code quality

* fix tests

* fix xet tests

* [v1.0] Remove `Repository` class (#3346)

* Remove Repository class + adapt docs

* remove fr git_vs_http

* bump to 1.0.0.dev0

* Remove _deprecate_positional_args on login methods (#3349)

* [v1.0] Remove imports kept only for backward compatibility (#3350)

* Remove imports kept only for backward compatibility

* fix tests

* [v1.0] Remove keras2 utilities (#3352)

* Remove keras2 utilities

* remove keras from init

* [v1.0] Remove anything tensorflow-related + deps (#3354)

* Remove anything tensorflow-related + deps

* init

* fix tests

* fix conflicts in tests

* Release: v1.0.0.rc0

* [v1.0] Update "HTTP backend" docs + `git_vs_http` guide (#3357)

* HTTP configuration docs

* http configuration docs

* refactored git_vs_http

* fix import

* fix docs?

* Update docs/source/en/package_reference/utilities.md

Co-authored-by: célina <hanouticelina@gmail.com>

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Refactor CLI implementation using Typer (#3372)

* Refactor CLI implementation using Typer (#3365)

* migrate CLI to typer

* (#3364) disable rich in all cases

* update tests

* make typer-slim a required dep

* use Annotated

* fix linting issues

* fix tests

* refactoring

* update docs

* use built in types

* fix mypy

* call whoami directly

* lint

* Apply suggestions from code review

Co-authored-by: Lucain <lucain@huggingface.co>

* import Annotated from typing

* Use Enums

* set verbosity globally

* refactor scan cache and update version docstring

* centralize where Typer is defined

* no need for ...

* rename enum

* no need for extra param name

* docstring

* revert

* centralize arguments and options definition

* add library version when initializing HfApi

* add auto-completion

* sort commands alphabetically

* suggestions

* centralize jobs params and HfApi initialization

* fix

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* update docs

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* add installers

* fix windows

* fix log

* fix workflow?

* fix workflow again

* add debugging steps

* fix

* remove bin dir and install dir params

* update workflow

* remove version param

* document usage

* [1.0] Httpx migration (#3328)

* first httpx integration

* more migration

* some fixes

* download workflow should work

* Fix repocard and error utils tests

* fix hf-file-system

* gix http utils tests

* more fixes

* fix some inference tests

* fix test_file_download tests

* async inference client

* async code should be good

* Define RemoteEntryFileNotFound explicitly (+some fixes)

* fix async code quality

* torch ok

* fix hf_file_system

* fix errors tests

* mock

* fix test_cli mock

* fix commit scheduler

* add fileno test

* no more requests anywhere

* fix test_file_download

* tmp requests

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/hf_file_system.py

Co-authored-by: célina <hanouticelina@gmail.com>

* not async

* fix tests

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Bump minimal version to Python3.9 (#3343)

* Bump minimal version to Python3.9

* use built-in generics

* code quality

* new batch

* yet another btach

* fix dataclass_with_extra

* fix

* keep Type for strict dataclasses

* fix test

* Remove `HfFolder` and `InferenceAPI` classes (#3344)

* Remove HfFolder

* Remove InferenceAPI

* more recent gradio

* bump pytest

* fix python 3.9?

* install gradio only on python 3.10+

* fix tests

* fix tests

* fix

* [v1.0] Remove more deprecated stuff (#3345)

* remove constants.-hf_cache_home

* remove smoothly_deprecate_use_auth_token

* remove get_token_permission

* remove update_repo_visibility

* remove is_write_action arg

* remove write_permission arg from login methods

* new parameter skip_if_logged_in in login methods

* Remove resume_download / force_filename parameters

* Remove deprecated local_dir_use_symlinks parameter

* Remove deprecated language, library, task, tags from list_models

* Return commit URL in upload_file/upload_folder (previously url to file/folder on the Hub)

* fix upload_file/upload_folder tests

* smoothly_deprecate_legacy_arguments everywhere

* code quality

* fix tests

* fix xet tests

* [v1.0] Remove `Repository` class (#3346)

* Remove Repository class + adapt docs

* remove fr git_vs_http

* bump to 1.0.0.dev0

* Remove _deprecate_positional_args on login methods (#3349)

* [v1.0] Remove imports kept only for backward compatibility (#3350)

* Remove imports kept only for backward compatibility

* fix tests

* [v1.0] Remove keras2 utilities (#3352)

* Remove keras2 utilities

* remove keras from init

* [v1.0] Remove anything tensorflow-related + deps (#3354)

* Remove anything tensorflow-related + deps

* init

* fix tests

* fix conflicts in tests

* Release: v1.0.0.rc0

* [v1.0] Update "HTTP backend" docs + `git_vs_http` guide (#3357)

* HTTP configuration docs

* http configuration docs

* refactored git_vs_http

* fix import

* fix docs?

* Update docs/source/en/package_reference/utilities.md

Co-authored-by: célina <hanouticelina@gmail.com>

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Refactor CLI implementation using Typer (#3372)

* Refactor CLI implementation using Typer (#3365)

* migrate CLI to typer

* (#3364) disable rich in all cases

* update tests

* make typer-slim a required dep

* use Annotated

* fix linting issues

* fix tests

* refactoring

* update docs

* use built in types

* fix mypy

* call whoami directly

* lint

* Apply suggestions from code review

Co-authored-by: Lucain <lucain@huggingface.co>

* import Annotated from typing

* Use Enums

* set verbosity globally

* refactor scan cache and update version docstring

* centralize where Typer is defined

* no need for ...

* rename enum

* no need for extra param name

* docstring

* revert

* centralize arguments and options definition

* add library version when initializing HfApi

* add auto-completion

* sort commands alphabetically

* suggestions

* centralize jobs params and HfApi initialization

* fix

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* update docs

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* Make HfHubHTTPError inherit from OSError (#3387)

* Release: v1.0.0.rc1

* print relevant message based on the linux distro

* better warning message

* log info instead of warning

* copilot suggestions

* Update utils/installers/install.sh

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* update docs

---------

Co-authored-by: Lucain <lucain@huggingface.co>
Co-authored-by: Lucain Pouget <lucainp@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Wauplin added a commit that referenced this pull request Oct 23, 2025
* [1.0] Httpx migration (#3328)

* first httpx integration

* more migration

* some fixes

* download workflow should work

* Fix repocard and error utils tests

* fix hf-file-system

* gix http utils tests

* more fixes

* fix some inference tests

* fix test_file_download tests

* async inference client

* async code should be good

* Define RemoteEntryFileNotFound explicitly (+some fixes)

* fix async code quality

* torch ok

* fix hf_file_system

* fix errors tests

* mock

* fix test_cli mock

* fix commit scheduler

* add fileno test

* no more requests anywhere

* fix test_file_download

* tmp requests

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/hf_file_system.py

Co-authored-by: célina <hanouticelina@gmail.com>

* not async

* fix tests

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Bump minimal version to Python3.9 (#3343)

* Bump minimal version to Python3.9

* use built-in generics

* code quality

* new batch

* yet another btach

* fix dataclass_with_extra

* fix

* keep Type for strict dataclasses

* fix test

* Remove `HfFolder` and `InferenceAPI` classes (#3344)

* Remove HfFolder

* Remove InferenceAPI

* more recent gradio

* bump pytest

* fix python 3.9?

* install gradio only on python 3.10+

* fix tests

* fix tests

* fix

* [v1.0] Remove more deprecated stuff (#3345)

* remove constants.-hf_cache_home

* remove smoothly_deprecate_use_auth_token

* remove get_token_permission

* remove update_repo_visibility

* remove is_write_action arg

* remove write_permission arg from login methods

* new parameter skip_if_logged_in in login methods

* Remove resume_download / force_filename parameters

* Remove deprecated local_dir_use_symlinks parameter

* Remove deprecated language, library, task, tags from list_models

* Return commit URL in upload_file/upload_folder (previously url to file/folder on the Hub)

* fix upload_file/upload_folder tests

* smoothly_deprecate_legacy_arguments everywhere

* code quality

* fix tests

* fix xet tests

* [v1.0] Remove `Repository` class (#3346)

* Remove Repository class + adapt docs

* remove fr git_vs_http

* bump to 1.0.0.dev0

* Remove _deprecate_positional_args on login methods (#3349)

* [v1.0] Remove imports kept only for backward compatibility (#3350)

* Remove imports kept only for backward compatibility

* fix tests

* [v1.0] Remove keras2 utilities (#3352)

* Remove keras2 utilities

* remove keras from init

* [v1.0] Remove anything tensorflow-related + deps (#3354)

* Remove anything tensorflow-related + deps

* init

* fix tests

* fix conflicts in tests

* Release: v1.0.0.rc0

* [v1.0] Update "HTTP backend" docs + `git_vs_http` guide (#3357)

* HTTP configuration docs

* http configuration docs

* refactored git_vs_http

* fix import

* fix docs?

* Update docs/source/en/package_reference/utilities.md

Co-authored-by: célina <hanouticelina@gmail.com>

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Refactor CLI implementation using Typer (#3372)

* Refactor CLI implementation using Typer (#3365)

* migrate CLI to typer

* (#3364) disable rich in all cases

* update tests

* make typer-slim a required dep

* use Annotated

* fix linting issues

* fix tests

* refactoring

* update docs

* use built in types

* fix mypy

* call whoami directly

* lint

* Apply suggestions from code review

Co-authored-by: Lucain <lucain@huggingface.co>

* import Annotated from typing

* Use Enums

* set verbosity globally

* refactor scan cache and update version docstring

* centralize where Typer is defined

* no need for ...

* rename enum

* no need for extra param name

* docstring

* revert

* centralize arguments and options definition

* add library version when initializing HfApi

* add auto-completion

* sort commands alphabetically

* suggestions

* centralize jobs params and HfApi initialization

* fix

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* update docs

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* Make HfHubHTTPError inherit from OSError (#3387)

* Release: v1.0.0.rc1

* Add new HF commands (#3384)

* [1.0] Httpx migration (#3328)

* first httpx integration

* more migration

* some fixes

* download workflow should work

* Fix repocard and error utils tests

* fix hf-file-system

* gix http utils tests

* more fixes

* fix some inference tests

* fix test_file_download tests

* async inference client

* async code should be good

* Define RemoteEntryFileNotFound explicitly (+some fixes)

* fix async code quality

* torch ok

* fix hf_file_system

* fix errors tests

* mock

* fix test_cli mock

* fix commit scheduler

* add fileno test

* no more requests anywhere

* fix test_file_download

* tmp requests

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/hf_file_system.py

Co-authored-by: célina <hanouticelina@gmail.com>

* not async

* fix tests

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Bump minimal version to Python3.9 (#3343)

* Bump minimal version to Python3.9

* use built-in generics

* code quality

* new batch

* yet another btach

* fix dataclass_with_extra

* fix

* keep Type for strict dataclasses

* fix test

* Remove `HfFolder` and `InferenceAPI` classes (#3344)

* Remove HfFolder

* Remove InferenceAPI

* more recent gradio

* bump pytest

* fix python 3.9?

* install gradio only on python 3.10+

* fix tests

* fix tests

* fix

* [v1.0] Remove more deprecated stuff (#3345)

* remove constants.-hf_cache_home

* remove smoothly_deprecate_use_auth_token

* remove get_token_permission

* remove update_repo_visibility

* remove is_write_action arg

* remove write_permission arg from login methods

* new parameter skip_if_logged_in in login methods

* Remove resume_download / force_filename parameters

* Remove deprecated local_dir_use_symlinks parameter

* Remove deprecated language, library, task, tags from list_models

* Return commit URL in upload_file/upload_folder (previously url to file/folder on the Hub)

* fix upload_file/upload_folder tests

* smoothly_deprecate_legacy_arguments everywhere

* code quality

* fix tests

* fix xet tests

* [v1.0] Remove `Repository` class (#3346)

* Remove Repository class + adapt docs

* remove fr git_vs_http

* bump to 1.0.0.dev0

* Remove _deprecate_positional_args on login methods (#3349)

* [v1.0] Remove imports kept only for backward compatibility (#3350)

* Remove imports kept only for backward compatibility

* fix tests

* [v1.0] Remove keras2 utilities (#3352)

* Remove keras2 utilities

* remove keras from init

* [v1.0] Remove anything tensorflow-related + deps (#3354)

* Remove anything tensorflow-related + deps

* init

* fix tests

* fix conflicts in tests

* Release: v1.0.0.rc0

* [v1.0] Update "HTTP backend" docs + `git_vs_http` guide (#3357)

* HTTP configuration docs

* http configuration docs

* refactored git_vs_http

* fix import

* fix docs?

* Update docs/source/en/package_reference/utilities.md

Co-authored-by: célina <hanouticelina@gmail.com>

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Refactor CLI implementation using Typer (#3372)

* Refactor CLI implementation using Typer (#3365)

* migrate CLI to typer

* (#3364) disable rich in all cases

* update tests

* make typer-slim a required dep

* use Annotated

* fix linting issues

* fix tests

* refactoring

* update docs

* use built in types

* fix mypy

* call whoami directly

* lint

* Apply suggestions from code review

Co-authored-by: Lucain <lucain@huggingface.co>

* import Annotated from typing

* Use Enums

* set verbosity globally

* refactor scan cache and update version docstring

* centralize where Typer is defined

* no need for ...

* rename enum

* no need for extra param name

* docstring

* revert

* centralize arguments and options definition

* add library version when initializing HfApi

* add auto-completion

* sort commands alphabetically

* suggestions

* centralize jobs params and HfApi initialization

* fix

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* update docs

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* add hf repo delete command

* add repo settings, repo move, repo branch commands

* fix test

* Apply suggestions from code review

Co-authored-by: Lucain <lucain@huggingface.co>

---------

Co-authored-by: Lucain <lucain@huggingface.co>
Co-authored-by: Lucain Pouget <lucainp@gmail.com>

* Release: v1.0.0.rc2

* Document new HF commands (#3393)

* add docs for new hf commands

* typo

* add cli examples in repository

* Add cross-platform CLI Installers (#3378)

* [1.0] Httpx migration (#3328)

* first httpx integration

* more migration

* some fixes

* download workflow should work

* Fix repocard and error utils tests

* fix hf-file-system

* gix http utils tests

* more fixes

* fix some inference tests

* fix test_file_download tests

* async inference client

* async code should be good

* Define RemoteEntryFileNotFound explicitly (+some fixes)

* fix async code quality

* torch ok

* fix hf_file_system

* fix errors tests

* mock

* fix test_cli mock

* fix commit scheduler

* add fileno test

* no more requests anywhere

* fix test_file_download

* tmp requests

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/hf_file_system.py

Co-authored-by: célina <hanouticelina@gmail.com>

* not async

* fix tests

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Bump minimal version to Python3.9 (#3343)

* Bump minimal version to Python3.9

* use built-in generics

* code quality

* new batch

* yet another btach

* fix dataclass_with_extra

* fix

* keep Type for strict dataclasses

* fix test

* Remove `HfFolder` and `InferenceAPI` classes (#3344)

* Remove HfFolder

* Remove InferenceAPI

* more recent gradio

* bump pytest

* fix python 3.9?

* install gradio only on python 3.10+

* fix tests

* fix tests

* fix

* [v1.0] Remove more deprecated stuff (#3345)

* remove constants.-hf_cache_home

* remove smoothly_deprecate_use_auth_token

* remove get_token_permission

* remove update_repo_visibility

* remove is_write_action arg

* remove write_permission arg from login methods

* new parameter skip_if_logged_in in login methods

* Remove resume_download / force_filename parameters

* Remove deprecated local_dir_use_symlinks parameter

* Remove deprecated language, library, task, tags from list_models

* Return commit URL in upload_file/upload_folder (previously url to file/folder on the Hub)

* fix upload_file/upload_folder tests

* smoothly_deprecate_legacy_arguments everywhere

* code quality

* fix tests

* fix xet tests

* [v1.0] Remove `Repository` class (#3346)

* Remove Repository class + adapt docs

* remove fr git_vs_http

* bump to 1.0.0.dev0

* Remove _deprecate_positional_args on login methods (#3349)

* [v1.0] Remove imports kept only for backward compatibility (#3350)

* Remove imports kept only for backward compatibility

* fix tests

* [v1.0] Remove keras2 utilities (#3352)

* Remove keras2 utilities

* remove keras from init

* [v1.0] Remove anything tensorflow-related + deps (#3354)

* Remove anything tensorflow-related + deps

* init

* fix tests

* fix conflicts in tests

* Release: v1.0.0.rc0

* [v1.0] Update "HTTP backend" docs + `git_vs_http` guide (#3357)

* HTTP configuration docs

* http configuration docs

* refactored git_vs_http

* fix import

* fix docs?

* Update docs/source/en/package_reference/utilities.md

Co-authored-by: célina <hanouticelina@gmail.com>

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Refactor CLI implementation using Typer (#3372)

* Refactor CLI implementation using Typer (#3365)

* migrate CLI to typer

* (#3364) disable rich in all cases

* update tests

* make typer-slim a required dep

* use Annotated

* fix linting issues

* fix tests

* refactoring

* update docs

* use built in types

* fix mypy

* call whoami directly

* lint

* Apply suggestions from code review

Co-authored-by: Lucain <lucain@huggingface.co>

* import Annotated from typing

* Use Enums

* set verbosity globally

* refactor scan cache and update version docstring

* centralize where Typer is defined

* no need for ...

* rename enum

* no need for extra param name

* docstring

* revert

* centralize arguments and options definition

* add library version when initializing HfApi

* add auto-completion

* sort commands alphabetically

* suggestions

* centralize jobs params and HfApi initialization

* fix

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* update docs

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* add installers

* fix windows

* fix log

* fix workflow?

* fix workflow again

* add debugging steps

* fix

* remove bin dir and install dir params

* update workflow

* remove version param

* document usage

* [1.0] Httpx migration (#3328)

* first httpx integration

* more migration

* some fixes

* download workflow should work

* Fix repocard and error utils tests

* fix hf-file-system

* gix http utils tests

* more fixes

* fix some inference tests

* fix test_file_download tests

* async inference client

* async code should be good

* Define RemoteEntryFileNotFound explicitly (+some fixes)

* fix async code quality

* torch ok

* fix hf_file_system

* fix errors tests

* mock

* fix test_cli mock

* fix commit scheduler

* add fileno test

* no more requests anywhere

* fix test_file_download

* tmp requests

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/hf_file_system.py

Co-authored-by: célina <hanouticelina@gmail.com>

* not async

* fix tests

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Bump minimal version to Python3.9 (#3343)

* Bump minimal version to Python3.9

* use built-in generics

* code quality

* new batch

* yet another btach

* fix dataclass_with_extra

* fix

* keep Type for strict dataclasses

* fix test

* Remove `HfFolder` and `InferenceAPI` classes (#3344)

* Remove HfFolder

* Remove InferenceAPI

* more recent gradio

* bump pytest

* fix python 3.9?

* install gradio only on python 3.10+

* fix tests

* fix tests

* fix

* [v1.0] Remove more deprecated stuff (#3345)

* remove constants.-hf_cache_home

* remove smoothly_deprecate_use_auth_token

* remove get_token_permission

* remove update_repo_visibility

* remove is_write_action arg

* remove write_permission arg from login methods

* new parameter skip_if_logged_in in login methods

* Remove resume_download / force_filename parameters

* Remove deprecated local_dir_use_symlinks parameter

* Remove deprecated language, library, task, tags from list_models

* Return commit URL in upload_file/upload_folder (previously url to file/folder on the Hub)

* fix upload_file/upload_folder tests

* smoothly_deprecate_legacy_arguments everywhere

* code quality

* fix tests

* fix xet tests

* [v1.0] Remove `Repository` class (#3346)

* Remove Repository class + adapt docs

* remove fr git_vs_http

* bump to 1.0.0.dev0

* Remove _deprecate_positional_args on login methods (#3349)

* [v1.0] Remove imports kept only for backward compatibility (#3350)

* Remove imports kept only for backward compatibility

* fix tests

* [v1.0] Remove keras2 utilities (#3352)

* Remove keras2 utilities

* remove keras from init

* [v1.0] Remove anything tensorflow-related + deps (#3354)

* Remove anything tensorflow-related + deps

* init

* fix tests

* fix conflicts in tests

* Release: v1.0.0.rc0

* [v1.0] Update "HTTP backend" docs + `git_vs_http` guide (#3357)

* HTTP configuration docs

* http configuration docs

* refactored git_vs_http

* fix import

* fix docs?

* Update docs/source/en/package_reference/utilities.md

Co-authored-by: célina <hanouticelina@gmail.com>

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Refactor CLI implementation using Typer (#3372)

* Refactor CLI implementation using Typer (#3365)

* migrate CLI to typer

* (#3364) disable rich in all cases

* update tests

* make typer-slim a required dep

* use Annotated

* fix linting issues

* fix tests

* refactoring

* update docs

* use built in types

* fix mypy

* call whoami directly

* lint

* Apply suggestions from code review

Co-authored-by: Lucain <lucain@huggingface.co>

* import Annotated from typing

* Use Enums

* set verbosity globally

* refactor scan cache and update version docstring

* centralize where Typer is defined

* no need for ...

* rename enum

* no need for extra param name

* docstring

* revert

* centralize arguments and options definition

* add library version when initializing HfApi

* add auto-completion

* sort commands alphabetically

* suggestions

* centralize jobs params and HfApi initialization

* fix

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* update docs

---------

Co-authored-by: Lucain <lucain@huggingface.co>

* Make HfHubHTTPError inherit from OSError (#3387)

* Release: v1.0.0.rc1

* print relevant message based on the linux distro

* better warning message

* log info instead of warning

* copilot suggestions

* Update utils/installers/install.sh

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* update docs

---------

Co-authored-by: Lucain <lucain@huggingface.co>
Co-authored-by: Lucain Pouget <lucainp@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* update installers paths (#3400)

* [v1.0] feat: add migration guide for v1.0 (#3360)

* [1.0] Httpx migration (#3328)

* first httpx integration

* more migration

* some fixes

* download workflow should work

* Fix repocard and error utils tests

* fix hf-file-system

* gix http utils tests

* more fixes

* fix some inference tests

* fix test_file_download tests

* async inference client

* async code should be good

* Define RemoteEntryFileNotFound explicitly (+some fixes)

* fix async code quality

* torch ok

* fix hf_file_system

* fix errors tests

* mock

* fix test_cli mock

* fix commit scheduler

* add fileno test

* no more requests anywhere

* fix test_file_download

* tmp requests

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/utils/_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

* Update src/huggingface_hub/hf_file_system.py

Co-authored-by: célina <hanouticelina@gmail.com>

* not async

* fix tests

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Bump minimal version to Python3.9 (#3343)

* Bump minimal version to Python3.9

* use built-in generics

* code quality

* new batch

* yet another btach

* fix dataclass_with_extra

* fix

* keep Type for strict dataclasses

* fix test

* Remove `HfFolder` and `InferenceAPI` classes (#3344)

* Remove HfFolder

* Remove InferenceAPI

* more recent gradio

* bump pytest

* fix python 3.9?

* install gradio only on python 3.10+

* fix tests

* fix tests

* fix

* [v1.0] Remove more deprecated stuff (#3345)

* remove constants.-hf_cache_home

* remove smoothly_deprecate_use_auth_token

* remove get_token_permission

* remove update_repo_visibility

* remove is_write_action arg

* remove write_permission arg from login methods

* new parameter skip_if_logged_in in login methods

* Remove resume_download / force_filename parameters

* Remove deprecated local_dir_use_symlinks parameter

* Remove deprecated language, library, task, tags from list_models

* Return commit URL in upload_file/upload_folder (previously url to file/folder on the Hub)

* fix upload_file/upload_folder tests

* smoothly_deprecate_legacy_arguments everywhere

* code quality

* fix tests

* fix xet tests

* [v1.0] Remove `Repository` class (#3346)

* Remove Repository class + adapt docs

* remove fr git_vs_http

* bump to 1.0.0.dev0

* Remove _deprecate_positional_args on login methods (#3349)

* [v1.0] Remove imports kept only for backward compatibility (#3350)

* Remove imports kept only for backward compatibility

* fix tests

* [v1.0] Remove keras2 utilities (#3352)

* Remove keras2 utilities

* remove keras from init

* [v1.0] Remove anything tensorflow-related + deps (#3354)

* Remove anything tensorflow-related + deps

* init

* fix tests

* fix conflicts in tests

* HTTP configuration docs

* http configuration docs

* refactored git_vs_http

* feat: add migration guide for v1.0

This commit adds a comprehensive migration guide for the v1.0 release of the `huggingface_hub` library. The guide is located at `docs/source/en/concepts/migration.md` and provides a detailed list of main changes and breaking changes, along with instructions on how to adapt to them.

The migration guide covers the following topics:
- HTTPX migration
- Python 3.9+ requirement
- Removal of deprecated features
- Removal of the `Repository`, `HfFolder`, and `InferenceApi` classes
- Removal of TensorFlow and Keras 2 integrations

This guide is intended to help users migrate their existing code to the new version of the library smoothly.

Fixes #3358

[Auto-generated by https://jules.google.com/]

* rewrite migration guide

* fix import

* fix docs?

* add why httpx section

* Update docs/source/en/concepts/migration.md

---------

Co-authored-by: Lucain <lucain@huggingface.co>
Co-authored-by: célina <hanouticelina@gmail.com>
Co-authored-by: Lucain Pouget <lucainp@gmail.com>
Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>

* prepare rc3

* Remove contrib test suite (#3403)

* Strict typed dict validator (#3408)

* Strict typed dict validator

* better type hint

* work with Required / NotREquired

* Make it work with Python 3.11

* correctly handle total=False

* fix python 3.9+

* fix python 3.9

* Implement dry run mode in download CLI (#3407)

* Implement dry run mode

* docs

* more docs

* quality

* quality

* fix cli test

* Apply suggestions from code review

Co-authored-by: célina <hanouticelina@gmail.com>

* fix test on widnwso

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Remove `huggingface-cli` entirely in favor of `hf` (#3404)

* Remove huggingface-cli entirely in favor of hf

* dup

* Fix proxy environment variables not used in v1.0 (#3412)

* Use EventHooks instead of custom Transport

* add test

* Update tests/test_utils_http.py

Co-authored-by: célina <hanouticelina@gmail.com>

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* reset

* Release: v1.0.0.rc3

* [hf CLI] check for updates and notify user (#3418)

* [hf CLI] check for updates and notify user

* no alpha or beta

* dirty check

* check once every 24h

* move ANSI / tabulate utils to their own module to avoid circular import issues

* do not touch installers CI

* Update src/huggingface_hub/cli/_cli_utils.py

Co-authored-by: célina <hanouticelina@gmail.com>

* docstring

* update powershell command

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* Fix forward ref validation if total false (#3423)

* Release: v1.0.0.rc4

* Print version only in CLI

* Disable rich in CLI (#3427)

* Fix async client hook (#3433)

* Release: v1.0.0.rc5

* Expose typer_factory publicly (#3435)

* Release: v1.0.0.rc6

* fix docstring parameter type (#3446)

* Fix `hf_raise_for_status` on async stream + tests (#3442)

* Fix hf_raise_for_status on async stream + tests

* use response hook

* [CLI] Revamp `hf cache`  (#3439)

* apply revamp-hf-cache on top of rebased v1.0-release

* remove binary prefixes (KIB, MIB, GIB, TIB, PIB)

* remove redundant negative check

* refactor helpers

* refactor helpers

* improve filter keys and error messages

* remove str fields

* raise value error if op not in dict

* tweak csv

* add cache summary after table printing

* fix parsing

* filtering

* nit

* remove unnecessary default value

* add docstring for helpers

* use typer.confirm

* refacto

* more docstring

* remove id filter

* review suggestions

* [CLI] Update cache CLI docs and migration guide (#3450)

* update docs and migration guide

* update

* add pipe examples

* update ko docs

* [InferenceClient] Server-side auto-routing for conversational task (#3448)

* Server-side auto-routing for conversational task

* no /auto in path

* [CLI] Remove `[cli]` extra (#3451)

* remove cli extra

* fix

* too fast

* reorder deps by alphabetical order

* Remove any hf-transfer related code (#3444)

* Remove any hf-transfer related code

* quality

* fix tests

* more docs removed

* inconsistency

* remove xet_enabled setting

* last doc review?

* Update docs/source/en/guides/upload.md

Co-authored-by: célina <hanouticelina@gmail.com>

* Update docs/source/en/guides/download.md

Co-authored-by: célina <hanouticelina@gmail.com>

* Update docs/source/en/package_reference/environment_variables.md

Co-authored-by: célina <hanouticelina@gmail.com>

* forgot one

* fix test

* unparallelize hf_transfer for now

* fix test

---------

Co-authored-by: célina <hanouticelina@gmail.com>

* fix stuff

* backward compatible cli tracking (v1.x) (#3459)

* backward compatible cli tracking

* fix test

* Add auto-generated CLI reference (#3462)

* Add auto-generated CLI reference

* add tip in CLI guide

* clearer message

* add verbsoe mode

* dummy guy

* fix encoding issues

* hf transfer migration guide

* instead

---------

Co-authored-by: célina <hanouticelina@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
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.

4 participants