diff --git a/README.md b/README.md index 7727bfb..136d4c8 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [![PyPI version](https://img.shields.io/pypi/v/aloha)](https://pypi.python.org/pypi/aloha/) [![PyPI Downloads](https://img.shields.io/pypi/dm/aloha)](https://pepy.tech/badge/aloha/) [![Code Activity](https://img.shields.io/github/commit-activity/m/LabNow-ai/aloha-python)](https://github.com/LabNow-ai/aloha-python/pulse) -[![Recent Code Update](https://img.shields.io/github/last-commit/LabNow-ai/docker-images.svg)](https://github.com/LabNow-ai/aloha-python/stargazers) +[![Recent Code Update](https://img.shields.io/github/last-commit/LabNow-ai/aloha-python.svg)](https://github.com/LabNow-ai/aloha-python/stargazers) Please generously STAR★ our project or donate to us! [![GitHub Starts](https://img.shields.io/github/stars/LabNow-ai/aloha-python.svg?label=Stars&style=social)](https://github.com/LabNow-ai/aloha-python/stargazers) diff --git a/doc/.readthedocs.yaml b/doc/.readthedocs.yaml index 4f09fd3..04cc1b1 100644 --- a/doc/.readthedocs.yaml +++ b/doc/.readthedocs.yaml @@ -2,16 +2,12 @@ # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details -# Required version: 2 -# Set the version of Python and other tools you might need build: os: ubuntu-lts-latest tools: python: "3" - # nodejs: "latest" - # apt_packages: [] jobs: pre_create_environment: - echo "Command run at 'pre_create_environment' step" @@ -21,9 +17,8 @@ build: mkdocs: configuration: ./doc/mkdocs.yml -# Optionally declare the Python requirements required to build your docs python: install: + - requirements: ./doc/requirements.txt - method: pip path: ./src - extra_requirements: [docs, base] diff --git a/doc/README-cli.md b/doc/README-cli.md deleted file mode 100644 index 14aaf47..0000000 --- a/doc/README-cli.md +++ /dev/null @@ -1,35 +0,0 @@ -# Common Tasks - -## Test if aloha is properly installed - -```bash -aloha info -``` - -This will display the package version information. - -## Start a function from the main function EntryPoint - -```bash -aloha start package_name.module_name -# e.g.: aloha start app_common.debug -``` - -Notice: this module_name **MUST** include a function named `main()`. - -## Compile Python Code into binary - -Sometime, you need to compile your python source code into binary libraries to protect your source code. - -Aloha helps you build your python source code into binary using `Cython`. You can run the following command to build your code. - -```bash -aloha compile --base=./app --dist=./build --keep='main.py' -``` - -The following options can be used: - -- `--base`: the root folder which includes source code to build -- `--dist`: (default='build') target folder for the binary code -- `--exclude`: a collection of files/folders to exclude (you can specify multiple excludes by using this option multiple times) -- `--keep`: source files keep as is and not converting to dynamic library (you can specify multiple excludes by using this option multiple times) diff --git a/doc/README-config.md b/doc/README-config.md deleted file mode 100644 index c22ef25..0000000 --- a/doc/README-config.md +++ /dev/null @@ -1,80 +0,0 @@ -# Configurations - -## OS Environment variables - -### `ENV_PROFILE` - -*default Value*: None (not defined). - -=== "English" - Define the environment profile the current process is running in, such as `DEV | STG | PRD`. - This is usually used to specify which config file to use as entrypoint configuration file from the `${DIR_CONFIG}` folder. - If this env variable is defined, `aloha` will firstly find `main-${ENV_PROFILE}` as the entry configuration file (use `main.conf` otherwise). - -=== "中文" - 指定环境类型(如 `DEV | STG | PRD`)，用于指定配置文件入口等、便于程序从配置中区分环境等。 - 如果指定了该变量，`aloha`读取配置文件时，会首先从`${DIR_CONFIG}`中，寻找文件`main-${ENV_PROFILE}.conf`作为入口配置文件，如果没有指定则默认查找`main.conf`。 - -### `ENTRYPOINT` - -*default Value*: None (not defined). - -=== "English" - Define the entrypoint **Python module** when using command script `aloha start` to start a service/process. - It's same to use `aloha start ${ENTRYPOINT}` to start the process. - - The specified **Python module MUST** contain a function named `main()`. - -=== "中文" - 指定服务启动的入口模块，效果相当于 `aloha start ${ENTRYPOINT}`。 - 该模块下必须有一个`main()`函数作为服务的入口函数。 - -### `APP_MODULE` - -*default Value*: `default`. - -=== "English" - Define the application module name, which will be set to config variable `APP_MODULE` and used as the prefix for LOG files. - -=== "中文" - 模块名称，该变量会在记录日志时用到——作为日志文件名前缀，该变量也可以通过配置文件中的配置项`APP_MODUEL`进行设置. - -### `DIR_LOG` - -*default Value*: `logs`. - -=== "English" - Define where the log files should be stored. - -=== "中文" - 用于配置日志文件所在的目录. - -### `DIR_RESOURCE` - -*default Value*: `resource` of the current working directory. - -=== "English" - Define the resource folder, which will be used as the root folder for `aloha.config.paths.get_resource_dir()` function. - -=== "中文" - 资源文件所在的文件夹路径，该目录将会被函数`aloha.config.paths.get_resource_dir()`作为根目录，便于程序访问资源文件。 - -### `DIR_CONFIG` - -*default Value*: `${DIR_RESOURCE}/config`. - -=== "English" - Define where to find configuration files. - -=== "中文" - 查找配置文件所在的文件夹路径。 - -### `FILES_CONFIG` - -*default Value*: `None` (not defined). - -=== "English" - Optional. Define a list of config files (separated by comma) that the package will use. - -=== "中文" - 用半角逗号`,`分隔的配置文件的列表，如果该变量存在，则变量`ENV_PROFILE`不起作用。 diff --git a/doc/README-get-start.md b/doc/README-get-start.md deleted file mode 100644 index f2cdcd9..0000000 --- a/doc/README-get-start.md +++ /dev/null @@ -1,13 +0,0 @@ -# Getting Started - -## Step 1. install the python package - -```title="Install aloha and all it's extra requirments" -pip install aloha[all] -``` - -## Step 2. Start your project based on the template - -You can refer to the `app` folder of the GitHub repo to start using `aloha` in your project: - -[:octicons-mark-github-16: Go to TemplateProject](https://github.com/LabNow-ai/aloha-python/tree/main/app){ .md-button } diff --git a/doc/en/README-cli.md b/doc/en/README-cli.md new file mode 100644 index 0000000..75f9d6d --- /dev/null +++ b/doc/en/README-cli.md @@ -0,0 +1,35 @@ +# Common Tasks + +## Test whether aloha is properly installed + +```bash +aloha info +``` + +This displays package version information. + +## Start a function from the main function entrypoint + +```bash +aloha start package_name.module_name +# e.g.: aloha start app_common.debug +``` + +Note: this `module_name` **must** include a function named `main()`. + +## Compile Python code into binary + +Sometimes you need to compile Python source code into binary libraries to protect source code. + +Aloha helps you build Python source code into binaries using `Cython`: + +```bash +aloha compile --base=./app --dist=./build --keep='main.py' +``` + +Available options: + +- `--base`: root folder that includes source code to build +- `--dist`: (default=`build`) target folder for binary code +- `--exclude`: files/folders to exclude (use multiple times for multiple paths) +- `--keep`: source files to keep as-is instead of converting to dynamic libraries (use multiple times) diff --git a/doc/en/README-config.md b/doc/en/README-config.md new file mode 100644 index 0000000..3c94b20 --- /dev/null +++ b/doc/en/README-config.md @@ -0,0 +1,52 @@ +# Configurations + +## OS environment variables + +### `ENV_PROFILE` + +*Default value*: `None` (not defined). + +Define the environment profile for the current process, such as `DEV | STG | PRD`. +This is usually used to decide which config file in `${DIR_CONFIG}` should be used as the entrypoint config. + +If this environment variable is defined, `aloha` will first search for `main-${ENV_PROFILE}.conf`; otherwise it uses `main.conf`. + +### `ENTRYPOINT` + +*Default value*: `None` (not defined). + +Define the entrypoint **Python module** when using `aloha start` to start a service/process. +It is equivalent to `aloha start ${ENTRYPOINT}`. + +The specified **Python module must** contain a `main()` function. + +### `APP_MODULE` + +*Default value*: `default`. + +Define the application module name. It is mapped to config variable `APP_MODULE` and used as the prefix for log files. + +### `DIR_LOG` + +*Default value*: `logs`. + +Define where log files are stored. + +### `DIR_RESOURCE` + +*Default value*: `resource` under the current working directory. + +Define the resource folder. It will be used as the root directory by `aloha.config.paths.get_resource_dir()`. + +### `DIR_CONFIG` + +*Default value*: `${DIR_RESOURCE}/config`. + +Define where to find configuration files. + +### `FILES_CONFIG` + +*Default value*: `None` (not defined). + +Optional. Define a comma-separated list of config files to load. +If this variable is set, `ENV_PROFILE` is ignored. diff --git a/doc/README-develop.md b/doc/en/README-develop.md similarity index 70% rename from doc/README-develop.md rename to doc/en/README-develop.md index c7239f9..8602233 100644 --- a/doc/README-develop.md +++ b/doc/en/README-develop.md @@ -1,9 +1,9 @@ # Development Docs -## Live debug on source code using docker +## Live debug source code with Docker ```bash -# Firstly, cd to the project root folder (which includes `src`) of the project, and then: +# First, cd to project root (which includes `src`), then run: docker run -it \ -v $(pwd):/root/app/ \ -w /root/app/src \ @@ -14,7 +14,7 @@ docker run -it \ python -m aloha.script.start app_common.debug ``` -## Build docker image +## Build Docker image ```bash source tool/tool.sh diff --git a/doc/en/README-get-start.md b/doc/en/README-get-start.md new file mode 100644 index 0000000..a635528 --- /dev/null +++ b/doc/en/README-get-start.md @@ -0,0 +1,13 @@ +# Getting Started + +## Step 1. Install the Python package + +```title="Install aloha with all extra requirements" +pip install aloha[all] +``` + +## Step 2. Start your project based on the template + +You can refer to the `app` folder in the GitHub repository to start using `aloha` in your project: + +[:octicons-mark-github-16: Go to Template Project](https://github.com/LabNow-ai/aloha-python/tree/main/app){ .md-button } diff --git a/doc/api.md b/doc/en/api.md similarity index 100% rename from doc/api.md rename to doc/en/api.md diff --git a/doc/en/index.md b/doc/en/index.md new file mode 100644 index 0000000..b23a294 --- /dev/null +++ b/doc/en/index.md @@ -0,0 +1,42 @@ +# Introduction + +Aloha! Thanks for your interest in this Python package. + +[![License](https://img.shields.io/github/license/LabNow-ai/aloha-python)](https://github.com/LabNow-ai/aloha-python/blob/main/LICENSE) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/LabNow-ai/aloha-python/build.yml?branch=main)](https://github.com/LabNow-ai/aloha-python/actions) +[![Join the Gitter Chat](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/LabNow-ai/) +[![PyPI version](https://img.shields.io/pypi/v/aloha)](https://pypi.python.org/pypi/aloha/) +[![PyPI Downloads](https://img.shields.io/pypi/dm/aloha)](https://pepy.tech/badge/aloha/) +[![Code Activity](https://img.shields.io/github/commit-activity/m/LabNow-ai/aloha-python)](https://github.com/LabNow-ai/aloha-python/pulse) +[![Recent Code Update](https://img.shields.io/github/last-commit/LabNow-ai/aloha-python.svg)](https://github.com/LabNow-ai/aloha-python/stargazers) + +Please generously STAR our project or donate to us! [![GitHub Stars](https://img.shields.io/github/stars/LabNow-ai/aloha-python.svg?label=Stars&style=social)](https://github.com/LabNow-ai/aloha-python/stargazers) + +The Python package `aloha` is a versatile toolkit for building Python microservices. +It encapsulates commonly used components and features, such as: + +- Rapidly creating RESTful APIs and starting services +- Logging utilities +- Managing environments, configuration files, and resource files +- Connecting to popular databases +- Detecting and monitoring runtime environments + +## Installation + +```title="Install aloha with extra requirements" +pip install aloha[all] +``` + +Notice that `[all]` after the package name is a set of extra requirements that enable additional features. + +These extras include: + +- `all`: includes everything listed below +- `service`: packages used to build RESTful APIs (`aloha` uses Tornado for services) +- `build`: compile Python code into binary files, useful for source code protection +- `db`: connect to popular databases, such as MySQL / PostgreSQL / Redis +- `stream`: process stream data using `confluent_kafka` +- `data`: process data or do data science tasks using packages like `pandas` +- `report`: export data and reports to Excel files +- `test`: unit test utilities +- `docs`: documentation build utilities diff --git a/doc/index.md b/doc/index.md deleted file mode 100644 index 1798134..0000000 --- a/doc/index.md +++ /dev/null @@ -1,70 +0,0 @@ -# Introduction - -Aloha! Thanks for your interesting in this python package. - -[![License](https://img.shields.io/github/license/LabNow-ai/aloha-python)](https://github.com/LabNow-ai/aloha-python/blob/main/LICENSE) -[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/LabNow-ai/aloha-python/build.yml?branch=main)](https://github.com/LabNow-ai/aloha-python/actions) -[![Join the Gitter Chat](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/LabNow-ai/) -[![PyPI version](https://img.shields.io/pypi/v/aloha)](https://pypi.python.org/pypi/aloha/) -[![PyPI Downloads](https://img.shields.io/pypi/dm/aloha)](https://pepy.tech/badge/aloha/) -[![Code Activity](https://img.shields.io/github/commit-activity/m/LabNow-ai/aloha-python)](https://github.com/LabNow-ai/aloha-python/pulse) -[![Recent Code Update](https://img.shields.io/github/last-commit/LabNow-ai/docker-images.svg)](https://github.com/LabNow-ai/aloha-python/stargazers) - -Please generously STAR★ our project or donate to us! [![GitHub Starts](https://img.shields.io/github/stars/LabNow-ai/aloha-python.svg?label=Stars&style=social)](https://github.com/LabNow-ai/aloha-python/stargazers) - -The python package `aloha` is a cute and versatile to build python microservices. -The package encapsulates commonly used components and features, such as: - -=== "English" - - - Rapidly create RESTful APIs and start services - - Logging utils - - Manage different environments,configuration files, and resource files - - Connect to popular databases - - Detect and monitor application runtime environment - -=== "中文" - - `aloha`是一个用来快速构建微服务的Python包，它包含了创建微服务常用的组件和功能： - - - 快速创建微服务的RESTful API并启动服务 - - 环境管理、配置文件管理、资源文件管理； - - 日志组件 - - 连接数据库 - - 对运行环境进行监测； - -## Installation - -```title="It's easy to install aloha using the following command" -pip install aloha[all] -``` - -Notice the `[all]` after the package is a set of (one or more) extra requirements, which enables additional features. - -=== "English" - - These extra requirements can include: - - - `all`: everything below are included. - - `service`: components/packages used to build RESTful APIs -- aloha use tornado to support services. - - `build`: used to build python code into binary files, which is particularly useful to protect source code. - - `db`: connect to popular databases, like MySQL / PostgreSQL / Redis. - - `stream`: processing steram data using confluent_kafka. - - `data`: processing data or doing data science tasks using packages like pandas. - - `report`: utilites to export data and report to Excel files. - - `test`: unit test utilites. - - `docs`: utilites used to build documentations. - -=== "中文" - - 请留意，上述安装命令中包名后的`[all]`是额外的安装依赖，这些额外的安装内容在使用某些模块的时候会用到。 - - - `all`: 包含了下面的所有的依赖包 - - `service`: 用于创建RESTful APIs的依赖，aloha基于torndao来构建服务； - - `build`: 用于将Python代码编译为二进制包或类库，这对于需要进行源代码保护的场景十分有用； - - `db`: 连接到常用的数据库，如MySQL、PostgreSQL、Redis等； - - `stream`: 基于confluent_kafka进行流数据处理； - - `data`: 使用pandas等package进行数据处理； - - `report`: 将数据导出为Excel格式的报告； - - `test`: 进行单元测试的功能； - - `docs`: 用于进行文档构建的功能模块。 diff --git a/doc/mkdocs.yml b/doc/mkdocs.yml index beca0a2..d2cf6c5 100644 --- a/doc/mkdocs.yml +++ b/doc/mkdocs.yml @@ -30,6 +30,25 @@ theme: name: Switch to light mode plugins: - search + - i18n: + docs_structure: folder + reconfigure_material: true + languages: + - locale: en + name: English + default: true + build: true + - locale: zh + name: 简体中文 + build: true + nav_translations: + zh: + Introduction: 介绍 + Get Started: 快速开始 + CLI Commands: CLI 命令 + Configs: 配置说明 + Development Guide: 开发文档 + API Reference: API 参考 - mkdocstrings: handlers: # See: https://mkdocstrings.github.io/python/usage/ python: diff --git a/doc/requirements.txt b/doc/requirements.txt index b0be5a1..162fc8b 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -36,6 +36,7 @@ pytest-cov # docs mkdocs +mkdocs-static-i18n mkdocstrings[python] markdown-include mkdocs-material diff --git a/doc/zh/README-cli.md b/doc/zh/README-cli.md new file mode 100644 index 0000000..8663559 --- /dev/null +++ b/doc/zh/README-cli.md @@ -0,0 +1,35 @@ +# 常用任务 + +## 检查 aloha 是否安装成功 + +```bash +aloha info +``` + +该命令会输出包版本等信息。 + +## 从主入口函数启动模块 + +```bash +aloha start package_name.module_name +# 例如: aloha start app_common.debug +``` + +注意：`module_name` **必须**包含名为 `main()` 的函数。 + +## 将 Python 代码编译为二进制 + +在某些场景下，你可能需要把 Python 源码编译为二进制库，以保护源码。 + +Aloha 支持通过 `Cython` 进行构建： + +```bash +aloha compile --base=./app --dist=./build --keep='main.py' +``` + +可用参数： + +- `--base`：待构建源码的根目录 +- `--dist`：二进制产物目录（默认值为 `build`） +- `--exclude`：需要排除的文件/目录（可多次传入） +- `--keep`：保留为源码、不转为动态库的文件（可多次传入） diff --git a/doc/zh/README-config.md b/doc/zh/README-config.md new file mode 100644 index 0000000..15446ea --- /dev/null +++ b/doc/zh/README-config.md @@ -0,0 +1,52 @@ +# 配置说明 + +## 操作系统环境变量 + +### `ENV_PROFILE` + +*默认值*：`None`（未定义）。 + +用于指定当前进程运行环境，例如 `DEV | STG | PRD`。 +通常用于决定 `${DIR_CONFIG}` 下哪个配置文件作为入口配置。 + +如果该变量已定义，`aloha` 会优先查找 `main-${ENV_PROFILE}.conf`；否则使用 `main.conf`。 + +### `ENTRYPOINT` + +*默认值*：`None`（未定义）。 + +使用 `aloha start` 启动服务/进程时，指定入口 **Python 模块**。 +它等价于执行 `aloha start ${ENTRYPOINT}`。 + +指定的 **Python 模块必须**包含 `main()` 函数。 + +### `APP_MODULE` + +*默认值*：`default`。 + +用于定义应用模块名。该值会映射到配置项 `APP_MODULE`，并作为日志文件名前缀。 + +### `DIR_LOG` + +*默认值*：`logs`。 + +用于定义日志文件存储目录。 + +### `DIR_RESOURCE` + +*默认值*：当前工作目录下的 `resource`。 + +用于定义资源目录。该目录会作为 `aloha.config.paths.get_resource_dir()` 的根目录。 + +### `DIR_CONFIG` + +*默认值*：`${DIR_RESOURCE}/config`。 + +用于定义配置文件目录。 + +### `FILES_CONFIG` + +*默认值*：`None`（未定义）。 + +可选项。用于定义以英文逗号分隔的配置文件列表。 +如果该变量存在，则会忽略 `ENV_PROFILE`。 diff --git a/doc/zh/README-develop.md b/doc/zh/README-develop.md new file mode 100644 index 0000000..1d114f0 --- /dev/null +++ b/doc/zh/README-develop.md @@ -0,0 +1,28 @@ +# 开发文档 + +## 使用 Docker 对源码进行实时调试 + +```bash +# 先进入项目根目录（该目录包含 `src`），然后执行： +docker run -it \ + -v $(pwd):/root/app/ \ + -w /root/app/src \ + --name="app-$(whoami)" \ + -p 8080:80 \ + quay.io/labnow/base:latest bash + +python -m aloha.script.start app_common.debug +``` + +## 构建 Docker 镜像 + +```bash +source tool/tool.sh +build_image app_common latest tool/app.Dockerfile +``` + +## 开发文档 + +```bash +mkdocs serve -f mkdocs.yml -a 0.0.0.0:80 +``` diff --git a/doc/zh/README-get-start.md b/doc/zh/README-get-start.md new file mode 100644 index 0000000..c6b9c07 --- /dev/null +++ b/doc/zh/README-get-start.md @@ -0,0 +1,13 @@ +# 快速开始 + +## 第一步：安装 Python 包 + +```title="安装 aloha 及全部扩展依赖" +pip install aloha[all] +``` + +## 第二步：基于模板启动项目 + +你可以参考 GitHub 仓库中的 `app` 目录，在自己的项目中开始使用 `aloha`： + +[:octicons-mark-github-16: 前往模板项目](https://github.com/LabNow-ai/aloha-python/tree/main/app){ .md-button } diff --git a/doc/zh/api.md b/doc/zh/api.md new file mode 100644 index 0000000..db64ea8 --- /dev/null +++ b/doc/zh/api.md @@ -0,0 +1,5 @@ +# API 参考 + +待补充。 + +::: aloha diff --git a/doc/zh/index.md b/doc/zh/index.md new file mode 100644 index 0000000..18f57c8 --- /dev/null +++ b/doc/zh/index.md @@ -0,0 +1,41 @@ +# 介绍 + +Aloha！感谢你关注这个 Python 包。 + +[![License](https://img.shields.io/github/license/LabNow-ai/aloha-python)](https://github.com/LabNow-ai/aloha-python/blob/main/LICENSE) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/LabNow-ai/aloha-python/build.yml?branch=main)](https://github.com/LabNow-ai/aloha-python/actions) +[![Join the Gitter Chat](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/LabNow-ai/) +[![PyPI version](https://img.shields.io/pypi/v/aloha)](https://pypi.python.org/pypi/aloha/) +[![PyPI Downloads](https://img.shields.io/pypi/dm/aloha)](https://pepy.tech/badge/aloha/) +[![Code Activity](https://img.shields.io/github/commit-activity/m/LabNow-ai/aloha-python)](https://github.com/LabNow-ai/aloha-python/pulse) +[![Recent Code Update](https://img.shields.io/github/last-commit/LabNow-ai/aloha-python.svg)](https://github.com/LabNow-ai/aloha-python/stargazers) + +如果这个项目对你有帮助，欢迎给我们点一个 STAR，或支持我们的开发工作！[![GitHub Stars](https://img.shields.io/github/stars/LabNow-ai/aloha-python.svg?label=Stars&style=social)](https://github.com/LabNow-ai/aloha-python/stargazers) + +`aloha` 是一个用于构建 Python 微服务的通用工具包，封装了常见组件与能力，例如： + +- 快速创建 RESTful API 并启动服务 +- 日志工具 +- 环境、配置文件与资源文件管理 +- 连接常见数据库 +- 运行环境检测与监控 + +## 安装 + +```title="安装 aloha 及扩展依赖" +pip install aloha[all] +``` + +请注意，包名后的 `[all]` 表示额外依赖集合，用于启用更多能力。 + +可选扩展包括： + +- `all`：包含下面所有扩展 +- `service`：构建 RESTful API 所需依赖（`aloha` 基于 Tornado） +- `build`：将 Python 代码编译为二进制文件，便于源码保护 +- `db`：连接常见数据库，如 MySQL / PostgreSQL / Redis +- `stream`：基于 `confluent_kafka` 处理流式数据 +- `data`：使用 `pandas` 等库进行数据处理或数据科学任务 +- `report`：将数据或报告导出为 Excel 文件 +- `test`：单元测试工具 +- `docs`：文档构建工具 diff --git a/src/README.md b/src/README.md index 1f4892b..4f4839b 100644 --- a/src/README.md +++ b/src/README.md @@ -10,7 +10,7 @@ [![PyPI version](https://img.shields.io/pypi/v/aloha)](https://pypi.python.org/pypi/aloha/) [![PyPI Downloads](https://img.shields.io/pypi/dm/aloha)](https://pepy.tech/badge/aloha/) [![Code Activity](https://img.shields.io/github/commit-activity/m/LabNow-ai/aloha-python)](https://github.com/LabNow-ai/aloha-python/pulse) -[![Recent Code Update](https://img.shields.io/github/last-commit/LabNow-ai/docker-images.svg)](https://github.com/LabNow-ai/aloha-python/stargazers) +[![Recent Code Update](https://img.shields.io/github/last-commit/LabNow-ai/aloha-python.svg)](https://github.com/LabNow-ai/aloha-python/stargazers) Please generously STAR★ our project or donate to us! [![GitHub Starts](https://img.shields.io/github/stars/LabNow-ai/aloha-python.svg?label=Stars&style=social)](https://github.com/LabNow-ai/aloha-python/stargazers) diff --git a/src/setup.py b/src/setup.py index bc966a0..0201493 100644 --- a/src/setup.py +++ b/src/setup.py @@ -19,7 +19,7 @@ "data": ["pandas"], "report": ["openpyxl", "XlsxWriter"], "test": ["pytest-cov"], - "docs": ["mkdocs", "mkdocstrings[python]", "markdown-include", "mkdocs-material"], + "docs": ["mkdocs", "mkdocs-static-i18n", "mkdocstrings[python]", "markdown-include", "mkdocs-material"], } setup(