attachi 0.2.0

Copyright (c) 2018 QBiC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Description: # Attachi
[](https://img.shields.io/github/languages/top/qbicsoftware/attachi-cli.svg)
[](https://travis-ci.org/qbicsoftware/attachi-cli)
[](https://www.python.org/downloads/release/python-350/)
[](https://www.python.org/downloads/release/python-360/)


A small helper script, that creates the folder structure needed to register files as attachment to openBIS.

## Installation

### Stable release from PyPi:

``pip install attachi``

### Current master branch:

``pip install git+https://github.com/qbicsoftware/attachi-cli``

or from a specific branch:

``pip install git+https://github.com/qbicsoftware/attachi-cli@<branch>``

## Run

```pyhton
> attachi --help
Usage: attachi [OPTIONS] PROJECTID FILE COMMENT

Attachi - A helper tool that prepares attachments for openBIS registration

Options:
-t, --atype TYPE Type of attachment: Information or Results (default)
-u, --user ID Username shown in openbis as uploader
-o, --outdir PATH Output folder path
--version Show the version and exit.
--help Show this message and exit.

# Example

Creating the folder structure for an upload:

```python

attachi -u myusername QABCD README.md "this is a test for uploading the readme file"

#--> folder QABCD000AQ_20180627102707758164 is created
```

Use tar and dync to upload the file to openBIS:

```bash
tar -c QABCD000AQ_20180627102707758164 | dync -n QABCD000AQ_20180627102707758164.tar -k untar:True data.qbic.uni-tuebingen.de
```

Keywords: openbis,attachment
Platform: UNKNOWN