k0pernicus/zou

A simple and fast download accelerator, written in Rust

zou

A simple and fast download accelerator, written in Rust

Zou is a Snatch fork by @k0pernicus. Snatch is a fast and interruptable download accelerator, written in Rust, from @k0pernicus and @Jean-Serge.

Current features

• Simple: a command line tool to manage easily your downloads ;
• Fast: multithreading support ;
• Interruptable: work in progress.

NOTE: Zou is on alpha version. This version runs well on remote contents with a length known before the download (with the content-length header from the server response).

Goal

Let's build a better wget (in Rust)!

Installation

1. Install Rust and Cargo using rustup ;
2. You can download two versions of Zou :

• the latest build from crates.io: cargo install zou ;
• the last commit version from Github: cargo install --git https://github.com/k0pernicus/zou.git --branch devel ;

3. Enjoy !

Usage

Zou 0.2.0
Zou, a simple and fast download accelerator, written in Rust.

USAGE:
    zou [FLAGS] [OPTIONS] <url>

FLAGS:
    -d, --debug          Active the debug mode
        --force          Assume Yes to all queries and do not prompt
    -h, --help           Prints help information
    -s, --ssl_support    Switch to an SSL client
    -V, --version        Prints version information

OPTIONS:
    -o, --output <output>         Specify the local output
    -t, --threads <threads>       Threads which can use to download

ARGS:
    <url>

File examples

• A simple PDF file
• Big Buck Bunny, a big free mp4 file
• The cat DNA, a big .gz file
• A big PDF file from Princeton

Contributing

You want to contribute to Zou ? Here are a few ways you can help us out :

• test and deploy automatically the beta and stable binaries (with Travis for example),
• improve the documentation,
• improve the CLI,
• add new features (please to see our issues),
• report bugs.

If you want to create a pull request, this is the procedure to make it great:

• create an issue to explain the problem you encountered (except for typo),
• fork the project,
• create a local branch to make changes (from our devel branch),
• test your changes,
• create a pull request (please compare it with our devel branch),
• explain your changes,
• submit !

Thank you for your interest in contributing to Zou ! :-D

FAQ

• Why this fork ? Snatch has been developed when I was a R&D engineer at DernierCri - it was a "just-for-fun" project. Today, I do not work anymore in/with this startup, and I want to experiment something different.
  Zou is now a fun way to hack with Rust! :-)

• Libraries cannot be build Please go check if you are using the latest version of rustc (stable), running rustup update.

• fatal error: 'openssl/hmac.h' file not found If you are on a GNU/Linux distribution (like Ubuntu), please install libssl-dev. If you are on macOS, please install openssl and check your OpenSSL configuration:

brew install openssl
export OPENSSL_INCLUDE_DIR=`brew --prefix openssl`/include
export OPENSSL_LIB_DIR=`brew --prefix openssl`/lib
export DEP_OPENSSL_INCLUDE=`brew --prefix openssl`/include

zou's Issues

install panic

when i install zou, it panic. does it dependent for c. Can I replace rustssl for no c dependency?

Resume support

This is just a question. Does zou support resume/continue as with wget -c ?

hyper 0.11?

Compared to 0.9, I guess hyper dropped openssl dependency and made it a pure rust library.

I wonder when snatch will move on to hyper 0.11 and give an option to decide whether to use openssl. OpenSSL can potentially introduce security issue.

This will give users an option to use pure Rust binary.

Same issue in snatch: derniercri/snatch#76

Refactoring code

Some refactoring have to be done for:

• supporting mirrors feature better,
• making easier to understand what is happening with mirrors,
• managing a simple algorithm to bench mirrors and sort them automatically.

Also, this refactoring code has to make integration of future existing protocols (like ftp and so on) easier.

Library API?

Hey, I am developing an application and 've been looking for a downloader library.
I like zou and would like to contribute and start using it as a library.

I took a look at the code and there doesn't seem to be a straight forward API yet.
Instead the cli binary sort of acts as it. Would be nice to decouple it and have main.rs consume a library API instead.

Generally I am thinking about something like the following:

fn download(uri: &str(I guess), final_path: path) Result<()> { 
    Weird magic that handles everything about downloading 
}