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 9176b3b commit 10ac402
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Data Validation for Autosink Project

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

The environment is based on MacOS, Linux.

## `Makefile`

The `Makefile` has the following functionalities.

### `make lint`

- To use the `.vscode` settings, install the `pylint` extension.
- Overrides options specified in the `pyproject.toml` file to lint the code based on the default settings of the linter.

### `make format`

- The formatter uses Google's `yapf`.
- Overrides options specified in the `pyproject.toml` file to format the code based on the default settings of the `yapf` formatter.
- To use the `.vscode` settings, install the `yapf` extension.

### `make test`

- Uses `unittest` for testing.
- Supports both `test_*.py` and `*_test.py` patterns.
- The test files must be connected to `__init__.py` up to the location where the test files exist.

### `make publish`

- Write the `~/.pypirc` file as follows:
```
[pypi]
username = __token__
password = pypi-something # Obtain and write your personal API token.
```
- Running this command will push the package to the PyPI public registry using `flit`.
- The package uploaded under the previously specified name `myproject` (alias) will be available for anyone worldwide to install and use with `python3 -m pip install myproject`.
1 change: 1 addition & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
当前地区当日额度已消耗完, 请尝试更换网络环境

0 comments on commit 10ac402

Please sign in to comment.