Overview¶
tport
is a simple command line tool written in Python for
all your JSON transporting needs. Tools currently supported:
- Amazon S3
- Elastic Search
- Kafka
- MongoDB
- HBase
Requirements¶
- Unix based machine (Linux or OS X)
- Python 2.7.x
This tool has been tested on CentOS 6.5, Ubuntu 14.04, and MacOSX 10.10.5.
If you wish to install in a different environment I highly recommend installing
inside a Python virtualenv
. Setting up a virtual environment is outside the scope
of this document.
Quickstart¶
pip install json-transporter
- Add your specific connections to a .tport file in your home directory. For example,
[elasticsearch]
host = localhost:9200
ssl = False
[kafka]
broker = localhost:9092
[s3]
access_key = my_access_key
secret_key = my_secret_key
[mongo]
host = localhost
db = test
[hbase]
host = localhost
- To view command line usage just type
tport --help
Configuration¶
If tport
does not find the relevant settings on the command line or the .tport file, it will resort to the default settings for each tools. For example,
localhost:9200
–> Elastic searchlocalhost:9092
–> Kafka
Connection settings such as the host and db can also be specified on the command line. Anything specified on the command line will have presedence over settings in files. Order of precedence:
- command line
- .tport
- defaults
JSON Transporter CLI¶
Once installed, tport
takes serialized JSON text files from the command line
and transporter it to a supported tool.
JSON Transporter API¶
If you wish to create your own CLI scripts you can from transporter import tools in your code to leverage the JSON transporter API.