ruyi 0.39.0__py3-none-any.whl → 0.40.0__py3-none-any.whl

ruyi/version.py

@@ -51,7 +51,7 @@ RUYI_SEMVER: Final = _init_pkg_semver()
 RUYI_USER_AGENT: Final = f"ruyi/{RUYI_SEMVER}"
 
 COPYRIGHT_NOTICE: Final = """\
-Copyright (C) 2023 Institute of Software, Chinese Academy of Sciences (ISCAS).
+Copyright (C) Institute of Software, Chinese Academy of Sciences (ISCAS).
 All rights reserved.
 License: Apache-2.0 <https://www.apache.org/licenses/LICENSE-2.0>
 \

{ruyi-0.39.0.dist-info → ruyi-0.40.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ruyi
-Version: 0.39.0
+Version: 0.40.0
 Summary: Package manager for RuyiSDK
 License: Apache License
                                     Version 2.0, January 2004
@@ -241,33 +241,85 @@ Project-URL: github, https://github.com/ruyisdk/ruyi
 Project-URL: issues, https://github.com/ruyisdk/ruyi/issues
 Description-Content-Type: text/markdown
 
+<!-- markdownlint-capture -->
+<!-- markdownlint-disable MD033 MD041 -->
 <div align="center">
 <img alt="RuyiSDK Logo" src="resources/ruyi-logo-256.png" height="128" />
 <h3>Ruyi</h3>
-<p>The package manager for <a href="https://github.com/ruyisdk">RuyiSDK</a>.</p>
+<p>The package manager for <a href="https://ruyisdk.org/en/">RuyiSDK</a>.</p>
+<p><a href="https://ruyisdk.org/en/">Official website</a> |
+<a href="https://ruyisdk.cn">Developer community</a> |
+<a href="https://github.com/ruyisdk">Open-source</a></p>
 </div>
+<!-- markdownlint-restore -->
 
-![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ruyisdk/ruyi/dist.yml)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ruyisdk/ruyi/ci.yml)
 ![GitHub License](https://img.shields.io/github/license/ruyisdk/ruyi)
 ![Python Version](https://img.shields.io/badge/python-%3E%3D3.10-blue)
 ![GitHub Tag](https://img.shields.io/github/v/tag/ruyisdk/ruyi?label=latest%20tag)
+![PyPI - Version](https://img.shields.io/pypi/v/ruyi)
+![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/ruyisdk/ruyi/total?label=all%20github%20dl)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/ruyi?label=pypi%20dl)
 
-## Installation and usage
+🌍 English | [简体中文](./README.zh.md)
+
+## ⬇️ Installation
+
+`ruyi` is available in two forms: the PyPI package or the one-file binary
+distribution. Performance of various `ruyi` operations will be better with the
+PyPI installation, but the one-file distribution is a bit easier to set up
+because one doesn't have to first configure a Python environment. Either way,
+the feature set should be the same.
+
+### ✅ Recommended: Install from PyPI
+
+This is the recommended way to install `ruyi` on your machine. In any Python
+virtual environment, simply type:
+
+```sh
+pip install ruyi
+```
+
+Or the equivalent with any other Python package manager you prefer. After the
+installation completes, the `ruyi` command will then show up in the Python
+virtual environment's `bin` directory; if you have already activated the
+environment, you may now start using `ruyi`.
+
+### Alternative: Use the one-file distribution
 
 You can get pre-built binaries of `ruyi` from [GitHub Releases][ghr] or
-[the RuyiSDK mirror][mirror-testing] for easier testing.
+[the RuyiSDK mirror][mirror-iscas] for easier testing.
 Rename the downloaded file to `ruyi`, make it executable,
 put inside your `$PATH` and you're ready to go.
 
 [ghr]: https://github.com/ruyisdk/ruyi/releases
-[mirror-testing]: https://mirror.iscas.ac.cn/ruyisdk/ruyi/testing/
+[mirror-iscas]: https://mirror.iscas.ac.cn/ruyisdk/ruyi/tags/
+
+### Platform compatibility notes
+
+Because `ruyi` is written in platform-independent Python, you may be able to
+install `ruyi` on any system with a Python package manager. However, you may
+not be able to install binary packages from the official RuyiSDK Software Repository
+if you are on a system not listed on
+[RuyiSDK's platform support documentation][ruyisdk-plat-support-en]
+([中文][ruyisdk-plat-support-zh]), due to the packages being only built for the
+officially supported systems. You may be able to obtain community-provided
+support from [the RuyiSDK developer community][ruyisdk-community] in such cases.
+
+[ruyisdk-plat-support-en]: https://ruyisdk.org/en/docs/Other/platform-support/
+[ruyisdk-plat-support-zh]: https://ruyisdk.org/docs/Other/platform-support/
+[ruyisdk-community]: https://ruyisdk.cn/
 
-You can browse the documentation at [the dedicated RuyiSDK docs site][docs]
-(only available in Chinese right now).
+## 🖥️ Usage
 
-[docs]: https://ruyisdk.org/docs/intro
+You can browse our documentation at [the dedicated RuyiSDK docs site][docs-en]
+([中文][docs-zh]). In case you need any assistance, feel
+free to search and post on [our community forum][ruyisdk-community].
 
-## Configuration
+[docs-en]: https://ruyisdk.org/en/docs/intro/
+[docs-zh]: https://ruyisdk.org/docs/intro/
+
+## ⚙️ Configuration
 
 Various aspects of `ruyi` can be configured with files or environment variables.
 
@@ -337,7 +389,7 @@ Currently the following environment variables are supported by `ruyi`:
 For boolean variables, the values `1`, `true`, `x`, `y` or `yes` (all case-insensitive)
 are all treated as "true".
 
-### Telemetry
+## 📞 Telemetry
 
 The Ruyi package manager collects usage data in order to help us improve your
 experience. It is collected by the RuyiSDK team and shared with the community.
@@ -360,8 +412,8 @@ The upload will happen on a random weekday which is determined by the
 installation's anonymous ID alone.
 
 You can change the telemetry mode by editing `ruyi`'s config file, or simply
-by setting the `RUYI_TELEMETRY_OPTOUT` environment variable to any of the
-values accepted as truthy.
+disable telemetry altogether by setting the `RUYI_TELEMETRY_OPTOUT` environment
+variable to any of the values accepted as truthy.
 
 We collect the following information with `ruyi`:
 
@@ -381,13 +433,20 @@ We collect the following information with `ruyi`:
 
 You can see our Privacy Policy on the RuyiSDK website.
 
-## Contributing
+You can see [our Privacy Policy][privacy-policy-en] ([中文][privacy-policy-zh])
+on the RuyiSDK website.
+
+[privacy-policy-en]: https://ruyisdk.org/en/docs/legal/privacyPolicy/
+[privacy-policy-zh]: https://ruyisdk.org/docs/legal/privacyPolicy/
+
+## 🙋 Contributing
 
-We welcome contributions to Ruyi! Please see our [contribution guidelines](./CONTRIBUTING.md) ([中文](./CONTRIBUTING.zh.md)) for details on how to get started.
+We welcome contributions to RuyiSDK! Please see our [contribution guidelines](./CONTRIBUTING.md)
+([中文](./CONTRIBUTING.zh.md)) for details on how to get started.
 
-## License
+## ⚖️ License
 
-Copyright &copy; 2023-2024 Institute of Software, Chinese Academy of Sciences (ISCAS).
+Copyright &copy; Institute of Software, Chinese Academy of Sciences (ISCAS).
 All rights reserved.
 
 `ruyi` is licensed under the [Apache 2.0 license](./LICENSE-Apache.txt).

{ruyi-0.39.0.dist-info → ruyi-0.40.0.dist-info}/RECORD

@@ -93,9 +93,9 @@ ruyi/utils/templating.py,sha256=94xBJTkIfDqmUBTc9hnLO54zQoC7hwGWONGF3YbaqHk,966
 ruyi/utils/toml.py,sha256=ri97Ki0xhBwoDtrjngCc6hlPXuEsma1ShPFFuFMYqpA,3192
 ruyi/utils/url.py,sha256=Wyct6syS4GmZC6mY7SK-YgBWxKl3cOOBXtp9UtvGkto,186
 ruyi/utils/xdg_basedir.py,sha256=vd9p-JZru2DkXvt_W3gCS1_Wj4QkuftErI1MLPaBiz4,2478
-ruyi/version.py,sha256=P_4CSkRKyv8S28dZ5iPhLa0Po-L_K4OY8FP-1SOnl80,2147
-ruyi-0.39.0.dist-info/LICENSE-Apache.txt,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-ruyi-0.39.0.dist-info/METADATA,sha256=QwEOSGcKAK2Ndxb82IHmkqwk_s19v-XA01zL17n2d-g,21093
-ruyi-0.39.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-ruyi-0.39.0.dist-info/entry_points.txt,sha256=GXSNSy7OgFrnlU5xm5dE3l3PGO92Qf6VDIUCdvQNm8E,49
-ruyi-0.39.0.dist-info/RECORD,,
+ruyi/version.py,sha256=KLJkvKexU07mu-GVDbYKsQvReRvwlVFYkRmcvnyfQNY,2142
+ruyi-0.40.0.dist-info/LICENSE-Apache.txt,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+ruyi-0.40.0.dist-info/METADATA,sha256=9UsnuC7RFQHxk_dtnU9YRkiITp7OFIJdUya8rA1i1Uw,23764
+ruyi-0.40.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+ruyi-0.40.0.dist-info/entry_points.txt,sha256=GXSNSy7OgFrnlU5xm5dE3l3PGO92Qf6VDIUCdvQNm8E,49
+ruyi-0.40.0.dist-info/RECORD,,