Server-side components of RuyiSDK.
It is preferred to configure ruyi-backend via environment variables,
as per cloud-native best practice. See the example .env file
for supported config keys and respective defaults.
Variable names are case-insensitive.
To run the project locally, you have to set up a virtual environment and install the runtime dependencies.
python -m venv ./.venv
. ./.venv/bin/activate
poetry install # in case poetry >= 2.0 is already availableThen just invoke fastapi at the project root:
fastapi run ruyi_backendFor optional access to the online staging environment, you may have to set up some kind of proxy and/or port forwarding. This is out of scope of this document.
There are also some convenience facilities provided for easier debugging:
scripts/ruyi-backend-mysql-main: equivalent tomariadbormysql(in that order) with the DSN configured in the environment.
We welcome contributions to RuyiSDK! Please see our contribution guidelines (中文) for details on how to get started.
Copyright © 2024-2025 Institute of Software, Chinese Academy of Sciences (ISCAS). All rights reserved.
ruyi-backend is licensed under the Apache 2.0 license.
The default build of ruyi-backend contains code licensed under the
Mozilla Public License 2.0.
You can get the respective project's sources from the project's official
website:
certifi: used unmodified
All trademarks referenced herein are property of their respective holders.