pyspec2openapi

v0.3.0

Convert Ethereum consensus spec SSZ types to OpenAPI type schema definitions For more information about how to use this package see README

Latest version published 11 months ago

License: CC0-1.0

PyPI

GitHub

Package Health Score

66 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

opencv-python
86

Popularity

Small

GitHub Stars: 3.49K
Forks: 933
Contributors: 150

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package pyspec2openapi, we found that it has been starred 3,493 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jan 8, 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
0
M
0
L

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

License

CC0-1.0

Security Policy

Yes

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: 145
Open PR: 93
Last Release: 11 months ago
Last Commit: 5 months ago

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

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

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 150
Funding: No

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

We found a way for you to contribute to the project! Looks like pyspec2openapi 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.8,<4.0

Age: 11 months
Latest Release: 11 months ago
Dependencies: 5 Direct
Versions: 3
Maintainers: 1
Wheels: OS Independent

Readme

pyspec2openapi

Tool to convert the types defined in the Ethereum python specs https://github.com/ethereum/consensus-specs to an OpenAPI definition, for https://github.com/ethereum/beacon-APIs. This tool facilitates manteinance of the OpenAPI spec and follows the canonical JSON mapping from https://github.com/ethereum/consensus-specs/pull/3506

Usage

Install from PyPI

pip install pyspec2openapi

Create a config.yml file

spec_version: v1.4.0-beta.5
sources:
  phase0:
    - {spec: beacon-chain.md}
    - {spec: validator.md}
    - {file: extra_types/phase0.md}
  altair:
    - {spec: beacon-chain.md}
    - {spec: validator.md}
    - {spec: light-client/sync-protocol.md}
    - {file: extra_types/altair.md}
  bellatrix:
    - {spec: beacon-chain.md}
    - {spec: validator.md}
    - {file: extra_types/bellatrix.md}
  capella:
    - {spec: beacon-chain.md}
    - {spec: validator.md}
    - {spec: light-client/sync-protocol.md}
  deneb:
    - {spec: polynomial-commitments.md}
    - {spec: beacon-chain.md}
    - {spec: validator.md}
    - {spec: p2p-interface.md}
    - {spec: light-client/sync-protocol.md}
    - {file: extra_types/deneb.md}
generate_blinded_types: [bellatrix, capella, deneb]
ignore_classnames:
  - LightClientStore
exclude_comments:
  - '\[New [^\]]*\]'
  - '\[Modified [^\]]*\]'

spec_version: Specific Github tag from the ethereum/consensus-specs repo to fetch sources from
sources: Topologically sorted list of fork and files to fetch types from. This tool can topologically sort types within the same markdown file, but not across them.
generate_blinded_types: Auto-generate the types BlindedBeaconBlockBody, BlindedBeaconBlock, and SignedBlindedBeaconBlock for a specific set of forks.
ignore_classnames: Ignore container code blocks with this list of names
exclude_comments: Ignore comments for container properties that match any of this regex

Generate types spec

pyspec2openapi config.yml out.yml

Review an example output with an example config in ./pyspec2openapi/tests/example_specs_out.yml

pyspec2openapi dependencies

deepmerge pyyaml requests types-pyyaml types-requests

FAQs

What is pyspec2openapi?

Convert Ethereum consensus spec SSZ types to OpenAPI type schema definitions. Visit Snyk Advisor to see a full health score report for pyspec2openapi, including popularity, security, maintenance & community analysis.

Is pyspec2openapi popular?

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

Is pyspec2openapi well maintained?

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

Is pyspec2openapi safe to use?

The python package pyspec2openapi 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 18 November-2024, at 01:06 (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

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

pyspec2openapi

Usage

pyspec2openapi dependencies

FAQs

What is pyspec2openapi?

Is pyspec2openapi popular?

Is pyspec2openapi well maintained?

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