Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 14 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
...

## [0.3.5] - 2025-11-09
### Added
- upath.implementations.cloud: add `HfPath` for Hugging Face Hub support (#457)
- docs: MkDocs documentation on Read The Docs (#468, #469)

### Fixed
- upath: fix `relative_to` for simplecache, smb, sftp and extensions (#458)

### Changed
- ci: nox and ci updates (#466)
- upath: update flavours (#467)

## [0.3.4] - 2025-10-16
### Added
- upath.implementations: add `SimpleCachePath` for simplecache protocol support (#453)
Expand Down Expand Up @@ -263,7 +275,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- started a changelog to keep track of significant changes

[Unreleased]: https://github.com/fsspec/universal_pathlib/compare/v0.3.4...HEAD
[Unreleased]: https://github.com/fsspec/universal_pathlib/compare/v0.3.5...HEAD
[0.3.5]: https://github.com/fsspec/universal_pathlib/compare/v0.3.4...v0.3.5
[0.3.4]: https://github.com/fsspec/universal_pathlib/compare/v0.3.3...v0.3.4
[0.3.3]: https://github.com/fsspec/universal_pathlib/compare/v0.3.2...v0.3.3
[0.3.2]: https://github.com/fsspec/universal_pathlib/compare/v0.3.1...v0.3.2
Expand Down
12 changes: 12 additions & 0 deletions docs/api/implementations.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,18 @@ Google Cloud Storage implementation.

Azure Blob Storage and Azure Data Lake implementation.

::: upath.implementations.cloud.HfPath
options:
heading_level: 3
show_root_heading: true
show_root_full_path: false
members: []
show_bases: true

**Protocols:** `hf://`

Hugging Face Hub implementation for accessing models, datasets, and spaces.

---

## upath.implementations.local
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ if http_path.exists():
- :fontawesome-solid-globe: `http:` and `https:` HTTP(S)-based filesystem
- :fontawesome-solid-server: `hdfs:` Hadoop distributed filesystem
- :fontawesome-brands-google: `gs:` and `gcs:` Google Cloud Storage _(requires `gcsfs`)_
- :simple-huggingface: `hf:` Hugging Face Hub _(requires `huggingface_hub`)_
- :fontawesome-brands-aws: `s3:` and `s3a:` AWS S3 _(requires `s3fs`)_
- :fontawesome-solid-network-wired: `sftp:` and `ssh:` SFTP and SSH filesystems _(requires `paramiko`)_
- :fontawesome-solid-share-nodes: `smb:` SMB filesystems _(requires `smbprotocol`)_
Expand Down
2 changes: 1 addition & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ When adding `universal-pathlib` to your project, specify the filesystem extras y
name = "myproject"
requires-python = ">=3.9"
dependencies = [
"universal_pathlib>=0.3.4",
"universal_pathlib>=0.3.5",
"fsspec[s3,http]", # Add the filesystems you need
]
```
Expand Down
4 changes: 4 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ gcs_path = UPath("gs://my-bucket/data.csv")
# Azure Blob Storage
az_path = UPath("az://container/blob.parquet")

# Hugging Face Hub
hf_path = UPath("hf://datasets/username/dataset-name/data.csv")

# GitHub repositories
gh_path = UPath("github://fsspec:universal_pathlib@main/")
```
Expand Down Expand Up @@ -253,6 +256,7 @@ Universal Pathlib works with any [fsspec](https://filesystem-spec.readthedocs.io
| `s3://` | Amazon S3 | `s3fs` |
| `gs://`, `gcs://` | Google Cloud Storage | `gcsfs` |
| `az://`, `abfs://` | Azure Blob Storage | `adlfs` |
| `hf://` | Hugging Face Hub | `huggingface_hub` |
| `github://` | GitHub | _(built-in)_ |
| `http://`, `https://` | HTTP(S) | _(built-in)_ |
| `ssh://`, `sftp://` | SSH/SFTP | `paramiko` |
Expand Down