v0.2.0
Announcements
- We have added support for getting citations for files that are members of multiple datasets i.e. associated with multiple PIDs 🎉
- This required some alterations to the API, see below (and if you're such an early adopter that this matters to you, congrats)
Changelog
⚠️ Breaking Changes
-
- Changed the input arguments expected by [cmipcite.citations.get_citations][]. The old
formatandauthor_list_styleshould now be handled when creating the value to pass to the newget_citationargument. This provides finer-grained control over how citations are generated (once the DOIs and versions have been determined). For an API that closely mirrors the command-linecmipcite getAPI, see [cmipcite.citations.get][]. - Split
cmipcite.citations.get_citation_for_idinto [cmipcite.citations.get_text_citation][], [cmipcite.citations.get_bibtex_citation][] and [cmipcite.citations.get_doi_and_version][]. This allows the process of retrieving relevant DOIs and versions to be separated from how the citations for those DOIs and versions are retrieved and formatted.
(#5)
- Changed the input arguments expected by [cmipcite.citations.get_citations][]. The old
🆕 Features
-
get_citationsnow works with tracking_id and PID. (#3) -
- Added [cmipcite.citations.get][] to provide a Python API which closely mirrors the command-line
cmipcite getcommand ([cmipcite.citations.get_citations][] is a lower-level function which provides more flexibility to Python users looking for greater control) - Added the [cmipcite.tracking_id][] module to support handling of tracking IDs specifically (as opposed to PIDs)
(#5)
- Added [cmipcite.citations.get][] to provide a Python API which closely mirrors the command-line
🎉 Improvements
-
- Added support for getting citations for files that are members of multiple datasets i.e. associated with multiple PIDs
- Added the
--multi-dataset-handlingand--handle-server-urlarguments to thecmipcite getCLI to add the support above and avoid hard-coding the server URL used throughout
(#5)
Changes
- 032040e bump: version 0.1.3.post1 -> 0.2.0
- 5f877b2 Add docstring
- 8e1a76c Add doctest
- 5e1be39 Fix up typo in CHANGELOG
- 870569a Further clarifications
- 596954d Update CHANGELOG
- f9c7d8c Include version info in multiple PID error
- 8cf1ada Add CLI-like API layer
- f898926 Add suitable pragma: no cover
- 9e2f53f mypy
- ae04e4e CHANGELOG
- 6847175 Docs
- 66d7dae Finish off multi-use support
- e177426 Start on higher level functions
- 718393f Add handling strategy for tracking IDs in multiple datasets
- 44b346a add explainer
- 97a445d Apply suggestions from code review
- be1f1de changelog
- a52b1d9 short author
- 7a82cba try to pass coverage
- d437fa6 add test
- 9b7db86 fix cli
- 475af60 use agg_lev
- 55e2300 fix doc
- 34fdbf0 pid vs tracking
- fb1d691 bump(pre-release): version 0.1.3 > 0.1.3.post1