Package Health Score

66 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Active

Popularity

Small

GitHub Stars: 12.15K
Forks: 2.69K
Contributors: 380

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package zxy-Test, we found that it has been starred 12,152 times.

Security

No known security issues

Security and license risk for latest version

Release Date: May 6, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like zxy-Test is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 816
Open PR: 88
Last Release: 2 years ago
Last Commit: 1 month ago

Further analysis of the maintenance status of zxy-Test based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for zxy-Test is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 380
Funding: Yes

A good and healthy external contribution signal for zxy-Test project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*

Age: 2 years
Latest Release: 2 years ago
Dependencies: 3 Direct
Versions: 3
Maintainers: 0
Wheels: OS Independent

Readme

Python 项目模版

开发

使用 $ virtualenv venv --python=python3 && source venv/bin/activate 创建并激活此 virtualenv;
使用 $ make install_dev 或者$ pip install -e .[dev] 安装项目依赖
Coding

静态检查

项目已经配置好使用 flake8 做静态检查，执行$ make lint即可。

测试

单元测试位于 tests/ 目录中，使用 $ make test 可以运行单元测试。如何编写单元测试可以参考 pytest

默认会在 Python2.7/3.7 环境下运行单元测试，如果需要支持更多版本 Python，可以修改 tox.ini。

规范

代码规范

需要保证代码兼容 Python2.7，Python3.7+；
代码风格兼容 PEP8，除了代码最大宽度放宽到 120。

版本规范

版本需要遵循 Semver；
发布分支后，需要创建类似 v0.0.1 的 tag；
每次 Release，需要编辑 CHANGELOG.md，内容需要遵守 changelog 规范。

Tips

Makefile指南

makefile用于帮助开发者快速使用功能，目前支持的命令有

指令	作用
make	按顺序执行 install_dev、isort、isort_check、lint、test(操作更改代码!)
make check	按顺序执行 install_dev、isort_check、lint、test
make install_dev	安装测试所需依赖(位于setup.py的DEV_REQUIRES)
make isort	执行isort，规范化import顺序(操作更改代码!)
make isort_check	执行import顺序规范性检查
make lint	执行flake8，检查你的代码规范性
make test	执行tox，检测单元测试的正确性
make clean	清除测试和检查产物

建议每次准备发布代码前，执行一次make或者make check来保证代码的规范性和健壮性。

Python2/3 兼容

每个 Python 文件头部都增加如下代码(尽量保证此import位于任何其他import之前)：

# coding: utf-8

from __future__ import absolute_import, division, print_function, unicode_literals

来保证代码在 Python2 和 Python3 下尽可能保持一致。

Python2 与 Python3 不兼容的代码，尽量使用 six 模块做兼容。比如 Python2 和 Python3 下 range 函数行为不一致，统一使用 six.moves.range 可以保证兼容性。

类型标注

Python PEP484 中新增了类型标注功能，可以给代码增加可选的类型标注，配合 mypy 可以静态的给代码做类型检查。

开发中给每个 .py 文件编写一个对应的 .pyi，编写好导出类型的函数签名。此项目已经配置好相关规则，包发布后，使用者就可以使用编写好的类型信息做静态类型检查、代码补全。

如果对导出函数写 docstring，除了按照 PEP8 的要求进行编写之外，还可以对传入传出数据类型做标注与注释。注释格式参考 PyCharm 的这篇文档的格式进行编写。PyCharm 以及 Jedi（vim / emacs / vscode 都是基于 jedi 进行自动补全）等等自动补全/静态检查工具都可以基于此格式的信息进行检查，Sphinx 生成的 API doc 也可以进行识别。

editorconfig

可以安装 editorconfig 编辑器插件，保持代码一致性。此项目已经默认配置。

zxy-Test dependencies

mypy six typing

FAQs

What is zxy-Test?

测试pip发包. Visit Snyk Advisor to see a full health score report for zxy-Test, including popularity, security, maintenance & community analysis.

Is zxy-Test popular?

The python package zxy-Test receives a total of 35 weekly downloads. As such, zxy-Test popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is zxy-Test well maintained?

We found indications that zxy-Test is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is zxy-Test safe to use?

The python package zxy-Test was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 12 December-2024, at 11:51 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

zxy-Test

测试pip发包 For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Python 项目模版

开发

静态检查

测试

规范

代码规范

版本规范

Tips

Makefile指南

Python2/3 兼容

类型标注

editorconfig

zxy-Test dependencies

FAQs

What is zxy-Test?

Is zxy-Test popular?

Is zxy-Test well maintained?

Is zxy-Test safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Python 项目模版

开发

静态检查

测试

规范

代码规范

版本规范

Tips

Makefile指南

Python2/3 兼容

类型标注

editorconfig

zxy-Test dependencies

FAQs

What is zxy-Test?

Is zxy-Test popular?

Is zxy-Test well maintained?

Is zxy-Test safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues