Installation

To use DataFS, you’ll need to install DataFS and a working combination of Managers and Services.

Installing DataFS

Stable release

To install DataFS Data Management System, run this command in your terminal:

$ pip install datafs

This is the preferred method to install DataFS Data Management System, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for DataFS Data Management System can be downloaded from the Github repo.

You can either clone the public repository:

Or download the tarball:

Once you have a copy of the source, you can install it with:

Additional dependencies

In addition to DataFS, you’ll need to install and configure a manager and any services you’d like to use.

See the Examples to see managers and services in use.

Managers

You’ll need to connect to a MongoDB or DynamoDB database to use DataFS. These can be local installs for demos/testing/personal use or full installations for teams.

You can download the local installations here:

To connect to these databases, you’ll need to install the python interfaces to them:

  • MongoDB: pip install pymongo
  • DynamoDB: pip install boto3

To configure a manager for datafs, you’ll need to be able to connect to the database using these interfaces. For help, check out their documentation:

Services

Similar to Managers, you’ll need data at least one storage service to use DataFS. For local/testing/personal use, a local directory can be useful, and is the easiest to set up.

  • Ready out-of-the-box:
    • local
    • shared
    • mounted
    • zip
    • ftp
    • http/https
    • in-memory
  • Requiring additional packages:
    • AWS/S3: pip install boto
    • SFTP: pip install paramiko
    • XMLRPC: pip install xmlrpclib