Brocoli: Browse Collections for iRODS
======================================
Brocoli_ application allows users to browse iRODS catalog collections in a simple
Tkinter GUI.
.. _Brocoli: https://github.com/mesocentre-mcia/brocoli
Install Brocoli
---------------
Pre-requisites
^^^^^^^^^^^^^^
Brocoli runs on Linux platforms. Windows and MacOS support is experimental.
Brocoli needs a Python installation with Tkinter. Under
`Ubuntu <http://www.ubuntu.com>`, you may have to install a specific package to
get Tkinter.
Python 2.7+ and 3.5+ are expected to work.
Dependencies
^^^^^^^^^^^^
Brocoli depends on the following packages:
- six: https://pypi.python.org/pypi/six
- python-irodsclient >= 0.8.0: https://pypi.python.org/pypi/python-irodsclient
Installing with pip
^^^^^^^^^^^^^^^^^^^
From a command shell, run:
``pip install brocoli [--user]``
If you don't have administrative privileges, you may need to use the ``--user``
optional argument, in order to install Brocoli in your user account.
Installing from source
^^^^^^^^^^^^^^^^^^^^^^
#) Download Brocoli from https://github.com/mesocentre-mcia/brocoli
#) from distribution directory, run ``python setup.py install [--user]``
If you don't have administrative privileges, you may need to use the ``--user``
optional argument, in order to install Brocoli in your user account.
Using Brocoli
-------------
Run brocoli from a command shell:
``$ brocoli``
Connections
^^^^^^^^^^^
At first run, Brocoli will appear empty. You will want to create a more
useful connection with an iRODS catalog. Just configure it following the menus:
Settings -> New Connection
This will open a dialog where you can set the connection configuration. The
configuration fields are:
* ``Connection name`` - choose a name to identify the connection
* ``Catalog type`` - choose ``os``, ``irods3`` or ``irods4``. Currently,
``irods*`` are the only useful catalogs available (``os`` is used for testing
purposes only)
* ``Root path`` - enter the catalog path you want to base your display from
* ``Make default connection`` - check if you want Brocoli to open this
connection at startup
* ``Perform local checksum`` - configures brocoli to verify checksum of
downloaded/uploaded files against catalog registered checksum (if available)
``irods3`` specific configuration fields:
* ``Use irods environment file`` - check if you want to use iRODS iCommands
configuration file (usually ``~/.irods/.irodsEnv`` fr v3 instances and
``~/.irods/irods_environment.json`` for v4)
* ``iRODS host`` - the iRODS server DNS name you want to connect to (usually
your iCAT Enabled Server)
* ``iRODS port`` - depending on your iRODS instance (1247 is the default)
* ``iRODS zone`` - the name of your iRODS zone
* ``iRODS user name`` - your iRODS account name
* ``iRODS default resource`` - the iRODS resource to use (optional)
* ``Remember password`` - check if you want Brocoli to store your iRODS password
(**dangerous**: although Brocoli scrambles the stored password, it may be easy
to unscramble for someone who gained access to that value)
* ``iRODS password``
``irods4`` connections have a few extra configuration fields:
* ``Default hash scheme`` - choose checksum hash method among available
algorithms
* ``irods_client_server_policy`` - iRODS client/server negociation behaviour
* ``Use irods SSL transfer`` - check if you need SSL communication with your
catalog
* ``irods_encryption_algorithm`` - SSL specific setting depending on your
catalog configuration
* ``irods_encryption_key_size`` - SSL specific setting depending on your catalog
configuration
* ``irods_encryption_num_hash_rounds`` - SSL specific setting depending on your
catalog configuration
* ``irods_encryption_salt_size`` - SSL specific setting depending on your
catalog configuration
* ``irods_ssl_ca_certificate_file`` - SSL specific setting depending on your
catalog configuration
Now, you should be able to switch to the newly created connection by following:
Settings -> Switch connection -> Your new connection name
Navigating
^^^^^^^^^^
Sub-directories can be opened by clicking on the triangle icon before their
name.
You can base the display from a sub-directory by choosing ``Go to`` in the popup
menu or entering its path directly in the navigation bar.
The ``.`` special entry refers to the currently displayed directory (the path
displayed in the navigation bar).
The ``..`` special entry appears when visiting a subdirectory of the connection
root path. It refers to the current path parent directory.
File operations
^^^^^^^^^^^^^^^
Operations on files and directories are accessible in a popup menu shown when
right clicking on the target.
File/directory operations
* ``Download to local disk`` - download selected entry (recursively) to your
local computer
* ``Delete`` - delete selected entry (recursively) from the catalog
* ``Properties`` - displays catalog specific properties of the selected entry
Directory only operations
* ``New directory`` - creates a subdirectory of the selected directory
* ``Upload local files`` - uploads local files into the catalog under the
selected directory
* ``Recursive upload`` - recursively uploads the contents of a local directory
to the catalog
* ``Go to`` - rebase Brocoli navigation bar to the selected directory
Raw data
{
"_id": null,
"home_page": "https://github.com/mesocentre-mcia/brocoli",
"name": "brocoli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": null,
"keywords": "irods, tkinter",
"author": "Pierre Gay",
"author_email": "pierre.gay@u-bordeaux.fr",
"download_url": "https://files.pythonhosted.org/packages/5c/65/5320cb1c51368d8a82705255e83020d64909554eab67e043f95bc165feac/brocoli-0.7.3.tar.gz",
"platform": null,
"description": "Brocoli: Browse Collections for iRODS\n======================================\n\nBrocoli_ application allows users to browse iRODS catalog collections in a simple\nTkinter GUI.\n\n.. _Brocoli: https://github.com/mesocentre-mcia/brocoli\n\nInstall Brocoli\n---------------\n\nPre-requisites\n^^^^^^^^^^^^^^\n\nBrocoli runs on Linux platforms. Windows and MacOS support is experimental.\n\nBrocoli needs a Python installation with Tkinter. Under\n`Ubuntu <http://www.ubuntu.com>`, you may have to install a specific package to\nget Tkinter.\n\nPython 2.7+ and 3.5+ are expected to work.\n\nDependencies\n^^^^^^^^^^^^\n\nBrocoli depends on the following packages:\n\n- six: https://pypi.python.org/pypi/six\n- python-irodsclient >= 0.8.0: https://pypi.python.org/pypi/python-irodsclient\n\nInstalling with pip\n^^^^^^^^^^^^^^^^^^^\n\nFrom a command shell, run:\n\n ``pip install brocoli [--user]``\n\nIf you don't have administrative privileges, you may need to use the ``--user``\noptional argument, in order to install Brocoli in your user account.\n\nInstalling from source\n^^^^^^^^^^^^^^^^^^^^^^\n\n#) Download Brocoli from https://github.com/mesocentre-mcia/brocoli\n#) from distribution directory, run ``python setup.py install [--user]``\n\nIf you don't have administrative privileges, you may need to use the ``--user``\noptional argument, in order to install Brocoli in your user account.\n\nUsing Brocoli\n-------------\n\nRun brocoli from a command shell:\n\n ``$ brocoli``\n\nConnections\n^^^^^^^^^^^\n\nAt first run, Brocoli will appear empty. You will want to create a more\nuseful connection with an iRODS catalog. Just configure it following the menus:\n\n Settings -> New Connection\n\nThis will open a dialog where you can set the connection configuration. The\nconfiguration fields are:\n\n* ``Connection name`` - choose a name to identify the connection\n* ``Catalog type`` - choose ``os``, ``irods3`` or ``irods4``. Currently,\n ``irods*`` are the only useful catalogs available (``os`` is used for testing\n purposes only)\n* ``Root path`` - enter the catalog path you want to base your display from\n* ``Make default connection`` - check if you want Brocoli to open this\n connection at startup\n* ``Perform local checksum`` - configures brocoli to verify checksum of\n downloaded/uploaded files against catalog registered checksum (if available)\n\n``irods3`` specific configuration fields:\n\n* ``Use irods environment file`` - check if you want to use iRODS iCommands\n configuration file (usually ``~/.irods/.irodsEnv`` fr v3 instances and\n ``~/.irods/irods_environment.json`` for v4)\n* ``iRODS host`` - the iRODS server DNS name you want to connect to (usually\n your iCAT Enabled Server)\n* ``iRODS port`` - depending on your iRODS instance (1247 is the default)\n* ``iRODS zone`` - the name of your iRODS zone\n* ``iRODS user name`` - your iRODS account name\n* ``iRODS default resource`` - the iRODS resource to use (optional)\n* ``Remember password`` - check if you want Brocoli to store your iRODS password\n (**dangerous**: although Brocoli scrambles the stored password, it may be easy\n to unscramble for someone who gained access to that value)\n* ``iRODS password``\n\n``irods4`` connections have a few extra configuration fields:\n\n* ``Default hash scheme`` - choose checksum hash method among available\n algorithms\n* ``irods_client_server_policy`` - iRODS client/server negociation behaviour\n* ``Use irods SSL transfer`` - check if you need SSL communication with your\n catalog\n* ``irods_encryption_algorithm`` - SSL specific setting depending on your\n catalog configuration\n* ``irods_encryption_key_size`` - SSL specific setting depending on your catalog\n configuration\n* ``irods_encryption_num_hash_rounds`` - SSL specific setting depending on your\n catalog configuration\n* ``irods_encryption_salt_size`` - SSL specific setting depending on your\n catalog configuration\n* ``irods_ssl_ca_certificate_file`` - SSL specific setting depending on your\n catalog configuration\n\nNow, you should be able to switch to the newly created connection by following:\n\n Settings -> Switch connection -> Your new connection name\n\nNavigating\n^^^^^^^^^^\n\nSub-directories can be opened by clicking on the triangle icon before their\nname.\n\nYou can base the display from a sub-directory by choosing ``Go to`` in the popup\nmenu or entering its path directly in the navigation bar.\n\nThe ``.`` special entry refers to the currently displayed directory (the path\ndisplayed in the navigation bar).\n\nThe ``..`` special entry appears when visiting a subdirectory of the connection\nroot path. It refers to the current path parent directory.\n\nFile operations\n^^^^^^^^^^^^^^^\n\nOperations on files and directories are accessible in a popup menu shown when\nright clicking on the target.\n\nFile/directory operations\n\n* ``Download to local disk`` - download selected entry (recursively) to your\n local computer\n* ``Delete`` - delete selected entry (recursively) from the catalog\n* ``Properties`` - displays catalog specific properties of the selected entry\n\nDirectory only operations\n\n* ``New directory`` - creates a subdirectory of the selected directory\n* ``Upload local files`` - uploads local files into the catalog under the\n selected directory\n* ``Recursive upload`` - recursively uploads the contents of a local directory\n to the catalog\n* ``Go to`` - rebase Brocoli navigation bar to the selected directory\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Browse Collections for iRODS",
"version": "0.7.3",
"project_urls": {
"Homepage": "https://github.com/mesocentre-mcia/brocoli"
},
"split_keywords": [
"irods",
" tkinter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c655320cb1c51368d8a82705255e83020d64909554eab67e043f95bc165feac",
"md5": "c4831c7ed6fd94adc8b7ccd0887fd152",
"sha256": "fc9555e79f577ff9a77717195c1fd02c8608e458f2c95d9e0cde9ddab9eaa750"
},
"downloads": -1,
"filename": "brocoli-0.7.3.tar.gz",
"has_sig": false,
"md5_digest": "c4831c7ed6fd94adc8b7ccd0887fd152",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 31554,
"upload_time": "2025-01-14T21:46:45",
"upload_time_iso_8601": "2025-01-14T21:46:45.150978Z",
"url": "https://files.pythonhosted.org/packages/5c/65/5320cb1c51368d8a82705255e83020d64909554eab67e043f95bc165feac/brocoli-0.7.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 21:46:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mesocentre-mcia",
"github_project": "brocoli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "brocoli"
}
JSON
