quant1x 0.3.0__tar.gz → 0.5.0__tar.gz

quant1x-0.5.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

quant1x-0.5.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: quant1x
+Version: 0.5.0
+Summary: Quant1X量化研究
+Home-page: https://gitee.com/quant1x/quant1x
+Author: WangFeng
+Author-email: wangfengxy@sina.cn
+License: Apache license
+Keywords: quant1x python
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: setuptools~=78.0.0
+Requires-Dist: twine~=6.1.0
+Requires-Dist: wheel~=0.45.1
+Requires-Dist: requests-toolbelt~=1.0.0
+Requires-Dist: loguru~=0.7.3
+Requires-Dist: icecream~=2.1.5
+Requires-Dist: PyYAML~=6.0.2
+Requires-Dist: numpy~=2.3.0
+Requires-Dist: pandas~=2.3.0
+Requires-Dist: gitpython~=3.1.44
+Requires-Dist: python-dateutil~=2.9.0.post0
+Requires-Dist: matplotlib~=3.10.5
+Requires-Dist: akshare~=1.17.38
+Requires-Dist: findpeaks~=2.7.4
+Requires-Dist: mootdx~=0.11.7
+Requires-Dist: numpy~=2.3.0
+Requires-Dist: pandas~=2.3.0
+Requires-Dist: python-dateutil~=2.9.0.post0
+Requires-Dist: requests==2.32.0
+Requires-Dist: tqdm~=4.67.1
+Requires-Dist: xgboost~=3.0.0
+Requires-Dist: scikit-learn~=1.7.1
+Requires-Dist: matplotlib~=3.10.1
+Requires-Dist: scipy~=1.16.0
+Requires-Dist: caerus~=0.1.10
+Requires-Dist: joblib~=1.5.1
+Requires-Dist: quant1x-base~=0.6.18
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+正确打开Quant1X项目的方式
+===
+
+# 1. 环境配置
+## 1.1 默认均为64位操作系统
+| python | golang |
+|:-------|:-------|
+| 3.12.x | 1.25.x |
+
+## 1.2 环境安装推荐使用brew
+安装brew时需要注意避免使用root权限 
+
+
+# 2. python
+
+python的运行环境可能存在多个版本冲突的问题，那么怎么来解决多版本的共存的问题呢？使用pyenv。
+
+## 2.1 安装pyenv
+```shell
+brew install pyenv
+```
+### 2.1.1 查看已安装的版本
+```shell
+pyenv versions
+```
+我的电脑返回以下版本信息
+```text
+  system
+  3.8.16
+* 3.10.10 (set by /Users/wangfeng/.pyenv/version)
+```
+### 2.1.2 查看可安装的版本
+```shell
+pyenv install -l
+```
+### 2.1.3 安装指定版本的python, 本文指定3.12.9或3.12.x更新版本
+```shell
+pyenv install 3.12.9
+```
+
+### 2.1.4 pip类库管理工具
+安装python完成之后, python类库管理工具pip已经默认安装完成了
+
+### 2.1.5 python基础工具
+
+| 工具  | 功能                           |
+|:----|:-----------------------------|
+| pip | 类似maven、gradle、go mod的类库管理工具 |
+| pip-autoremove| 自动删除类库所有依赖库                  |
+|pipreqs| 项目/类库交叉依赖检测                  |
+
+### 2.1.6 pip 源配置
+windows
+```shell
+cd ~\AppData\Roaming\pip
+notepad.exe pip.ini
+```
+*nix
+```shell
+cd ~/.pip
+vim pip.conf
+```
+输入以下内容
+```text
+[global]
+index-url = https://pypi.tuna.tsinghua.edu.cn/simple
+[install]
+trusted-host = https://pypi.tuna.tsinghua.edu.cn
+```
+
+## 2.2 依赖库
+python环境中依赖管理的配置文件为requirements.txt，类似java的maven pom.xml、golang的go.mod。
+
+### 2.2.1 安装项目依赖的库
+```shell
+pip install -r requirements.txt
+```
+
+### 2.2.2 检测项目依赖输出到requirements.txt
+```shell
+pip freeze > requirements.txt
+```
+
+### 2.2.3 交叉依赖
+
+```shell
+pip install pipreqs
+pipreqs ./ --encoding utf8
+```
+
+## 2.3 上传package到PyPi
+
+### 2.3.1 安装或更新setuptools、wheel、twine
+```shell
+pip install --upgrade setuptools wheel twine
+```
+
+### 2.3.2 打包并生成tar.gz和whl文件
+```shell
+python setup.py sdist bdist_wheel
+```
+
+### 2.3.3 上传package到PyPi的测试环境
+```shell
+twine upload --repository testpypi dist/*
+```
+
+### 2.3.4 上传package到PyPi的正式环境
+```shell
+twine upload dist/*
+```
+
+## 2.4 Matplotlib中文乱码问题解决方案
+
+### 2.4.1 编写如下代码，获取matplotlib包所在的配置文件的路径
+```python
+import matplotlib
+matplotlib.matplotlib_fname() #输出matplotlib包所在的配置文件的路径
+```
+
+### 2.4.2 根据上面的路径打开文件夹（根据自己实际的输出路径去操作）
+我选择了SimHei中文字体, 复制到fonts/ttf/目录下
+```shell
+cp -r /Users/wangfeng/Library/Fonts/SimHei.ttf fonts/ttf/
+```
+
+### 2.4.3 编辑2.4.1获得路径matplotlibrc文件
+#### 2.4.3.1 找到 #font.sans-serif，去掉前面的#，并在：后面写上在准备工作加入的中文字体的名称SimHei
+#### 2.4.3.2 找到#axes.unicode_minus，去掉前面的#，并在：改为False
+### 2.4.4 控制台切换到~/.matplotlib目录, 删除tex.cache文件和fontList.json文件
+```shell
+cd ~/.matplotlib
+rm -rf *
+```
+
+
+# 3. golang
+
+环境设定
+```shell
+go env -w GO111MODULE=on
+go env -w GOPROXY=https://goproxy.cn,direct
+go env -w GOPRIVATE=gitee.com
+```

