Metadata-Version: 2.1
Name: myz_tools
Version: 0.1.9
Summary: Python helper tools
Home-page: https://pypi.org/project/myz_tools/
Author: 宇千思
Author-email: 
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiocontextvars==0.2.2
Requires-Dist: alabaster==0.7.16
Requires-Dist: anyio==4.4.0
Requires-Dist: astroid==3.2.4
Requires-Dist: asttokens==2.4.1
Requires-Dist: atomicwrites==1.4.1
Requires-Dist: babel==2.16.0
Requires-Dist: beautifulsoup4==4.12.3
Requires-Dist: bs4==0.0.2
Requires-Dist: certifi==2024.7.4
Requires-Dist: chardet==5.2.0
Requires-Dist: charset-normalizer==3.3.2
Requires-Dist: colorama==0.4.6
Requires-Dist: commonmark==0.9.1
Requires-Dist: contextvars==2.4
Requires-Dist: DataProperty==1.0.1
Requires-Dist: decorator==5.1.1
Requires-Dist: dill==0.3.8
Requires-Dist: distlib==0.3.8
Requires-Dist: docutils==0.21.2
Requires-Dist: dominate==2.9.1
Requires-Dist: exceptiongroup==1.2.2
Requires-Dist: executing==2.0.1
Requires-Dist: filelock==3.15.4
Requires-Dist: graphviz==0.20.3
Requires-Dist: h11==0.14.0
Requires-Dist: httpcore==1.0.5
Requires-Dist: httpx==0.27.0
Requires-Dist: idna==3.7
Requires-Dist: imagesize==1.4.1
Requires-Dist: immutables==0.20
Requires-Dist: importlib_metadata==8.2.0
Requires-Dist: ipython==8.18.1
Requires-Dist: isort==5.13.2
Requires-Dist: jedi==0.19.1
Requires-Dist: Jinja2==3.1.4
Requires-Dist: jsonpickle==3.2.2
Requires-Dist: loguru==0.5.3
Requires-Dist: MarkupSafe==2.1.5
Requires-Dist: matplotlib-inline==0.1.7
Requires-Dist: mbstrdecoder==1.1.3
Requires-Dist: mccabe==0.7.0
Requires-Dist: networkx==3.2.1
Requires-Dist: numpy==2.0.1
Requires-Dist: packaging==24.1
Requires-Dist: pandas==2.2.2
Requires-Dist: parso==0.8.4
Requires-Dist: pathvalidate==3.2.0
Requires-Dist: pbr==6.0.0
Requires-Dist: pillow==10.4.0
Requires-Dist: platformdirs==4.2.2
Requires-Dist: prettytable==3.11.0
Requires-Dist: prompt_toolkit==3.0.47
Requires-Dist: pure_eval==0.2.3
Requires-Dist: pycallgraph5==0.1.0
Requires-Dist: Pygments==2.18.0
Requires-Dist: pylint==3.2.6
Requires-Dist: pypistats==1.6.0
Requires-Dist: pytablewriter==1.2.0
Requires-Dist: python-call-graph==2.1.2
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: python-slugify==8.0.4
Requires-Dist: pytz==2024.1
Requires-Dist: pyvis==0.1.9
Requires-Dist: PyYAML==6.0.2
Requires-Dist: recommonmark==0.7.1
Requires-Dist: reportlab==4.2.2
Requires-Dist: requests==2.32.3
Requires-Dist: rst2pdf==0.102
Requires-Dist: six==1.16.0
Requires-Dist: smartypants==2.0.1
Requires-Dist: sniffio==1.3.1
Requires-Dist: snowballstemmer==2.2.0
Requires-Dist: socksio==1.0.0
Requires-Dist: soupsieve==2.5
Requires-Dist: Sphinx==7.4.7
Requires-Dist: sphinxcontrib-applehelp==2.0.0
Requires-Dist: sphinxcontrib-devhelp==2.0.0
Requires-Dist: sphinxcontrib-htmlhelp==2.1.0
Requires-Dist: sphinxcontrib-jsmath==1.0.1
Requires-Dist: sphinxcontrib-qthelp==2.0.0
Requires-Dist: sphinxcontrib-serializinghtml==2.0.0
Requires-Dist: stack-data==0.6.3
Requires-Dist: stevedore==5.2.0
Requires-Dist: tabledata==1.3.3
Requires-Dist: tcolorpy==0.1.6
Requires-Dist: termcolor==2.4.0
Requires-Dist: text-unidecode==1.3
Requires-Dist: tomli==2.0.1
Requires-Dist: tomlkit==0.13.2
Requires-Dist: traitlets==5.14.3
Requires-Dist: typepy==1.3.2
Requires-Dist: typing_extensions==4.12.2
Requires-Dist: tzdata==2024.1
Requires-Dist: urllib3==2.2.2
Requires-Dist: virtualenv==20.26.3
Requires-Dist: virtualenv-clone==0.5.7
Requires-Dist: virtualenvwrapper==6.1.0
Requires-Dist: wcwidth==0.2.13
Requires-Dist: win32-setctime==1.1.0
Requires-Dist: zipp==3.20.0

# 0.1.9

