Barique - Python client for Baricadr¶

Contents:

Barique¶

A Python client (library and CLI) for interacting with a Baricadr server.

Installation¶

$ pip install barique

# On first use you'll need to create a config file to connect to the server, just run:

$ barique init
Welcome to Barique
Baricadr server host: localhost
Baricadr server port: 9100
Is your Baricadr instance running behind an authentication proxy? [y/N]: n
Testing connection...
Ok! Everything looks good.
Ready to go! Type `barique` to get a list of commands you can execute.

This will create a barique config file in ~/.barique.yml

Examples¶

# List files in a remote repository
$ barique file list /repos/test_repo/
[
    {
        "Path": "file.txt"
    },
    {
        "Path": "file2.txt"
    }
]

# Ask Baricadr to pull a single file
$ barique file pull /repos/test_repo/file.txt
7958b29c-2a14-486c-90f0-585e68ac9f44

# Check the status of a pull task
$ barique task show 7958b29c-2a14-486c-90f0-585e68ac9f44
{
    "created": "Wed, 17 Feb 2021 15:11:56 GMT",
    "error": null,
    "finished": "Wed, 17 Feb 2021 15:12:03 GMT",
    "path": "/repos/test_repo/file.txt",
    "started": "Wed, 17 Feb 2021 15:11:58 GMT",
    "status": "finished",
    "task_id": "7958b29c-2a14-486c-90f0-585e68ac9f44",
    "type": "pull"
}

# Ask Baricadr to freze a single file
$ barique file freeze /repos/test_repo/file2.txt
7958b29c-2a14-486c-90f0-585e68ac9f44

# Check the status of a pull task
$ barique task show 7958b29c-2a14-486c-90f0-585e68ac9f44
{
    "created": "Wed, 17 Feb 2021 15:16:49 GMT",
    "error": null,
    "finished": "Wed, 17 Feb 2021 15:16:52 GMT",
    "path": "/repos/test_repo/file2.txt",
    "started": "Wed, 17 Feb 2021 15:16:51 GMT",
    "status": "finished",
    "task_id": "7958b29c-2a14-486c-90f0-585e68ac9f44",
    "type": "freeze"
}

License¶

Available under the MIT License

Commands¶

Barique is a set of wrappers for Baricadr’s API. It builds a set of small, useful utilities for talking to a Baricadr server. Each utility is implemented as a subcommand of barique. This section of the documentation describes these commands.

file¶

This section is auto-generated from the help text for the barique command file.

`freeze` command¶

Usage:

barique file freeze [OPTIONS] PATH

Help

Launch a freeze task

Output

Id associated to the freeze task

Options:

--force       Force freezing, even if the freezing delay was not reached
--dry_run     Do not make any deletion, just list changes that would be made
--email TEXT  User email adress for notification
-h, --help    Show this message and exit.

`list` command¶

Usage:

barique file list [OPTIONS] PATH

Help

List files available from a remote repository for a local path

Output

List of file relative paths

Options:

--full               List full information for each file (size (in bytes),
                     mtime, etc..)

--missing            Only list files missing from the local path
--max_depth INTEGER  Restrict to a max depth. Set to 0 for all files.
                     [default: 1]

--from_root          Return full paths from root of the repo (instead of
                     relative to given path)

-h, --help           Show this message and exit.

`pull` command¶

Usage:

barique file pull [OPTIONS] PATH

Help

Launch a pull task

Output

Id associated to the pull task

Options:

--email TEXT  User email adress for notification
--dry_run     Do not make any pull, just list changes that would be made
-h, --help    Show this message and exit.

`tree` command¶

Usage:

barique file tree [OPTIONS] PATH

Help

List files available from a remote repository for a local path as a tree

Output

None

Options:

--max_depth INTEGER  Restrict to a max depth. Set to 0 for all files.
-h, --help           Show this message and exit.

task¶

This section is auto-generated from the help text for the barique command task.

`list` command¶

Usage:

barique task list [OPTIONS]

Help

List recent tasks

Output

List of tasks

Options:

-h, --help  Show this message and exit.

`log` command¶

Usage:

barique task log [OPTIONS] TASK_ID

Help

Show log from the task with the specified id

Output

Dict

