Package Health Score

63 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

PyX
48

Popularity

Small

GitHub Stars: 1.55K
Forks: 326
Contributors: 40

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package pxd, we found that it has been starred 1,549 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Jun 14, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
4
M
0
L

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

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like pxd 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: 41
Open PR: 8
Last Release: 6 months ago
Last Commit: 1 month ago

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

We found that pxd demonstrates a positive version release cadence with at least one new version released in the past 12 months.

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: No
Contributors: 40
Funding: No

With more than 10 contributors for the pxd repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like pxd is missing a Code of Conduct.

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: ==3.5.*, ==3.6.*, ==3.7.*, ==3.8.*

Age: 3 years
Latest Release: 6 months ago
Dependencies: 0 Direct
Versions: 15
Maintainers: 0
Wheels: OS Independent

Readme

What is pxd?

pxd(polardbx-deployer) is a tool to deploy PolarDB-X.

Install

Run command:

pip install pxd

More details see: Quick Start

Usage

Create PolarDB-X for tryout

Create a default cluster(1 GMS, 1 DN, 1 CN, 1 CDC) for tryout on your local machine:

pxd tryout

You can specify cn and dn version using the following options:

Options:
  -name TEXT            PolarDB-X Cluster name, default: pxc-tryout
  -cn_replica INTEGER   cn node count
  -cn_version TEXT      cn node version
  -dn_replica INTEGER   dn node count
  -dn_version TEXT      dn node version
  -cdc_replica INTEGER  cdc node count
  -cdc_version TEXT     cdc node version
  -leader_only BOOLEAN  create gms and dn with single node by default,
                        otherwise a x-paxos cluster

  --help                Show this message and exit.

If you want to create gms and dn with a x-paxos cluster, using the following command:

pxd tryout -leader_only false

Create PolarDB-X for cluster mode

pxd create -file cluster.yaml

Following is an example of cluster.yaml

version: v1
type: polardbx
cluster:
  name: pxc_test
  gms:
    image: polardbx/galaxyengine:latest
    host_group: [10.168.0.37]
    resources:
      mem_limit: 2G
  cn:
    image: polardbx/galaxysql:latest
    replica: 3
    nodes:
      - host: 10.168.0.37
      - host: 10.168.0.38
      - host: 10.168.0.39
    resources:
      mem_limit: 4G
  dn:
    image: polardbx/galaxyengine:latest
    replica: 2
    nodes:
      - host_group: [10.168.0.38]
      - host_group: [10.168.0.39]
    resources:
      mem_limit: 4G
  cdc:
    image: polardbx/galaxycdc:latest
    replica: 3
    nodes:
      - host: 10.168.0.37
      - host: 10.168.0.38
      - host: 10.168.0.39
    resources:
      mem_limit: 4G

version: topology version, default v1
type: cluster type, polardbx
cluster.name：The name of PolarDB-X cluster
cluster.gms.image: docker image of gms, default is the latest
cluster.gms.host_group: gms ip list. If set three ips, it will create a x-paxos cluster
cluster.cn
- image: docker image of cn, default is the latest
- replica: cn node count
- nodes: list, cn node hosts
- resources:
  - mem_limit: memory limit，default 1G
cluster.dn
- image: docker image of dn, default is the latest
- replica: dn node count
- nodes: dn host group list. If set three ips, it will create a x-paxos cluster
- resources:
  - mem_limit: memory limit，default 1G
cluster.cdc
- image: docker image of cdc, default is the latest
- replica: cdc node count
- nodes: cdc node ip list
- resources:
  - mem_limit: memory limit，default 1G

List existing clusters

pxd list

It will show all PolarDB-X clusters.

Delete Cluster

Delete a specific PolarDB-X cluster:

pxd delete {pxc_name}

Delete all PolarDB-X clusters:

pxd cleanup

More information about pxd, please run following command:

pxd --help

More information about PolarDB-X, refer to following links:

FAQs

What is pxd?

This is a tool to download and install PolarDB-X. Visit Snyk Advisor to see a full health score report for pxd, including popularity, security, maintenance & community analysis.

Is pxd popular?

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

Is pxd well maintained?

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

Is pxd safe to use?

While scanning the latest version of pxd, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 11 December-2024, at 22:36 (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

pxd

This is a tool to download and install PolarDB-X For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

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

What is pxd?

Install

Usage

Create PolarDB-X for tryout

Create PolarDB-X for cluster mode

List existing clusters

Delete Cluster

FAQs

What is pxd?

Is pxd popular?

Is pxd well maintained?

Is pxd 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

Explore Similar Packages

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

What is pxd?

Install

Usage

Create PolarDB-X for tryout

Create PolarDB-X for cluster mode

List existing clusters

Delete Cluster

FAQs

What is pxd?

Is pxd popular?

Is pxd well maintained?

Is pxd 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