Skip to content

Commit

Permalink
Auto-translate README
Browse files Browse the repository at this point in the history
  • Loading branch information
Continuous Integration committed May 25, 2024
1 parent 15a6ec8 commit 603e017
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
当前地区当日额度已消耗完, 请尝试更换网络环境
37 changes: 37 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Autosink 项目的数据准备

[🇬🇧](README.md) | [🇰🇷](README.kr.md) | [🇨🇳](README.zh-CN.md)

环境是基于 MacOS、Linux。

## `Makefile`

`Makefile` 包含以下功能。

### `make lint`

- 若要使用 `.vscode` 设置,请安装 `pylint` 扩展。
- 通过覆盖 linter 的默认设置中在 `pyproject.toml` 文件中指定的选项来对代码进行 lint。

### `make format`

- 使用 google 的 `yapf` 作为格式化工具。
- 通过覆盖 `yapf` 格式化器的默认设置中在 `pyproject.toml` 文件中指定的选项来格式化代码。
- 若要使用 `.vscode` 设置,请安装 `yapf` 扩展。

### `make test`

- 使用 `unittest` 进行测试。
- 支持 `test_*.py``*_test.py` 模式。
- 测试文件必须通过 `__init__.py` 连接到测试文件所在的位置。

### `make publish`

- 请按以下格式编写 `~/.pypirc` 文件。
```
[pypi]
username = __token__
password = pypi-xxxxxx # 请获取个人 API 令牌并填写
```
- 运行此命令将使用 `flit` 将软件包推送到 PyPI 公共注册表。
- 通过之前指定的名称 `myproject`(别名),软件包将被上传,任何人都可以通过 `python3 -m pip install myproject` 安装并使用软件包。

0 comments on commit 603e017

Please sign in to comment.