Skip to content

Latest commit

 

History

History
153 lines (116 loc) · 5.28 KB

CHANGELOG.md

File metadata and controls

153 lines (116 loc) · 5.28 KB
Raw

2.0.0

CLI

  • added APA output (PR #149; thanks @wleoncio)
  • added support for validation and conversion of CITATION.cff files with cff-version: 1.2.0
  • argument --outputformat was renamed to --format
  • argument -ig, --ignore-suspect-keys was removed
  • argument --verbose was removed
  • argument --show-trace was added

Library

  • added APA output (PR #149; thanks @wleoncio)
  • added support for validation and conversion of CITATION.cff files with cff-version: 1.2.0
  • simplified the Citation class and its interface
  • cli is no longer part of the public interface of the library
  • URLs are now constructed from identifiers, repository, repository-artifact, repository-code, or url, with a transparent mechanism to choose what to use given the data that is available from a given CITATION.cff file
  • Authors are now constructed from given-names, family-names (including name-particle and name-suffix), alias, name, affiliation and orcid, with a transparent mechanism to choose what to use given the data that is available from a given CITATION.cff file

Other

  • switched to static configuration (setup.cfg over setup.py)
  • dependencies are now in setup.cfg as opposed to requirements[-dev].txt
  • updated version ranges for dependencies
  • tests are no longer unittest.TestCase based, but pytest with fixtures
  • added jsonschema based validation for CITATION.cff files with cff-version: 1.2.0
  • implemented State pattern for Citation to help it deal with multiple behaviors under past and future versions of the Citation File Format.
  • switched from TravisCI to GitHub Actions workflows, added linting and publishing workflows
  • CI is now testing against Python 3.6, 3.7, 3.8, and 3.9 on Mac, Linux and Windows
  • copies of the relevant schemas are now bundled with the package
  • organized the tests to be more orthogonal to each other / less overlap between tests

1.3.3

  • With recent changes to the release process, the schema will be in a different place than before. This release fixes citation-file-format#119).

1.3.2

  • the ruamel.yaml dependency was not specified tightly enough, requirements.txt has been updated as have the notes for maintainers.

1.3.1

  • 'cff-version: 1.0.3' is now interpreted as 1.0.3-1 (the latest schema version that implements the spec 1.0.3). This will fix some problems with the list of SPDX license abbreviations. These additional licenses should now work:
    • AGPL-3.0-only
    • AGPL-3.0-or-later
    • BSD-1-Clause
    • BSD-2-Clause-Patent
    • CDLA-Permissive-1.0
    • CDLA-Sharing-1.0
    • EPL-2.0
    • EUPL-1.2
    • GFDL-1.1-only
    • GFDL-1.1-or-later
    • GFDL-1.2-only
    • GFDL-1.2-or-later
    • GFDL-1.3-only
    • GFDL-1.3-or-later
    • GPL-1.0-only
    • GPL-1.0-or-later
    • GPL-2.0-only
    • GPL-2.0-or-later
    • GPL-3.0-only
    • GPL-3.0-or-later
    • LGPL-2.0-only
    • LGPL-2.0-or-later
    • LGPL-2.1-only
    • LGPL-2.1-or-later
    • LGPL-3.0-only
    • LGPL-3.0-or-later

1.3.0

  • added schema.org converter method

1.2.2

  • added documentation for the Google Cloud Function interface

1.2.1

  • setup.py no longer includes test dependencies as install dependencies

1.2.0

1.1.0

  • replaced pykwalifire with its parent pykwalify
  • now works for python 3.7 (refs #80)
  • not using PyYAML anymore (but it still comes along with pykwalify for some reason)
  • added a function that can be used as Google Cloud function
  • hopefully fixed parsing of strings that should have been entered as dates (the new validator does not find that offensive, hence I had to fix it myself)

1.0.4

  • replaced PyYAML dependency with ruamel.yaml

1.0.3

  • security bugfix by updating requests from 2.18.4 to 2.20.0

1.0.2

1.0.1

1.0.0

  • first stable release
  • solved bug citation-file-format#59 (cffconvert creates local file data.yaml and schema.yaml on validate)

0.0.5

  • Minor changes

0.0.4

  • added optional validation of CITATION.cff files using pykwalifire (--validate)
  • added printing the CITATION.cff contents from the command line
  • added unit tests for command line interface
  • added integration with sonarcloud code quality monitoring
  • removed shorthand command line argument -v (represented both --validate and --verbose)
  • added showing its own version (--version)
  • command line argument --ignore-suspect-keys no longer needs to be assigned a value, it's simply a flag