Options:

-h, --help  Show this message and exit.

`remove` command¶

Usage:

barique task remove [OPTIONS] TASK_ID

Help

Remove task with the selected id

Output

Dict

Options:

-h, --help  Show this message and exit.

`show` command¶

Usage:

barique task show [OPTIONS] TASK_ID

Help

Show task with the specified id

Output

Dict

Options:

-h, --help  Show this message and exit.

`zombies` command¶

Usage:

barique task zombies [OPTIONS]

Help

Kill zombie tasks

Output

Task id

Options:

-h, --help  Show this message and exit.

baricadr package¶

Subpackages¶

baricadr.file package¶

Module contents¶

class baricadr.file.FileClient(url, login, password, endpoints)¶

Bases: baricadr.client.Client

Manipulate files managed by Baricadr

freeze(path, force=False, dry_run=False, email='')¶

Launch a freeze task

Parameters

path (str) – Local path to a file or folder to freeze
force (bool) – Force freezing, even if the freezing delay was not reached
dry_run (bool) – Do not make any deletion, just list changes that would be made
email (str) – User email adress for notification

Return type

str

Returns

Id associated to the freeze task

list(path, full=False, missing=False, max_depth=1, from_root=False)¶

List files available from a remote repository for a local path

Parameters

path (str) – Local path
missing (bool) – Only list files missing from the local path
full (bool) – List full information for each file (size (in bytes), mtime, etc..)
max_depth (int) – Restrict to a max depth. Set to 0 for all files.
from_root (bool) – Return full paths from root of the repo (instead of relative to given path)

Return type

list

Returns

List of file relative paths

pull(path, email='', dry_run=False)¶

Launch a pull task

Parameters

path (str) – Local path to a missing file or folder
email (str) – User email adress for notification
dry_run (bool) – Do not make any pull, just list changes that would be made

Return type

str

Returns

Id associated to the pull task

tree(path, max_depth=0)¶

List files available from a remote repository for a local path as a tree

Parameters

path (str) – Local path
max_depth (int) – Restrict to a max depth. Set to 0 for all files.

Return type

None

Returns

None

baricadr.task package¶

Module contents¶

class baricadr.task.TaskClient(url, login, password, endpoints)¶

Bases: baricadr.client.Client

Track progress of Baricadr tasks

list()¶

List recent tasks

Return type: list
Returns: List of tasks

log(task_id)¶

Show log from the task with the specified id

Parameters: task_id (str) – Task id
Return type: dict
Returns: Dict

remove(task_id)¶

Remove task with the selected id

Parameters: task_id (str) – Task id
Return type: dict
Returns: Dict

show(task_id)¶

Show task with the specified id

Parameters: task_id (str) – Task id
Return type: dict
Returns: Dict

zombies()¶

Kill zombie tasks

Return type: dict
Returns: Task id

Submodules¶

baricadr.client module¶

class baricadr.client.Client(url, login, password, endpoints)¶

Bases: object

Base client class implementing methods to make queries to the server

baricadr.exceptions module¶

exception baricadr.exceptions.BaricadrApiError¶

Bases: Exception

Raised when the API returns an error

exception baricadr.exceptions.BaricadrConnectionError¶

Bases: Exception

Raised when the connection to the Barricadr server fails

exception baricadr.exceptions.BaricadrNotImplementedError¶

Bases: Exception

Raised when there are not endpoint associated with this function

Module contents¶

class baricadr.BaricadrInstance(url='http://localhost:9100/', login=None, password=None, **kwargs)¶: Bases: object

Barique - Python client for Baricadr¶

Barique¶

Installation¶

Examples¶

License¶

Commands¶

file¶

freeze command¶

list command¶

pull command¶

tree command¶

task¶

list command¶

log command¶

remove command¶

show command¶

zombies command¶

baricadr package¶

Subpackages¶

baricadr.file package¶

Module contents¶

baricadr.task package¶

Module contents¶

Submodules¶

baricadr.client module¶

baricadr.exceptions module¶

Module contents¶

Indices and tables¶

`freeze` command¶

`list` command¶

`pull` command¶

`tree` command¶

`list` command¶

`log` command¶

`remove` command¶

`show` command¶

`zombies` command¶