Skip to content

Commit 85a4fda

Browse files
committed
debug doc
1 parent 9942bfe commit 85a4fda

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

doc/index.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,34 @@
22

33
Aloha! Thanks for your interesting in this python package.
44

5-
[![License](https://img.shields.io/github/license/QPod/aloha)](https://github.com/QPod/aloha/blob/main/LICENSE)
6-
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/QPod/aloha/build)](https://github.com/QPod/aloha/actions)
5+
[![License](https://img.shields.io/github/license/QPod/aloha-python)](https://github.com/QPod/aloha-python/blob/main/LICENSE)
6+
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/QPod/aloha-python/build)](https://github.com/QPod/aloha-python/actions)
77
[![Join the Gitter Chat](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/QPod/)
88
[![PyPI version](https://img.shields.io/pypi/v/aloha)](https://pypi.python.org/pypi/aloha/)
99
[![PyPI Downloads](https://img.shields.io/pypi/dm/aloha)](https://pepy.tech/badge/aloha/)
10-
[![Code Activity](https://img.shields.io/github/commit-activity/m/QPod/aloha)](https://github.com/QPod/aloha/pulse)
11-
[![Recent Code Update](https://img.shields.io/github/last-commit/QPod/docker-images.svg)](https://github.com/QPod/aloha/stargazers)
10+
[![Code Activity](https://img.shields.io/github/commit-activity/m/QPod/aloha-python)](https://github.com/QPod/aloha-python/pulse)
11+
[![Recent Code Update](https://img.shields.io/github/last-commit/QPod/docker-images.svg)](https://github.com/QPod/aloha-python/stargazers)
1212

13-
Please generously STAR★ our project or donate to us! [![GitHub Starts](https://img.shields.io/github/stars/QPod/aloha.svg?label=Stars&style=social)](https://github.com/QPod/aloha/stargazers)
13+
Please generously STAR★ our project or donate to us! [![GitHub Starts](https://img.shields.io/github/stars/QPod/aloha-python.svg?label=Stars&style=social)](https://github.com/QPod/aloha-python/stargazers)
1414
[![Donate-PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://paypal.me/haobibo)
1515
[![Donate-AliPay](https://img.shields.io/badge/Donate-Alipay-blue.svg)](https://raw.githubusercontent.com/wiki/haobibo/resources/img/Donate-AliPay.png)
1616
[![Donate-WeChat](https://img.shields.io/badge/Donate-WeChat-green.svg)](https://raw.githubusercontent.com/wiki/haobibo/resources/img/Donate-WeChat.png)
1717

1818
## What is it?
19+
1920
The python package `aloha` is a cute and versatile to build python microservices.
2021
The package encapsulates commonly used components and features, such as:
2122

22-
2323
=== "English"
24+
2425
- Rapidly create RESTful APIs and start services
2526
- Logging utils
2627
- Manage different environments,configuration files, and resource files
2728
- Connect to popular databases
2829
- Detect and monitor application runtime environment
2930

3031
=== "中文"
32+
3133
`aloha`是一个用来快速构建微服务的Python包,它包含了创建微服务常用的组件和功能:
3234

3335
- 快速创建微服务的RESTful API并启动服务
@@ -38,35 +40,34 @@ The package encapsulates commonly used components and features, such as:
3840

3941
## Installation
4042

41-
``` title="It's easy to install aloha using the following command"
43+
```title="It's easy to install aloha using the following command"
4244
pip install aloha[all]
4345
```
4446

4547
Notice the `[all]` after the package is a set of (one or more) extra requirements, which enables additional features.
4648

4749
=== "English"
50+
4851
These extra requirements can include:
4952

5053
- `all`: everything below are included.
5154
- `service`: components/packages used to build RESTful APIs -- aloha use tornado to support services.
5255
- `build`: used to build python code into binary files, which is particularly useful to protect source code.
5356
- `db`: connect to popular databases, like MySQL / PostgreSQL / Redis.
54-
- `stream`: processing steram data using confluent_kafka.
57+
- `stream`: processing steram data using confluent_kafka.
5558
- `data`: processing data or doing data science tasks using packages like pandas.
5659
- `report`: utilites to export data and report to Excel files.
5760
- `test`: unit test utilites.
5861
- `docs`: utilites used to build documentations.
5962

60-
61-
6263
=== "中文"
63-
请留意,上述安装命令中包名后的`[all]`是额外的安装依赖,这些额外的安装内容在使用某些模块的时候会用到。
64-
64+
65+
请留意,上述安装命令中包名后的`[all]`是额外的安装依赖,这些额外的安装内容在使用某些模块的时候会用到。
6566
- `all`: 包含了下面的所有的依赖包
6667
- `service`: 用于创建RESTful APIs的依赖,aloha基于torndao来构建服务;
6768
- `build`: 用于将Python代码编译为二进制包或类库,这对于需要进行源代码保护的场景十分有用;
6869
- `db`: 连接到常用的数据库,如MySQL、PostgreSQL、Redis等;
69-
- `stream`: 基于confluent_kafka进行流数据处理;
70+
- `stream`: 基于confluent_kafka进行流数据处理;
7071
- `data`: 使用pandas等package进行数据处理;
7172
- `report`: 将数据导出为Excel格式的报告;
7273
- `test`: 进行单元测试的功能;

0 commit comments

Comments
 (0)