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.2.6

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

Source distribution (sdist)

Source distribution for funread-api 1.2.6
File Size Uploaded Provenance
funread_api-1.2.6.tar.gz 104.2 kB Without provenance Details

Built distribution (wheel)

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

Total release size: 176.6 kB

Release files / funread_api-1.2.6.tar.gz

Download URL funread_api-1.2.6.tar.gz
Size 104.2 kB
Tags Source
SHA-256 checksum
How to use checksums
7976da1c9c3e6ddc4fa22bff66ad5d00b166cd7a2b855817ac129dcf7e98a23b
BLAKE2b-256 checksum
How to use checksums
10450e16089ac50db207e1c2ce74e71f3be5586043066e2d07c62233a66a64e1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.5

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

Download URL funread_api-1.2.6-py3-none-any.whl
Size 72.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ac8dd99ca3c145a4d385efd3527efd8f974fa2d547ee3aa2a7ea612184c16cb7
BLAKE2b-256 checksum
How to use checksums
7811a493f2c1504102d9f32f1323b2371507eaf641952120aa374be75f15b184
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.5

Security for funread-api 1.2.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

1.2.6 This release

2 release files No provenance

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