Skip to main content

funread-api

funread 的后端服务,依赖 funread 核心库并对外暴露 API,供 funread-web 调用。搭配使用见 funread-dev。

Install and run

Install a released version with uv:

uv tool install funread-api

The named CLI owns the server lifecycle:

funread-api server start
funread-api server status
funread-api server stop
funread-api server run --port 18811
funread-api server restart

The server listens on 127.0.0.1:18811 by default. start writes its PID and log to .run/funread-api.pid and .run/funread-api.log below the current working directory; run keeps the process in the foreground. Visit /docs for the API documentation and /healthz for health checks.

For a repository checkout, scripts/setup.sh keeps installation separate from runtime:

scripts/setup.sh install-dev
scripts/setup.sh install-prod [version]
scripts/setup.sh publish
scripts/setup.sh start
scripts/setup.sh status

Runtime actions invoke only the installed funread-api CLI. The same CLI also provides upgrade [version], rollback <version>, and uninstall; the last action stops the managed service before removing the package.

Development

uv sync --extra dev
uv run pytest -q
uv run ruff check .

关于 farfarfun

farfarfun 是一个专注于实用工具库的开源组织, 涵盖云存储、数据处理、AI、多媒体与开发工具链等方向。

本项目基于 MIT 协议开源。

Metadata

Release files for funread-api 1.1.117

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for funread-api 1.1.117
File Interpreter ABI Platform
funread_api-1.1.117-py3-none-any.whl Python 3 none any Details

Release files / funread_api-1.1.117-py3-none-any.whl

Download URL funread_api-1.1.117-py3-none-any.whl
Size 61.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ca6be195812d158bfc364a8953084cdfb4ba1ca476074c3970f8e39a446237db
BLAKE2b-256 checksum
How to use checksums
aa891d4f2083ddb025dbfd189926fb6e5b97871c6ff1f38e98910ae8da6a4d5f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

1.1.121

1 release file

1.1.120

1 release file

1.1.119

1 release file

1.1.118

1 release file

This release

1.1.117 This release

1 release file

1.1.115

1 release file

1.1.114

1 release file

1.1.113

1 release file

1.1.112

1 release file

1.1.111

1 release file

1.1.110

1 release file

1.1.109

1 release file

1.1.108

1 release file

1.1.107

1 release file

1.1.106

1 release file

1.1.105

1 release file

0.1.2

1 release file

0.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page