https://github.com/s3git/s3git-go
SDK package in Golang for s3git: git for Cloud Storage
https://github.com/s3git/s3git-go
Last synced: 3 months ago
JSON representation
SDK package in Golang for s3git: git for Cloud Storage
- Host: GitHub
- URL: https://github.com/s3git/s3git-go
- Owner: s3git
- License: apache-2.0
- Created: 2016-02-29T12:16:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-26T17:49:08.000Z (about 9 years ago)
- Last Synced: 2025-04-02T00:38:30.965Z (3 months ago)
- Language: Go
- Homepage: http://s3git.org
- Size: 171 KB
- Stars: 48
- Watchers: 6
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
s3git-go
========
[](https://gitter.im/s3git/s3git?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
This is the go SDK package for s3git.
For brevity reasons, error handling and other boilerplate code like package naming etc. is not shown in the examples. Actual client code should always check for errors, see [s3git](https://github.com/s3git/s3git) as an example.
**DISCLAIMER: This software is still under development (although the storage format/model using BLAKE2 hashing is stable) -- use at your own peril for now**
**Note that the API is not stable yet, you can expect minor changes**
BLAKE2 Tree Hashing
-------------------
If you would like to understand how s3git uses the BLAKE2 Tree hashing mode please see [here](https://github.com/s3git/s3git/blob/master/BLAKE2.md).
Development environment
-----------------------
See [here](https://github.com/s3git/s3git#building-from-source) for setting up the development environment.
Create a repository
-------------------
```go
import "github.com/s3git/s3git-go"
// Create repo
repo, _ := s3git.InitRepository(".")
// Add some data
repo.Add(strings.NewReader("hello s3git"))
// Commit changes
repo.Commit("Initial commit")
// List commits
commits, _ := repo.ListCommits("")
for commit := range commits {
fmt.Println(commit)
}
```
See [here](https://github.com/s3git/s3git-go/blob/master/examples/create.go) for the full example (and others). And run like this:
```sh
$ cd $GOPATH/src/github.com/s3git/s3git-go/examples
$ go run create.go
```
Clone a repository
------------------
```go
import "github.com/s3git/s3git-go"
options := []s3git.CloneOptions{}
options = append(options, s3git.CloneOptionSetAccessKey("AKIAJYNT4FCBFWDQPERQ"))
options = append(options, s3git.CloneOptionSetSecretKey("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"))
// Clone a repo
repo, _ := s3git.Clone("s3://s3git-spoon-knife", ".", options...)
// List contents
list, _ := repo.List("")
for l := range list {
fmt.Println(l)
}
```
Make changes and push
---------------------
```go
import "github.com/s3git/s3git-go"
repo, _ := s3git.OpenRepository(".")
repo.Add(strings.NewReader(fmt.Sprint(time.Now())))
repo.Commit("New commit")
hydrate := false // For explanation, see https://github.com/s3git/s3git/blob/master/BLAKE2.md#hydrated
repo.Push(hydrate)
```
See [change_and_push.go](https://github.com/s3git/s3git-go/blob/master/examples/change_and_push.go).
Pull down changes
-----------------
```go
import "github.com/s3git/s3git-go"
repo, _ := s3git.OpenRepository(".")
repo.Pull()
repo.Log()
```
Extract data
------------
```go
import "github.com/s3git/s3git-go"
repo, _ := s3git.OpenRepository(".")
r, _ := repo.Get("012345678")
io.Copy(os.Stdout, r)
```
Clone a repository with progress
--------------------------------
```go
import "github.com/s3git/s3git-go"
repo, _ := s3git.Clone("s3://s3git-100m", ".")
```
Contributions
-------------
Contributions are welcome! Please see [`CONTRIBUTING.md`](CONTRIBUTING.md).
License
-------
s3git-go is released under the Apache License v2.0. You can find the complete text in the file LICENSE.