quant1x-0.5.0/README.md

@@ -0,0 +1,144 @@
+正确打开Quant1X项目的方式
+===
+
+# 1. 环境配置
+## 1.1 默认均为64位操作系统
+| python | golang |
+|:-------|:-------|
+| 3.12.x | 1.25.x |
+
+## 1.2 环境安装推荐使用brew
+安装brew时需要注意避免使用root权限 
+
+
+# 2. python
+
+python的运行环境可能存在多个版本冲突的问题，那么怎么来解决多版本的共存的问题呢？使用pyenv。
+
+## 2.1 安装pyenv
+```shell
+brew install pyenv
+```
+### 2.1.1 查看已安装的版本
+```shell
+pyenv versions
+```
+我的电脑返回以下版本信息
+```text
+  system
+  3.8.16
+* 3.10.10 (set by /Users/wangfeng/.pyenv/version)
+```
+### 2.1.2 查看可安装的版本
+```shell
+pyenv install -l
+```
+### 2.1.3 安装指定版本的python, 本文指定3.12.9或3.12.x更新版本
+```shell
+pyenv install 3.12.9
+```
+
+### 2.1.4 pip类库管理工具
+安装python完成之后, python类库管理工具pip已经默认安装完成了
+
+### 2.1.5 python基础工具
+
+| 工具  | 功能                           |
+|:----|:-----------------------------|
+| pip | 类似maven、gradle、go mod的类库管理工具 |
+| pip-autoremove| 自动删除类库所有依赖库                  |
+|pipreqs| 项目/类库交叉依赖检测                  |
+
+### 2.1.6 pip 源配置
+windows
+```shell
+cd ~\AppData\Roaming\pip
+notepad.exe pip.ini
+```
+*nix
+```shell
+cd ~/.pip
+vim pip.conf
+```
+输入以下内容
+```text
+[global]
+index-url = https://pypi.tuna.tsinghua.edu.cn/simple
+[install]
+trusted-host = https://pypi.tuna.tsinghua.edu.cn
+```
+
+## 2.2 依赖库
+python环境中依赖管理的配置文件为requirements.txt，类似java的maven pom.xml、golang的go.mod。
+
+### 2.2.1 安装项目依赖的库
+```shell
+pip install -r requirements.txt
+```
+
+### 2.2.2 检测项目依赖输出到requirements.txt
+```shell
+pip freeze > requirements.txt
+```
+
+### 2.2.3 交叉依赖
+
+```shell
+pip install pipreqs
+pipreqs ./ --encoding utf8
+```
+
+## 2.3 上传package到PyPi
+
+### 2.3.1 安装或更新setuptools、wheel、twine
+```shell
+pip install --upgrade setuptools wheel twine
+```
+
+### 2.3.2 打包并生成tar.gz和whl文件
+```shell
+python setup.py sdist bdist_wheel
+```
+
+### 2.3.3 上传package到PyPi的测试环境
+```shell
+twine upload --repository testpypi dist/*
+```
+
+### 2.3.4 上传package到PyPi的正式环境
+```shell
+twine upload dist/*
+```
+
+## 2.4 Matplotlib中文乱码问题解决方案
+
+### 2.4.1 编写如下代码，获取matplotlib包所在的配置文件的路径
+```python
+import matplotlib
+matplotlib.matplotlib_fname() #输出matplotlib包所在的配置文件的路径
+```
+
+### 2.4.2 根据上面的路径打开文件夹（根据自己实际的输出路径去操作）
+我选择了SimHei中文字体, 复制到fonts/ttf/目录下
+```shell
+cp -r /Users/wangfeng/Library/Fonts/SimHei.ttf fonts/ttf/
+```
+
+### 2.4.3 编辑2.4.1获得路径matplotlibrc文件
+#### 2.4.3.1 找到 #font.sans-serif，去掉前面的#，并在：后面写上在准备工作加入的中文字体的名称SimHei
+#### 2.4.3.2 找到#axes.unicode_minus，去掉前面的#，并在：改为False
+### 2.4.4 控制台切换到~/.matplotlib目录, 删除tex.cache文件和fontList.json文件
+```shell
+cd ~/.matplotlib
+rm -rf *
+```
+
+
+# 3. golang
+
+环境设定
+```shell
+go env -w GO111MODULE=on
+go env -w GOPROXY=https://goproxy.cn,direct
+go env -w GOPRIVATE=gitee.com
+```

