Repository navigation
Added:
- Added
CONTRIBUTING.mdwith guidelines for reporting issues, asking questions and contributing code or documentation. - Added
CODE_OF_CONDUCT.mdbased on the Contributor Covenant 3.0. - Added "Contributing and support" sections to the README and the documentation landing page.
- Added
CITATION.cffso that GitHub shows a "Cite this repository" button. - Added a
cffpixi task and a CI check that validateCITATION.cff. - Added a
--plotflag to thedigitize,figure, andcvCLI commands which writes a PNG of the digitized curve with labeled axes (including units) and the same scale as in the original figure. - Added the
--metadata,--si-units,--bibliography, and--citation-keyoptions to thedigitizeCLI command. - Added an
--only-csvflag to thedigitizeCLI command, which writes only the CSV without the JSON. - Added retries to the download of citations from doi.org, since the services behind it occasionally fail with server errors.
- Added
svgdigitizer.__version__and a--versionflag to thesvgdigitizercommand line interface. - Added the name and version of svgdigitizer as
figureDescription.softwareto the metadata of the created datapackages.
Changed:
- Changed the DOI in the README and the documentation to the Zenodo concept DOI, which always refers to the latest release.
- Changed the
plot()methods ofSVGPlot,SVGFigure, andCVto return the matplotlibAxesand to use the same scale as in the original figure. - Changed the
digitizeCLI command to create a frictionless datapackage (CSV + JSON) instead of only a CSV, so that the units and the version of svgdigitizer are recorded with the data (see#247 <https://github.com/echemdb/svgdigitizer/issues/247>_). When the SVG contains a scan rate, the CSV also contains a time axis.
Deprecated:
- Deprecated the
figureCLI command, which is now an alias of thedigitizecommand.
Removed:
- Removed
.zenodo.json. Zenodo now takes the release metadata fromCITATION.cff. - Removed the
plotCLI command which is superseded by the--plotflag of the digitization commands.
Fixed:
- Fixed several issues in the documentation.
- Fixed
Pdf.build_identifiercrashing with aUnicodeEncodeErrorwhen the bibtex entry contains plain UTF-8 characters outside latin-1 (e.g.,ć,ž, or an em dash—). LaTeX escape sequences are now decoded with thelatex+utf8codec, which also handles entries mixing LaTeX escapes and such characters. - Fixed
Pdf.bibliographic_entryfailing with an unrelatedAttributeErrorwhen the citation could not be downloaded. AConnectionErrordescribing the network error or HTTP status is now raised instead. - Fixed the CLI example in the usage documentation, which used a non-existing
--sampling_intervalflag and a wrong path to the SVG file. - Fixed
svgdigitizer figureandsvgdigitizer cvfailing on Windows when the output directory or the SVG is given as an absolute path with forward slashes, such asC:/data.