A Go implementation of distribusi
Go to file
decentral1se 08502d7767
docs: add new authors to license
2022-02-04 13:43:25 +01:00
.gitea/issue_template refactor: less bureaucracy, just use labels 2022-02-04 12:04:44 +01:00
.gitignore fix: include custom css once more 2022-02-01 16:18:01 +01:00
AUTHORS.md docs: quote & sort 2022-02-04 13:38:54 +01:00
LICENSE docs: add new authors to license 2022-02-04 13:43:25 +01:00
README.md docs: add link to license 2022-02-04 13:39:28 +01:00
distribusi docs: generalise authors once more 2022-02-04 13:40:51 +01:00
distribusi.go docs: generalise authors once more 2022-02-04 13:40:51 +01:00
go.mod init 2022-02-01 16:07:22 +01:00
go.sum init 2022-02-01 16:07:22 +01:00

README.md

distribusi-go

This is still very experimental, please take a backup of your archives if you are running it on files you care about. It hasn't been tested on large archives. There are probably some pretty bad bugs lurking in there. It may still thrash files. Please report issues as you find them 💯 Thanks for testing!

A Go implementation of distribusi.

If you're migrating from the Python version or have experience using it, here are the differences in distribusi-go:

  • It's simpler to install on your computer, just download the binary, chmod +x and run it 💯

  • There is no need to install Pillow for handling images, that is now built-in. The only external dependency is exiftool for image captions from embedded metadata. If you don't have exiftool installed, then it gracefully skips that feature. So, you don't need to install anything else to run distribusi now 🙏

  • The command-line interface is quite different. There are less optional flags and more defaults. I shuffled a number of things around according to my preferences (open to changes, please open a ticket). For example, I always like my images to be thumbnail'd. There's a handy web server built-in now, just run with -s 🤘

Install

curl https://git.vvvvvvaria.org/decentral1se/distribusi-go/raw/branch/main/distribusi -o distribusi
chmod +x distribusi
./distribusi

Quick start

Run distribusi-go on <path> and serve it locally for viewing:

./distribusi -p <path> -s

If you want to ignore certain paths, you can use -i/--ignore:

./distribusi -p <path> -s -i '*.gif, *.md, mydir'

It supports a list of patterns in a comma separated list, wildcards work, more here.

If you run into issues, run with -d/--debug to see what is happening under the hood.

✌️

Hacking

You'll need Go >= 1.11 installed. Run go build . to build a new ./distribusi executable.

If you wanna learn Go, I've got this book, feel free to take a loan of it 😀

Acknowledgements

AUTHORS.md

License

LICENSE