sparkfish / glyphcast Goto Github PK

This addition would expose an ability to render a PDF from an SVG using a provided set of Options, so the identical will be almost interface to the existing interface to convert SVG to PNG.

Though the Options will vary, we should aim to unify them as much as possible so that we could use the same Options class if that appears possible after exploring this further.

See repo located at https://github.com/typst/svg2pdf. This lib shares many of the same dependencies as resvg so hopefully the size of the final package binary will not be overly affected.

For this issue, we need to include adding all the cute little buttons to the README, such as:

• Build Status
• Test Coverage
• License Badge
• PyPI Version Badge
• Downloads Badge (showing count for all time)

In preparation for building a solid framework for the community, we want strong checks in place to ensure the quality of the code being produced.

When a new branch is merged to rel and a tag is created on that branch, we should trigger a new release.

Automation of the build will ensure we can separately set up a process that keeps track of upstream updates to resvg.

Since our key dependency is resvg, we need to ensure we are getting all the latest updates when those are released.

There does not appear to be a GitHub Action trigger available that activates when an update to a dependency is released. So, we will need to come up with a mechanism for identifying the current release number and comparing that to some tracking that within GH Actions, such as use of upload-artifact and download-artifact for tracking that state.

Another approach may be to leverage GitHub's Dependabot to trigger a PR based on the release of a dependency.

This may be done as the options are added, but this issue tracks the additional work effort and assurance that all the options have test coverage.

• width
• height
• fit_to
• background
• dpi
• text
• image
• lang
• skip_system_fonts
• font_size
• font_family
• font_path

Benchmark Python Alternatives

resvg's existing benchmark offers a set of over 1,600 SVG files, each prepared with an associated PNG baseline for testing standard's compatibility. This will provide us with a reference dataset for establishing our own metrics for comparing to alternative Python libraries against the full set of test images.

Tests should be performed by converting SVGs to both PNGs and PDFs (as separate timing-level benchmarks).

Alternative Methods to Include in Benchmark

• CairoSVG
• Svglib
• Inkscape

Possible Metrics

• Python Dependency Count
• External Dependencies (list of named external dependencies)
• Size of Python Package (including its Python dependencies)
• Size of External Depenencies (cairo, ghostscript, inkscape, etc)
• Speed (total time, lower number is better)
• Memory Usage
• Alpha Channel Support
• Filters Support (see resvg filters support and this example that tests the turbulence filter)
• SVG-to-PNG Compatibility (based on conformance to PNG baseline image)

The Options class provides customization and configuration options for rendering SVG files. The main options have been documented in the README, but now we need to ensure they are all implemented.

Also, it would be ideal to allow the options to be defined as a dictionary as a possible style for passing the options, so either as a dictionary or instance of a proper Options class.

If there are parameters that are problematic to deal with, we may defer those until later. But, if they are trivial to address now, then we should knock them all out now.