minio-hs: A Minio Haskell Library for Amazon S3 compatible cloud storage.

[ apache, aws, library, network, object-storage ] [ Propose Tags ]

The Minio Haskell client library provides simple APIs to access Minio, Amazon S3 and other API compatible cloud storage servers.


[Skip to Readme]
Versions 0.0.1, 0.1.0, 0.2.0, 0.2.1, 0.3.0, 0.3.1, 0.3.2, 1.0.0, 1.0.1, 1.1.0, 1.2.0
Change log CHANGELOG.md
Dependencies aeson (>=1.2), base (>=4.7 && <5), base64-bytestring (>=1.0), bytestring (>=0.10), case-insensitive (>=1.2), conduit (>=1.3), conduit-extra (>=1.3), containers (>=0.5), cryptonite (>=0.25), cryptonite-conduit (>=0.2), directory, filepath (>=1.4), http-client (>=0.5), http-conduit (>=2.3), http-types (>=0.12), ini, memory (>=0.14), protolude (==0.2.*), resourcet (>=1.2), text (>=1.2), time (>=1.8), transformers (>=0.5), unliftio (>=0.2), unliftio-core (>=0.1), xml-conduit (>=1.8) [details]
License Apache-2.0
Author Minio Dev Team
Maintainer dev@minio.io
Category Network, AWS, Object Storage
Home page https://github.com/minio/minio-hs#readme
Source repo head: git clone https://github.com/minio/minio-hs
Uploaded by AdityaManthramurthy at Fri Jul 6 17:45:53 UTC 2018
Distributions LTSHaskell:1.2.0, NixOS:1.2.0, Stackage:1.2.0
Downloads 1644 total (204 in the last 30 days)
Rating 2.25 (votes: 2) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-07-06 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Flags

NameDescriptionDefaultType
live-testEnabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for minio-hs-1.2.0

[back to package description]

Minio Client SDK for Haskell Build StatusHackageSlack

The Minio Haskell Client SDK provides simple APIs to access Minio and Amazon S3 compatible object storage server.

Minimum Requirements

Installation

git clone https://github.com/minio/minio-hs.git

cd minio-hs/

stack install

Tests can be run with:


stack test

A section of the tests use the remote Minio Play server at https://play.minio.io:9000 by default. For library development, using this remote server maybe slow. To run the tests against a locally running Minio live server at http://localhost:9000, just set the environment MINIO_LOCAL to any value (and unset it to switch back to Play).

Documentation can be locally built with:


stack haddock

Quick-Start Example - File Uploader

FileUploader.hs

#!/usr/bin/env stack
-- stack --resolver lts-11.1 runghc --package minio-hs --package optparse-applicative --package filepath

--
-- Minio Haskell SDK, (C) 2017, 2018 Minio, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
--     http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--


{-# LANGUAGE OverloadedStrings   #-}
{-# LANGUAGE ScopedTypeVariables #-}
import           Network.Minio

import           Data.Monoid           ((<>))
import           Data.Text             (pack)
import           Options.Applicative
import           System.FilePath.Posix
import           UnliftIO              (throwIO, try)

import           Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000.  The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
--

-- optparse-applicative package based command-line parsing.
fileNameArgs :: Parser FilePath
fileNameArgs = strArgument
               (metavar "FILENAME"
                <> help "Name of file to upload to AWS S3 or a Minio server")

cmdParser = info
            (helper <*> fileNameArgs)
            (fullDesc
             <> progDesc "FileUploader"
             <> header
             "FileUploader - a simple file-uploader program using minio-hs")

main :: IO ()
main = do
  let bucket = "my-bucket"

  -- Parse command line argument
  filepath <- execParser cmdParser
  let object = pack $ takeBaseName filepath

  res <- runMinio minioPlayCI $ do
    -- Make a bucket; catch bucket already exists exception if thrown.
    bErr <- try $ makeBucket bucket Nothing
    case bErr of
      Left (MErrService BucketAlreadyOwnedByYou) -> return ()
      Left e                                     -> throwIO e
      Right _                                    -> return ()

    -- Upload filepath to bucket; object is derived from filepath.
    fPutObject bucket object filepath def

  case res of
    Left e   -> putStrLn $ "file upload failed due to " ++ (show e)
    Right () -> putStrLn "file upload succeeded."

Run FileUploader

./FileUploader.hs "path/to/my/file"

Contribute

Contributors Guide