[{"_1":2,"_191":-5,"_192":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_168":169},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_95":96,"_119":120,"_157":-5,"_158":11,"_159":21,"_160":11,"_161":-5,"_162":11,"_163":-5,"_164":165,"_166":121,"_167":-7},"canonicalUrl","https://hub.docker.com/r/fnndsc/pfstorage/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","fnndsc","reponame","pfstorage","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_50":51,"_53":54,"_55":56,"_57":11,"_58":59,"_60":61,"_62":63,"_43":35,"_32":33,"_65":66,"_67":52,"_68":69,"_70":71,"_72":73,"_74":-5,"_75":69,"_76":77,"_78":11,"_79":33,"_80":81,"_86":11,"_87":88,"_92":33,"_93":94},"categories",[42,47],{"_43":44,"_45":46},"name","Security","slug","security",{"_43":48,"_45":49},"Databases & storage","databases-and-storage","content_types",[52],"image","date_registered","2019-08-15T19:55:22.86373Z","description","","is_private","last_updated","2020-02-14T17:21:14.269386Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[64],"application/vnd.docker.container.image.v1+json","pull_count",5952,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","###################\npfstorage v2.0.0.2\n###################\n\n.. image:: https://badge.fury.io/py/pfstorage.svg\n :target: https://badge.fury.io/py/pfstorage\n\n.. image:: https://travis-ci.org/FNNDSC/pfstorage.svg?branch=master\n :target: https://travis-ci.org/FNNDSC/pfstorage\n\n.. image:: https://img.shields.io/badge/python-3.5%2B-blue.svg\n :target: https://badge.fury.io/py/pfcon\n\n.. contents:: Table of Contents\n\n********\nOverview\n********\n\nThis repository provides ``pfstorage`` -- a library / module that speaks to an object storage backend (such as *swift*) and also provides logic for handling input/output data locations for the ChRIS system.\n\npfstorage\n=========\n\nMost simply, ``pfstorage`` is a module that offers a regularized interface to some other backend object storage. While currently supporting ``swift``, the long term idea is to support a multitude of backends. By providing its own interface to several storage backends, this module removes the need for client code to change when a different object storage backend is used.\n\nWhile at its core a module/library, ``pfstorage`` also provides two modes of stand-alone access: (1) a command line script interface mode to the library, and (2) a persistent http server mode. In the command line mode, the main module functions are exposed to appropriate CLI. In the http server mode, a client can use curl-type http calls to call the underlying library functions.\n\n************\nInstallation\n************\n\nInstallation is relatively straightforward, and we recommend using either python virtual environments or docker.\n\nPython Virtual Environment\n==========================\n\nOn Ubuntu, install the Python virtual environment creator\n\n.. code-block:: bash\n\n sudo apt install virtualenv\n\nThen, create a directory for your virtual environments e.g.:\n\n.. code-block:: bash\n\n mkdir ~/python-envs\n\nYou might want to add to your .bashrc file these two lines:\n\n.. code-block:: bash\n\n export WORKON_HOME=~/python-envs\n source /usr/local/bin/virtualenvwrapper.sh\n\nNote that depending on distro, the virtualenvwrapper.sh path might be\n\n.. code-block:: bash\n\n /usr/share/virtualenvwrapper/virtualenvwrapper.sh\n\nSubsequently, you can source your ``.bashrc`` and create a new Python3 virtual environment:\n\n.. code-block:: bash\n\n source .bashrc\n mkvirtualenv --python=python3 python_env\n\nTo activate or \"enter\" the virtual env:\n\n.. code-block:: bash\n\n workon python_env\n\nTo deactivate virtual env:\n\n.. code-block:: bash\n\n deactivate\n\nUsing the ``fnndsc/pfstorage`` docker container\n================================================\n\nThe easiest option however, is to just use the ``fnndsc/pfstorage`` dock.\n\n.. code-block:: bash\n\n docker pull fnndsc/pfstorage\n \nand then run (for example in http server mode access to the library):\n\n.. code-block:: bash\n\n docker run --name pfstorage -v /home:/Users --rm -ti \\\n fnndsc/pfstorage \\\n --ipSwift localhost \\\n --portSwift 8080 \\\n --forever \\\n --httpResponse \\\n --server\n\nor in CLI mode:\n\n.. code-block:: bash\n\n docker run --name pfstorage -v /home:/Users --rm -ti \\\n fnndsc/pfstorage \\\n --ipSwift localhost \\\n --portSwift 8080 \\\n --msg '\n { \"action\": \"ls\",\n \"meta\": {\n \"path\": \"\", \n \"retSpec\": [\"name\", \"bytes\"]\n } \n }'\n \n\n*****\nUsage\n*****\n\nFor usage of ``pfstorage``, consult the relevant wiki pages `.\n\nCommand line arguments\n======================\n\n.. code-block:: html\n\n --msg ''\n The action to perform. This can be one of:\n\n * objPull -- pull data from storage to file system\n * objPush -- push data from file system to storage\n * ls -- listing of data within storage\n\n with a JSON formatted string similar to:\n\n * ls:\n { \"action\": \"ls\",\n \"meta\": {\n \"path\": \"\", \n \"retSpec\": [\"name\", \"bytes\"]\n } \n }\n\n * objPut:\n { \"action\": \"objPut\",\n \"meta\": {\n \"putSpec\": \"./data\",\n \"inLocation\": \"storage\",\n \"mapLocationOver\": \"./data\"\n }\n } \n\n * objPull:\n { \"action\": \"objPull\",\n \"meta\": {\n \"path\": \"chris\",\n \"substr\": \"/018\",\n \"fromLocation\": \"chris/uploads/DICOM\",\n \"mapLocationOver\": \"./data\"\n }\n } \n\n [--type ]\n The type of object storage. Currently this is 'swift'.\n\n [--ipSwift ] \n The IP interface of the object storage service. Default %s.\n\n [--portSwift ]\n The port of the object storage service. Defaults to '8080'.\n\n [--ipSelf ] \n The IP interface of the pfstorage service for server mode. Default %s.\n\n [--portSelf ]\n The port of the pfstorage service for server mode. Defaults to '4055'.\n\n [--httpResponse]\n In servier mode, send return strings as HTTP formatted replies \n with content-type html.\n\n [--configFileLoad ]\n Load configuration information from the JSON formatted .\n\n [--configFileSave ]\n Save configuration information to the JSON formatted .\n\n [-x|--desc] \n Provide an overview help page.\n\n [-y|--synopsis]\n Provide a synopsis help summary.\n\n [--version]\n Print internal version number and exit.\n\n [--debugToDir ]\n A directory to contain various debugging output -- these are typically\n JSON object strings capturing internal state. If empty string (default)\n then no debugging outputs are captured/generated. If specified, then\n ``pfcon`` will check for dir existence and attempt to create if\n needed.\n\n [-v|--verbosity ]\n Set the verbosity level. \"0\" typically means no/minimal output. Allows for\n more fine tuned output control as opposed to '--quiet' that effectively\n silences everything.\n\n\n********\nEXAMPLES\n********\n\nscript mode\n===========\n\n.. code-block:: bash\n\n pfstorage \\\n --ipSwift localhost \\\n --portSwift 8080 \\\n --verbosity 1 \\\n --debugToDir /tmp \\\n --type swift \\\n --msg ' \n {\n \"action\": \"ls\",\n \"meta\": {\n \"path\": \"\", \n \"retSpec\": [\"name\", \"bytes\"]\n }\n }\n '\n\nserver mode\n===========\n\n*start server*:\n\n.. code-block:: bash\n\n pfstorage \\\n --ipSwift localhost \\\n --portSwift 8080 \\\n --ipSelf localhost \\\n --portSelf 4055 \\\n --httpResponse \\\n --verbosity 1 \\\n --debugToDir /tmp \\\n --type swift \\\n --server \\\n --forever \n\n*query server*:\n\n.. code-block:: bash\n\n pfurl --verb POST --raw \\\n --http localhost:4055/api/v1/cmd \\\n --httpResponseBodyParse \\\n --jsonwrapper 'payload' \\\n --msg '\n {\n \"action\": \"ls\",\n \"meta\": {\n \"path\": \"\",\n \"retSpec\": [\"name\", \"bytes\"]\n }\n }\n '\n","has_starred","hub_user","immutable_tags_settings",{"_82":11,"_83":84},"enabled","rules",[85],".*","is_automated","permissions",{"_89":21,"_90":11,"_91":11},"read","write","admin","user","storage_size",1872770302,"orgData",{"_97":98,"_99":100,"_101":102,"_103":33,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":115,"_116":56,"_117":56,"_118":21},"id","03a1dec4fb87433aad7a0607f4ca6eab","uuid","03a1dec4-fb87-433a-ad7a-0607f4ca6eab","type","organization","orgname","full_name","Fetal-Neonatal Neuroimaging and Developmental Science Center","location","Boston, MA","company","BCH","profile_url","http://fnndsc.babymri.org","date_joined","2017-01-17T17:17:47.098602Z","gravatar_url","https://www.gravatar.com/avatar/ba347fc16cffcc43855ca3aba27f2df5?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[121],{"_122":52,"_123":124,"_125":126,"_97":127,"_128":129,"_58":146,"_147":124,"_148":33,"_149":64,"_43":150,"_151":152,"_153":137,"_154":146,"_155":73,"_156":21},"content_type","creator",1397001,"full_size",252957598,65595731,"images",[130],{"_131":132,"_133":134,"_135":56,"_136":137,"_138":139,"_140":141,"_142":56,"_143":-5,"_144":126,"_70":73,"_145":-5},"architecture","amd64","digest","sha256:b42eca4d49affc6c40655adaf05c6bca3441e55a5ee2f7c14387d394ff049869","features","last_pulled","2026-10-10T10:28:29.098557434Z","last_pushed","2020-02-14T17:21:14Z","os","linux","os_features","os_version","size","variant","2020-02-14T17:21:13.989943Z","last_updater","last_updater_username","media_type","latest","repository",7558139,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":170,"_179":180,"_164":189,"_190":11},{"_40":171,"_50":174,"_53":54,"_55":56,"_57":11,"_58":59,"_60":61,"_62":175,"_43":35,"_32":33,"_65":66,"_67":52,"_68":69,"_70":71,"_72":73,"_74":-5,"_75":69,"_76":77,"_78":11,"_79":33,"_80":176,"_86":11,"_87":178,"_92":33,"_93":94},[172,173],{"_43":44,"_45":46},{"_43":48,"_45":49},[52],[64],{"_82":11,"_83":177},[85],{"_89":21,"_90":11,"_91":11},"tags",{"_181":71,"_182":-5,"_183":-5,"_184":185},"count","next","previous","results",[186],{"_122":52,"_123":124,"_125":126,"_97":127,"_128":187,"_58":146,"_147":124,"_148":33,"_149":64,"_43":150,"_151":152,"_153":137,"_154":146,"_155":73,"_156":21},[188],{"_131":132,"_133":134,"_135":56,"_136":137,"_138":139,"_140":141,"_142":56,"_143":-5,"_144":126,"_70":73,"_145":-5},[],"canDeleteTags","actionData","errors"]

fnndsc/pfstorage

Tags for fnndsc/pfstorage