Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joseluisq/compactor
Tar/Gzip and Zip archive utilities with optional checksum computation.
https://github.com/joseluisq/compactor
archiving checksum compression golang golang-package gzip tar zip
Last synced: 6 days ago
JSON representation
Tar/Gzip and Zip archive utilities with optional checksum computation.
- Host: GitHub
- URL: https://github.com/joseluisq/compactor
- Owner: joseluisq
- License: apache-2.0
- Created: 2020-10-25T22:27:27.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-13T23:20:15.000Z (almost 4 years ago)
- Last Synced: 2024-04-22T14:22:58.939Z (7 months ago)
- Topics: archiving, checksum, compression, golang, golang-package, gzip, tar, zip
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Compactor [](https://travis-ci.com/joseluisq/compactor) [](https://codecov.io/gh/joseluisq/compactor) [](https://goreportcard.com/report/github.com/joseluisq/compactor) [](https://pkg.go.dev/github.com/joseluisq/compactor)
> [Tar](https://golang.org/pkg/archive/tar/)/[Gzip](https://golang.org/pkg/compress/gzip/) and [Zip](https://golang.org/pkg/archive/zip/) archive utilities with optional [checksum](https://en.wikipedia.org/wiki/Checksum) computation.
## Usage
### Tar/Gzip
```go
package main
import (
"github.com/joseluisq/compactor"
)
func main() {
compactor.CreateTarballWithChecksum(
// 1. a base input path directory (it will be skipped for each archive header)
"./my-base-dir",
// 2. archive input file or directory
"./my-file-or-dir",
// 3. archive output file
"~/my-archive.tar.gz",
// 4. checksum algorithm
"sha256",
// 5. checksum output file
"~/my-archive.CHECKSUM.txt",
)
// output files:
// ~/my-archive.tar.gz
// ~/my-archive.sha256.tar.txt
}
```
### Zip
```go
package main
import (
"github.com/joseluisq/compactor"
)
func main() {
compactor.CreateZipballWithChecksum(
// 1. a base input path directory (it will be skipped for each archive header)
"./my-base-dir",
// 2. archive input file or directory
"./my-file-or-dir",
// 3. archive output file
"~/my-archive.zip",
// 4. checksum algorithm
"sha256",
// 5. checksum output file
"~/my-archive.CHECKSUM.zip.txt",
)
// output files:
// ~/my-archive.zip
// ~/my-archive.sha256.zip.txt
}
```
For more API functionalities take a look at https://pkg.go.dev/github.com/joseluisq/compactor
## Contributions
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in current work by you, as defined in the Apache-2.0 license, shall be dual licensed as described below, without any additional terms or conditions.
Feel free to send some [Pull request](https://github.com/joseluisq/compactor/pulls) or [issue](https://github.com/joseluisq/compactor/issues).
## License
This work is primarily distributed under the terms of both the [MIT license](LICENSE-MIT) and the [Apache License (Version 2.0)](LICENSE-APACHE).
© 2020-present [Jose Quintana](https://git.io/joseluisq)