From a2354725a96b41cef5ee5b58f5bea030e231b602 Mon Sep 17 00:00:00 2001 From: Jan Range Date: Wed, 3 Jan 2024 19:40:43 +0100 Subject: [PATCH] add workflow badges --- Readme.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/Readme.md b/Readme.md index 1a34282..2f82628 100644 --- a/Readme.md +++ b/Readme.md @@ -1,30 +1,32 @@

EasyDataverse
v0.4.0 - Build Badge + Build Badge + Build Badge

-

-EasyDataverse is a Python libary used to interface Dataverse installations and generate Python code compatible to a metadatablock configuration given at a Dataverse installation. In addtion, EasyDataverse allows you to export and import datasets to and from various data formats.

+

+EasyDataverse is a Python libary used to interface Dataverse installations and dynamically generate Python objects compatible to a metadatablock configuration given at a Dataverse installation. In addtion, EasyDataverse allows you to export and import datasets to and from various data formats.

-### Features +### Features - **Metadataconfig compliant** classes for flexible Dataset creation. - **Upload and download** of files and directories to and from Dataverse installations. -- **Export and import** of datasets to various formats (JSON, YAML, XML and HDF5). +- **Export and import** of datasets to various formats (JSON, YAML and XML). - **Fetch datasets** from any Dataverse installation into an object oriented structure ready to be integrated. ## ⚡️ Quick start -Get started with EasyDataverse by running the following command -``` +Get started with EasyDataverse by running the following command + +```bash # Using PyPI python -m pip install easyDataverse ``` Or build by source -``` +```bash git clone https://github.com/gdcc/easyDataverse.git cd easyDataverse python setup.py install @@ -32,7 +34,6 @@ python setup.py install ## ⚙️ Quickstart - ### Dataset creation EasyDataverse is capable of connecting to a given Dataverse installation and fetch all metadata fields and their properties. This allows you to create a dataset object with all the metadata fields and their properties given at the Dataverse installation. @@ -103,4 +104,4 @@ dataset.update() ## ⚠️ License -`EasyDataverse` is free and open-source software licensed under the [MIT License](). +`EasyDataverse` is free and open-source software licensed under the [MIT License]().