hfsapi

English | 中文

Python API client for HFS (HTTP File Server): login, file listing, upload, config, and permissions.

Install

Global CLI (recommended) — install so the hfs command is available everywhere:

uv tool install hfsapi
# or (system / user level)
pip install hfsapi

As a project dependency (e.g. for import hfsapi in your code):

pip install hfsapi
# or in a uv-managed project
uv add hfsapi

From source:

uv sync
# or
pip install -e .

Quick start

from hfsapi import HFSClient, entry_size, entry_created, entry_modified

with HFSClient("http://127.0.0.1:8280", username="abct", password="abc123") as client:
    data = client.get_file_list(uri="/data")
    for e in data.get("list", []):
        print(e["n"], entry_size(e), entry_created(e), entry_modified(e))

    # Create folder (same as “New folder” in the web UI)
    client.create_folder("data", "myfolder")

    # Upload
    client.upload_file("data", b"content", filename="hello.txt", use_put=True)

CLI

After installing (e.g. uv tool install hfsapi or pip install hfsapi), the hfs command is available. Log in once to save credentials locally; all other commands then use them (or pass --base-url if not logged in).

hfs login --base-url http://127.0.0.1:8280 -u abct -p abc123
hfs list /data
hfs upload ./local.txt --folder data
hfs upload ./mydir --folder data   # folder: upload contents into --folder (rclone-style)
hfs upload ./file.txt -f data -u -p   # -u print link after upload (resolves server-renamed name), -p progress
hfs mkdir data/myfolder
hfs download data/foo.txt -o ./foo.txt
hfs delete data/foo.txt
hfs config get
hfs vfs
hfs info
hfs logout

Path or URL: For list, upload --folder, download, mkdir, and delete, you can pass either a path (e.g. data/foo.txt) or a full URL (e.g. http://127.0.0.1:8280/data/foo.txt). A URL is parsed to use that server and path for that command.

See hfs --help and hfs <command> --help for options.

Core API

Method / function	Description
HFSClient(base_url, username, password, timeout)	Client; use `with` or call `close()` when done.
login()	Establish session via URL params (alternative or complement to Basic auth).
get_file_list(uri, offset, limit, search, request_c_and_m)	Get directory listing, current user permissions, and entry metadata.
list_entries(uri, ...)	Returns only the `list` array from `get_file_list`.
upload_file(folder, file_content, filename, use_put, put_params, use_session_for_put)	Upload a file to the given folder.
upload_folder(parent_folder, local_path, on_file_progress, on_progress)	Recursively upload directory contents (rclone-style).
get_resource_url(path, human_readable) / get_uploaded_file_url(folder, filename, response)	Build URL for a path; resolve real filename after upload (e.g. when server renames).
create_folder(parent_folder, new_name, use_put)	Create a new folder under the parent (same as “New folder” in the web UI).
delete_file(folder, filename)	Delete a file under the given folder.
get_config(only, omit) / set_config(values)	Read/write HFS config; e.g. VFS and permissions.
get_vfs()	Get current VFS tree (including permission structure).
entry_size(e) / entry_created(e) / entry_modified(e) / entry_permissions(e)	Helpers for list entry metadata and permission abbreviations.

In list responses: n = name, s = size, c/m = created/modified time; can_archive, can_upload, can_delete, etc. indicate the current user’s permissions for that directory.

More details (permission mapping, testing, publishing, upload options and roots) in HELP.md.

Legal: DISCLAIMER.md — no warranty, no liability, use at your own risk.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hfsapi-0.1.10.tar.gz (27.8 kB view details)

Uploaded Feb 7, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

hfsapi-0.1.10-py3-none-any.whl (17.8 kB view details)

Uploaded Feb 7, 2026 Python 3

File details

Details for the file hfsapi-0.1.10.tar.gz.

File metadata

Download URL: hfsapi-0.1.10.tar.gz
Upload date: Feb 7, 2026
Size: 27.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hfsapi-0.1.10.tar.gz
Algorithm	Hash digest
SHA256	`54a13fa141466f80003cf81cac76451b5b81a8299e910c3c32ab16469412f5e0`
MD5	`8af7c74c45ffe27934ed6980a258c335`
BLAKE2b-256	`d933ff7124426624911ac470cefd714d31fa750e80cfe47bea327046c4bd53ef`

See more details on using hashes here.

Provenance

The following attestation bundles were made for hfsapi-0.1.10.tar.gz:

Publisher: publish.yml on xx025/hfsapi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: hfsapi-0.1.10.tar.gz
- Subject digest: 54a13fa141466f80003cf81cac76451b5b81a8299e910c3c32ab16469412f5e0
- Sigstore transparency entry: 925846998
- Sigstore integration time: Feb 7, 2026
Source repository:
- Permalink: xx025/hfsapi@5e65a39876346741c36a18b46340a68a2fd3d8a8
- Branch / Tag: refs/tags/v0.1.10
- Owner: https://github.com/xx025
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@5e65a39876346741c36a18b46340a68a2fd3d8a8
- Trigger Event: push