Skip to content

Commit

Permalink
add rebel crab
Browse files Browse the repository at this point in the history
  • Loading branch information
JR-1991 committed Jul 18, 2024
1 parent d9ead1d commit 8ff613b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,32 @@
# Dataverse Rust

![Build Status](https://github.com/JR-1991/rust-dataverse/actions/workflows/tests.yml/badge.svg)

**Dataverse Rust** is a client library and command-line interface (CLI) for interacting with the [Dataverse API](https://guides.dataverse.org/en/latest/api/). This project is in active development and not yet feature complete.
<div align="center">
<img src="./static/image.png" width="190">
</div>

# Dataverse Rust

**Dataverse Rust** is a client library and command-line interface (CLI) for interacting with
the [Dataverse API](https://guides.dataverse.org/en/latest/api/). This project is in active development and not yet
feature complete.

## Features

Current capabilities include:

### Collection Management

- **Create**: Create a new collection within the Dataverse.
- **Delete**: Remove an existing collection.
- **Publish**: Publish a collection to make it publicly available.
- **Contents**: Retrieve the contents of a collection.

### General Information

- **Version**: Retrieve the current version of the Dataverse instance.

### Dataset Management

- **Get**: Fetch details of a specific dataset.
- **Create**: Create a new dataset within a collection.
- **Edit**: Modify an existing dataset.
Expand All @@ -27,6 +36,7 @@ Current capabilities include:
- **Link**: Link datasets to other collections.

### File Management

- **Replace**: Replace existing files in a dataset.

## Installation
Expand All @@ -41,7 +51,8 @@ cargo install --path .

**Cargo.toml**

Please note, this crate is not yet published on crates.io. You can add it to your `Cargo.toml` file by pointing to the GitHub repository.
Please note, this crate is not yet published on crates.io. You can add it to your `Cargo.toml` file by pointing to the
GitHub repository.

```toml
[dependencies]
Expand All @@ -52,7 +63,8 @@ dataverse = { git = "https://github.com/JR-1991/rust-dataverse" }

### Command line

Before you can use the command line tool, you need to set the `DVCLI_URL` and `DVCLI_TOKEN` environment variables. You can do this by adding the following lines to your `.bashrc` or `.bash_profile` file:
Before you can use the command line tool, you need to set the `DVCLI_URL` and `DVCLI_TOKEN` environment variables. You
can do this by adding the following lines to your `.bashrc` or `.bash_profile` file:

```bash
export DVCLI_URL="https://your.dataverse.url"
Expand Down Expand Up @@ -92,9 +104,11 @@ Calling: http://localhost:8080/api/info/version

## Examples

We have provided an example in the `examples` directory. These examples demonstrate how to use the client to perform various operations.
We have provided an example in the `examples` directory. These examples demonstrate how to use the client to perform
various operations.

* [`examples/create-upload-publish`](examples/create-upload-publish) - Demonstrates how to create a collection, dataset, upload a file, and publish the collection and dataset.
* [`examples/create-upload-publish`](examples/create-upload-publish) - Demonstrates how to create a collection, dataset,
upload a file, and publish the collection and dataset.

## ToDo's

Expand Down
Binary file added static/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8ff613b

Please sign in to comment.