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 .
1 maintainer
Metadata
1 maintainer
Release files for funread-api 1.1.114
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| funread_api-1.1.114-py3-none-any.whl | Python 3 | none | any | Details |
Release files / funread_api-1.1.114-py3-none-any.whl
| Download URL | funread_api-1.1.114-py3-none-any.whl |
|---|---|
| Size | 57.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c8059a9260266be749a5ce334c030eb756b6e4df68d66c1d67c9972b703525dd
|
|
BLAKE2b-256 checksum How to use checksums |
1594825696745c3bb4b4378d0c08955b221090c204eaf29e1c8963964c314196
|
| 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}
|
