Newer
Older
sisyphe-go / README.md
@Nacim Nacim on 16 Mar 2022 1 KB fix bugs

sisyphe

Sisyphe-GO

Sisyphe is a generic Golang recursive folder analyser terminal application

Sisyphe-pic

Requirements

Tested with Golang 1.18

Works on Linux/OSX/Windows

Mount a corpus folder and :

docker-compose up -d
docker exec -it sisyphe_go_go_1 go run . -n corpusName -c corpuspath -o outputpath

Install it on local

  1. Download the latest Sisyphe-go version
  2. Just do : go build .
  3. ... that's it.

Help

go run . --help Will output help

Options

--help      Output usage
-c          Configuration folder path
-n          Corpus name (default "test")
-o          Output directory where results are written
-p          Corpus path
-w          Counting word on pdf
-noindex    Disable indexation after process

How it works ?

Just start Sisyphe on a folder with any files in it.

go run . ~/Documents/customfolder/corpus -n corpusname -o outputpath

go run . ~/Documents/customfolder/corpus -n corpusname -c ~/Documents/customfolder/corpusResources -o outputpath

Sisyphe is now working in background with all your computer thread. Just take a coffee and wait , it will prevent you when it's done :)

The results of sisyphe are present @ sisyphe/out/{timestamp}-corpusName/ (errors,info,duration..)

Test

Just run go test

For cover go test -cover

Modules

  • PDF Usage of poppler lib (pdftotext and pdfinfo)
  • XML Usage of xml lib (xmlstarlet and xmllint)