测试通过，发布正式版

# 0.1.8

更新内容如下

# 文件名称: common_maths.py

---

---

## 函数部分：

#### 函数 create_dir

```
在指定路径下创建名称为{dir_name}的文件夹
Args:
    dir_name: 文件夹名称
    path: 要创建文件夹的路径，默认为当前路径

Returns:
    无
```

#### 函数 get_max_diff

```
参数：
    two_dimensional_array: 二维数组
返回值：
    每一列里面最大值和最小值的差值，类型是一个一维数组
功能：
    传入一个二维数组，函数返回每一列里面最大值和最小值的差值。
```

#### 函数 remove_outliers_iqr

```
参数：
    data: 二维数组
返回值：
    去除异常值后的二维数组和有效的行索引，类型是一个元组
功能：
    四分位距法去除传入的二维数组中的异常值，注意是对于每一列来说的自己的异常值
```

#### 函数 export_to_csv

```
参数：
    array_data: 二维数组，要保存的数据
    file_name: 字符串，CSV文件的名称（不包含扩展名）
    output_directory: 字符串，保存文件的目录路径，默认为当前目录
返回：
    None
功能：
    将给定的二维数组保存到指定目录中的CSV文件。如果文件已存在，则追加数据，并在每次写入时添加空行作为分隔符。
```

---

## 类部分：

---

# 文件名称: source2md.py

---

---

## 函数部分：

#### 函数 dir2md

```
Args:
    source_dir: 待处理目录
    output_dir: 输出目录
    single_file: 是否将所有文件放到一个md文件中
```

#### 函数 extract_info

```
功能：
    解析python文件，提取函数和类信息
Args:
    file_path: 待处理文件路径
Returns:
    function_docs: 函数信息
    class_info: 类信息
```

#### 函数 all_save_markdown

```
功能：
    将提取的函数和类信息保存为markdown文件
Args:
    file_path: 待处理文件路径
    output_path: 保存路径
    function_docs: 函数信息
    class_info: 类信息
Returns:
    无
```

#### 函数 all2md

```
功能：调用，将一个python文件中的函数和类信息提取出来，并保存为markdown文件
Args:
    file_path: 字符串，python文件的路径
    output_path: 字符串，markdown文件的保存路径
Returns:
    无
```

#### 函数 extract_function_docs_from_file

```
从 Python 文件中提取函数的 docstring（注释部分）。

参数:
    file_path: 字符串，Python 文件的路径。

返回:
    字典，键为函数名，值为函数的 docstring。
```

#### 函数 save_docs_to_markdown

```
将函数的 docstring 保存到 Markdown 文件中。

参数:
    docs: 字典，包含函数名和 docstring 的映射。
    output_path: 字符串，Markdown 文件的保存路径。
```

#### 函数 pyFun2md

```
将 Python 文件中提取 docstring 并保存为 Markdown 文件。

参数:
    source_file: 字符串，源 Python 文件的路径。
    output_md: 字符串，输出 Markdown 文件的路径。
```

---

## 类部分：

---

# 0.1.7

与 0.1.8 相同

# 0.1.6

发布至正式版

# 0.1.5

更新以下内容

注：所有的函数调用方式都是
`myz_tools.文件名称.函数名称(必要的参数)`

各项函数均已通过单元测试

## py2md.py 文件内容

```
主函数，用于从 Python 文件中提取 docstring 并保存为 Markdown 文件。

参数:
    source_file: 字符串，源 Python 文件的路径。
    output_md: 字符串，输出 Markdown 文件的路径。
```

## common_maths.py 文件内容

### create_dir

```
参数：
    dir_name: 文件夹名称
    path: 要创建文件夹的路径，默认为当前路径
返回值：
    无
功能：
    在指定路径下创建名称为{dir_name}的文件夹
```

### get_max_diff

```
参数：
    two_dimensional_array: 二维数组
返回值：
    每一列里面最大值和最小值的差值，类型是一个一维数组
功能：
    传入一个二维数组，函数返回每一列里面最大值和最小值的差值。
```

### remove_outliers_iqr

```
参数：
    data: 二维数组
返回值：
    去除异常值后的二维数组和有效的行索引，类型是一个元组
功能：
    四分位距法去除传入的二维数组中的异常值，注意是对于每一列来说的自己的异常值
```

### export_to_csv

```
参数：
    array_data: 二维数组，要保存的数据
    file_name: 字符串，CSV文件的名称（不包含扩展名）
    output_directory: 字符串，保存文件的目录路径，默认为当前目录
返回：
    None
功能：
    将给定的二维数组保存到指定目录中的CSV文件。如果文件已存在，则追加数据，并在每次写入时添加空行作为分隔符。
```

# 0.1.4

from .mytest import \*

测试结果
调用 myz_tools.my_test1()结果为
AttributeError: module 'myz_tools' has no attribute 'my_test1'

# 0.1.3

from . import \*

测试成功，可以通过 myz_tools.mytest.my_test2()调用

# 0.1.2

测试内容：
md 格式原因，下划线下划线换为--表示
--init--.py 为空

测试结果
ModuleNotFoundError: No module named 'mytest'
