Added new CLI commands
remove_collection_linkin collections to link and remove a child collection to/from a parent collection.
Added new CLI commands
remove_collection_linkin records to link and remove a record to/from a collection.
Changed the RO-Crate import to not require a publisher entity anymore.
Fixed the direct upload functionality to honor the
Forceparameter instead of always replacing files.
Added new CLI commands
Added additional handling when importing RO-Crate files exported via Kadi4Mat.
__version__attribute in favor of using
Added support for Python 3.12.
Adjusted use of the
displaynameattribute of user identities according to API changes in Kadi4Mat version 0.40.0.
term_iriparameter to specify IRI of an existing term for record link functions in both library and CLI.
Exposed additional constants as well as all exceptions as part of the main package.
add_taglibrary method to always return a response object.
Redirects won’t be followed automatically anymore, since the Authorization header containing the access token would be stripped away anyways. If a redirect is detected now, a corresponding exception will be thrown to alert about the necessary code/configuration change.
Removed support for Python 3.7.
Added support for Python 3.11.
import_elnmethod to the miscellaneous library functionality for importing RO-Crate files following the “ELN” file specification.
pat_user_idproperty of the manager class, since it can already be retrieved using
miscellaneouscommand group to just
Refactored the search functionality of the library. All methods are now provided as part of a single class usable via the
KadiManager.searchproperty. Additionally, the methods
search_items_userhave been renamed to
Added a general
misc import-filecommand to import files.
Fixed response data not being streamed when potentially exporting large amounts of data, such as RO-Crates.
Fixed the creation of templates not working via the corresponding CLI command.
rdfexport type to the corresponding CLI commands of records and collections.
Made the methods and commands to add metadata more robust in regards to the expected metadata structure.
The full error response payload is now printed in CLI commands when using the
get_collectionsfunction to retrieve collections linked with a collection id.
add_collection_linkfunction to link a child collection to a parent collection.
remove_collection_linkfunction to remove a child connection linked to a parent collection.
download_all_filesmethod to download all the files in a record as a ZIP archive
Added methods to query revisions of all the resources.
file_descriptionparameter for file upload functions in both library and CLI.
upload_filemethod for uploading smaller files without the need for chunking.
ro-crateexport type to the corresponding CLI commands of records and collections.
get_metadatummethods for records to retrieve nested metadata, which also now works in the corresponding CLI command.
The record library version of
get_metadatumdoes not use the
informationparameter anymore and returns
Nonein case the requested metadatum was not found.
Added functionality to retrieve templates shared with a group via the library.
Added functionality to manage user and group roles of templates via the library.
Added functionality to retrieve group roles of all resources via the library.
Fixed retrieval of deleted resources via the CLI.
Fixed usage of some CLI related classes outside of builtin commands.
Fixed purging of some resource types via the CLI.
Deleted templates can now be purged and restored via the CLI.
Added functionality to export templates.
All export functions and commands now default to the JSON export type.
licenseoption to the
records editCLI subcommand.
Removed support for Python 3.6.
The unit does not have to be specified in the dict using the
add_metadatumfunction within the CLI/lib.
click_completiondependency. Autocompletion is now only supported for bash, fish and zsh.
Fixed the export function via using the correct parameter.
Added handling of the
search_pagination_optionsdecorator to set an user-specific description for the option
Refactoring of the record linkage, as the check for identical links is already carried out in Kadi.
Refactoring of the export function. The file is now already stored using the export function defined in the lib part.
Add an example if metadata have not the right input format when using the
Added support for new collaborator role.
Added exclude options and a query parameter in the
Added utility function to create identifier from arbitrary string input.
Increased the upload speed of small files.
Add option to pipe a list of downloaded files as tokenlist.
Relaxed required Python version again.
Add functions to use the
Include functions to export a collection.
Changed default separator in
Add option so search records in child collections.
Include option to work with tokenlists.
Added feature to export a record to a folder based on the identifier.
Include methods using the export endpoint.
Improve usability of config add-instance.
Use of more mixin classes in the CLI lib.
Add the GET /api/roles endpoint.
Add CLI function to edit basic metadata of a template.
Replaced hide-public with visibility parameter.
Refactoring the use of raise_request_error().
get_metadatummethod to the lib record.
Added functions to update a record link (name).
Added options to use a tokenlist in the search.
Take into account corner case if only a scope to create a resource is given.
Make get_metadatum work with nested types.
Include search function which returns a list of ids.
Include CLI tools to search for record and collection ids.
Add factory methods for base functions into CLIKadiManager.
Do not validate metadatum if value is
Add option to store record files in a folder based on the record’s identifier.
Add basic validation for host input.
Add more CLI config tools.
Add option to use the KadiManager via the ‘@apy_command’ decorator.
Smaller refactoring in docs.
Fix bash example script.
Show also username in user search.
Set identity type to required in case of specifying user via username.
Changed two required arguments of
CLIRecordclass to optional.
Include verbose level to manage the amount of print outputs.
Add pypi deploy runner.
Add CLI tools to configure the config file.
get-kadi-infofrom CLI group
Add default value in
get_file_infofunction for records.
Return list of downloaded file(s) in
Add experimental CLI tool to download and execute a workflow.
Add CLI tool
kadi-apy miscellaneous get-kadi-info.
Exit with error code 1 during uploading a file in case the file already exists and should not be replaced.
exit-not-createdflag to CLI create tools.
Fix order in which
Add option to download only those files from record matching pattern.
Add char options for decorator to define options of files and resources.
Add CLI tool
Add option to use certificates from ca_bundle.
Add option skip the initial request.
Include a config file to store the information about host and PAT.
Added timeout config option.
Include the –version output.
Add handling for missing schema exception.
Unify the behavior of decorators if information is not required.
Add –xmlhelp runner
Add option to hide public resources in the CLI search.
Functions to handle miscellaneous (license search, remove item from trash).
Add function to remove all metadata from a record.
Include xmlhelpy import from pypi.
Include definition of public api.
Integration of –xmlhelp option to all CLI tools.
Definition of CLI classes which can be used in additions tools.
Print more infos when using the CLI.
Fix for specifying PAT and host directly in certain cli commands.
Raise exception instead of sys.exit(1) for cli functions.
Work with identifiers for items.
Include group roles for records and collections.
Add option to skip ssl/tls cert verification.
Improved printing for updated metadata.
Most API endpoints for managing records, collections and groups, as well as some others, are usable directly through the library.
Most of that functionality is also exposed via CLI by using the kadi-apy command.