From 8a6fae71066581bce8a7068b0d29234aa04b0f33 Mon Sep 17 00:00:00 2001 From: K <51281148+K-dash@users.noreply.github.com> Date: Mon, 17 Jun 2024 13:13:42 +0900 Subject: [PATCH] Update the extras information in getting-started.md - Remove `numpy` from the list of additional packages needed for data formats. - Add `orjson` and `sqlalchemy` to the list of extras available with the `all` option. --- docs/en/getting-started.md | 6 ++++-- docs/ja/getting-started.md | 7 +++++-- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/en/getting-started.md b/docs/en/getting-started.md index f6f23abe..63cb2492 100644 --- a/docs/en/getting-started.md +++ b/docs/en/getting-started.md @@ -13,7 +13,7 @@ If you're using poetry, run this command. poetry add pyserde ``` -Additional data formats besides JSON and Pickle need additional dependencies installed. Install `msgpack`, `toml`, `yaml` or `numpy` extras to work with the appropriate data formats; you can skip formats that you don't plan to use. For example, if you want to use Toml and YAML: +Additional data formats besides JSON and Pickle need additional dependencies installed. Install `msgpack`, `toml` or `yaml` extras to work with the appropriate data formats; you can skip formats that you don't plan to use. For example, if you want to use Toml and YAML: ``` pip install "pyserde[toml,yaml]" @@ -36,12 +36,14 @@ poetry add pyserde -E all ``` Here are the available extras -* `all`: Install `msgpack`, `toml`, `yaml` and `numpy` extras +* `all`: Install `msgpack`, `toml`, `yaml`, `numpy`, `orjson`, and `sqlalchemy` extras * `msgpack`: Install [msgpack](https://github.com/msgpack/msgpack-python) * `toml`: Install [tomli](https://github.com/hukkin/tomli) and [tomli-w](https://github.com/hukkin/tomli-w) * NOTE: [tomllib](https://docs.python.org/3/library/tomllib.html) is used for python 3.11 onwards * `yaml`: Install [pyyaml](https://github.com/yaml/pyyaml) * `numpy`: Install [numpy](https://github.com/numpy/numpy) +* `orjson`: Install [orjson](https://github.com/ijl/orjson) +* `sqlalchemy`: Install [sqlalchemy](https://github.com/sqlalchemy/sqlalchemy) ## Define your first pyserde class diff --git a/docs/ja/getting-started.md b/docs/ja/getting-started.md index 288d4783..d411b7ee 100644 --- a/docs/ja/getting-started.md +++ b/docs/ja/getting-started.md @@ -14,7 +14,7 @@ poetry add pyserde ``` JSONとPickle以外のデータ形式を扱う場合は、追加の依存関係をインストールする必要があります。 -適切なデータ形式で動作するには、`msgpack`、`toml`、`yaml`、`numpy`の追加パッケージをインストールしてください。 +適切なデータ形式で動作するには、`msgpack`、`toml`、`yaml` の追加パッケージをインストールしてください。 使用しない場合はスキップして構いません。 例えば、TomlとYAMLを使用する場合は以下のようにします。 @@ -39,12 +39,15 @@ poetry add pyserde -E all ``` 利用可能な追加パッケージ -* `all`:`msgpack`、`toml`、`yaml`、`numpy`をインストール +* `all`:`msgpack`、`toml`、`yaml`、`numpy`、`orjson`、`sqlalchemy` をインストール * `msgpack`:[msgpack](https://github.com/msgpack/msgpack-python) をインストール * `toml`:[tomli](https://github.com/hukkin/tomli) と [tomli-w](https://github.com/hukkin/tomli-w) をインストール * 注記:python 3.11以降は [tomllib](https://docs.python.org/3/library/tomllib.html) を使用 * `yaml`:[pyyaml](https://github.com/yaml/pyyaml) をインストール * `numpy`:[numpy](https://github.com/numpy/numpy) をインストール +* `orjson`:[orjson](https://github.com/ijl/orjson) をインストール +* `sqlalchemy`:[sqlalchemy](https://github.com/sqlalchemy/sqlalchemy) をインストール + ## 最初のpyserdeクラスを定義