{quant1x-0.3.0 → quant1x-0.5.0}/quant1x/__init__.py

@@ -1,20 +1,20 @@
-#!/usr/bin/python
-# -*- coding: UTF-8 -*-
-
-"""
-89K 努力打造一个适度的量化交易框架
-"""
-
-__version__ = "0.3.0"
-__author__ = "WangFeng"
-
-import sys
-
-if sys.version_info < (3, 8):
-    print(f"Quant1X {__version__} requires Python 3.8+ and 64 bit OS")
-    sys.exit(1)
-del sys
-
-
-def init(**kwargs):
-    pass
+#!/usr/bin/python
+# -*- coding: UTF-8 -*-
+
+"""
+89K 努力打造一个适度的量化交易框架
+"""
+
+__version__ = "0.3.0"
+__author__ = "WangFeng"
+
+import sys
+
+if sys.version_info < (3, 8):
+    print(f"Quant1X {__version__} requires Python 3.8+ and 64 bit OS")
+    sys.exit(1)
+del sys
+
+
+def init(**kwargs):
+    pass

{quant1x-0.3.0 → quant1x-0.5.0}/quant1x/base/__init__.py

@@ -1,8 +1,8 @@
-#!/usr/bin/python
-# -*- coding: UTF-8 -*-
-
-"""
-基础工具集
-"""
-
+#!/usr/bin/python
+# -*- coding: UTF-8 -*-
+
+"""
+基础工具集
+"""
+
 from quant1x.base.series import Series