Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xis/baraka
a tool for handling file uploads simple
https://github.com/xis/baraka
api baraka contributions-welcome file file-upload filtering filters go golang help-wanted http images multipart multipart-uploads parser simple upload upload-file
Last synced: 14 days ago
JSON representation
a tool for handling file uploads simple
- Host: GitHub
- URL: https://github.com/xis/baraka
- Owner: xis
- License: mit
- Created: 2020-07-12T21:56:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-30T18:10:43.000Z (about 2 years ago)
- Last Synced: 2024-07-31T20:51:25.740Z (3 months ago)
- Topics: api, baraka, contributions-welcome, file, file-upload, filtering, filters, go, golang, help-wanted, http, images, multipart, multipart-uploads, parser, simple, upload, upload-file
- Language: Go
- Homepage:
- Size: 79.1 KB
- Stars: 53
- Watchers: 2
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - baraka - A library to process http file uploads easily. (File Handling / Search and Analytic Databases)
- awesome-go-extra - baraka - 07-12T21:56:50Z|2022-07-22T20:31:47Z| (File Handling / Advanced Console UIs)
README
▄▄▄▄ ▄▄▄ ██▀███ ▄▄▄ ██ ▄█▀▄▄▄
▓█████▄ ▒████▄ ▓██ ▒ ██▒▒████▄ ██▄█▒▒████▄
▒██▒ ▄██▒██ ▀█▄ ▓██ ░▄█ ▒▒██ ▀█▄ ▓███▄░▒██ ▀█▄
▒██░█▀ ░██▄▄▄▄██ ▒██▀▀█▄ ░██▄▄▄▄██ ▓██ █▄░██▄▄▄▄██
░▓█ ▀█▓ ▓█ ▓██▒░██▓ ▒██▒ ▓█ ▓██▒▒██▒ █▄▓█ ▓██▒
░▒▓███▀▒ ▒▒ ▓▒█░░ ▒▓ ░▒▓░ ▒▒ ▓▒█░▒ ▒▒ ▓▒▒▒ ▓▒█░
▒░▒ ░ ▒ ▒▒ ░ ░▒ ░ ▒░ ▒ ▒▒ ░░ ░▒ ▒░ ▒ ▒▒ ░
░ ░ ░ ▒ ░░ ░ ░ ▒ ░ ░░ ░ ░ ▒
░ ░ ░ ░ ░ ░░ ░ ░ ░
░
[](https://goreportcard.com/report/github.com/xis/baraka)
[](https://codecov.io/gh/xis/baraka)
[](https://travis-ci.org/xis/baraka)
[](https://pkg.go.dev/github.com/xis/baraka/v2)
a tool for handling file uploads for http servers
makes it easier to make operations with files from the http request.
## Contents
- [Install](#Install)
- [Simple Usage](#Simple-Usage)
- [Filtering Parts](#Filtering-Parts)
- [More](#More)
- [Contribute](#Contribute)
- [License](#License)
## Install
```bash
go get github.com/xis/baraka/v2
```
## Simple Usage
```go
func main() {
// create a parser
parser := baraka.NewParser(baraka.ParserOptions{
MaxFileSize: 5 << 20,
MaxFileCount: 5,
MaxParseCount: 5,
})
store := baraka.NewFilesystemStorage("./files")
router := gin.Default()
router.POST("/upload", func(c *gin.Context) {
// parse
request, err := parser.Parse(c.Request)
if err != nil {
fmt.Println(err)
}
// get the form
images, err := request.GetForm("images")
if err != nil {
fmt.Println(err)
}
// save
for key, image := range images {
err = store.Save("images", "image_"+strconv.Itoa(key), image)
if err != nil {
fmt.Println(err)
}
}
})
router.Run()
}
```
You can use baraka with the other http server libraries, just pass the http.Request to the parser.Parse function.
## Filtering Parts
You can filter parts by their properties, like part's content type. Parser can inspect the part's bytes and detect the type of the part with the Inspector.
```go
// create a parser
parser := baraka.NewParser(baraka.ParserOptions{
MaxFileSize: 5 << 20,
MaxFileCount: 5,
MaxParseCount: 5,
})
// give parser an inspector
parser.SetInspector(baraka.NewDefaultInspector(512))
// give parser a filter
parser.SetFilter(baraka.NewExtensionFilter(".jpg"))
```
Now parser will inspect the each part and it will just return the jpeg ones from the Parse function. You can make your own Inspector and Filter.
## Contribute
Pull requests are welcome. please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)