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、多媒体与开发工具链等方向。

• 🏠 组织主页：https://github.com/farfarfun
• 📦 PyPI：https://pypi.org/user/niuliangtao/
• 📧 联系：farfarfun@qq.com

本项目基于 MIT 协议开源。