Skip to content

Commit

Permalink
DOC: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
jotelha committed May 21, 2024
1 parent 5e5399b commit 51b4ae2
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 5 deletions.
3 changes: 1 addition & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ This change log uses principles from `keep a changelog <http://keepachangelog.co
[Unreleased]
------------

- rebranded some bits from ``dtool_lookup_...`` to ``dserver_...``

Added
^^^^^

Expand All @@ -21,6 +19,7 @@ Added
Changed
^^^^^^^

- rebranded some bits from ``dtool_lookup_...`` to ``dserver_...``

Deprecated
^^^^^^^^^^
Expand Down
24 changes: 21 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
README
======

tool plugin for interacting with dserver
dtool plugin for interacting with dserver

Installation
------------
Expand All @@ -15,6 +15,19 @@ To install the dtool-lookup-client package.
This plugin depends on having a `dserver
<https://github.com/jic-dtool/dtool-lookup-server>`_ to talk to.

It exposes core functionality of Python API `dtool-lookup-api <https://github.com/livMatS/dtool-lookup-api>`_ on the command line.

Quick start
-----------

Inspect the three core commands with::

dtool lookup -h
dtool search -h
dtool query -h

on the command line.

Configuration
-------------

Expand All @@ -28,7 +41,7 @@ You also need to specify the access token::

For testing purposes, it is possible to disable SSL certificates validation with::

export DSERVER_CLIENT_IGNORE_SSL=true
export DSERVER_VERIFY_SSL=false

Looking up datasets by UUID
---------------------------
Expand All @@ -48,6 +61,11 @@ Full text search for the word "EMS"::

dtool search EMS

Direct MongoDB No-SQL queries
-----------------------------

This requires a ``dserver`` instance with ``dserver-direct-mongo-plugin``.

To list all datasets created by user ``olssont`` using the mongo query language::

dtool search -m '{"creator_username": "olssont"}'
dtool query '{"creator_username": "olssont"}'

0 comments on commit 51b4ae2

Please sign in to comment.