rain

1.12.15 Opens a new window with list of versions in this module.

🌧 BitTorrent client and library in Go For more information about how to use this package see README

Latest version published 28 days ago

GitHub

Package Health Score

86 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Active

Popularity

Recognized

Imported By: 0
GitHub Stars: 929
Forks: 69
Contributors: 20

Usage Popularity

Based on project statistics from the GitHub repository for the Golang package rain, we found that it has been 929 times.

The popularity score for Golang modules is calculated based on the number of stars that the project has on GitHub as well as the number of imports by other modules.

Security

No known security issues

Security risks

Direct Vulnerabilities: 0
C
0
H
0
M
0
L

Indirect Vulnerabilities: Check with Snyk

Release Date

Apr 7, 2024

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like rain is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 5
Last Release: 28 days ago
Last Commit: 27 days ago

Further analysis of the maintenance status of github.com/cenkalti/rain based on released golang versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that github.com/cenkalti/rain demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the github.com/cenkalti/rain repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like github.com/cenkalti/rain is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Ensure all the packages you're using are healthy and well-maintained

Readme

rain

BitTorrent client and library in Go. Running in production at put.io since 2019.

Features

Core protocol
Fast extension
Magnet links
Multiple trackers
UDP trackers
DHT
PEX
Message stream encryption
WebSeed
Fast resuming
IP blocklist
RPC server & client
Console UI
Tool for creating & reading .torrent files

Screenshot

Rain Screenshot

Installing

If you are on MacOS you can install from brew:

brew install cenkalti/rain/rain

Otherwise, get the latest binary from releases page.

Usage as torrent client

Rain is distributed as single binary file. The main use case is running rain server command and operating the server with rain client commands. Server consists of a BitTorrent client and a RPC server. rain client is used to give commands to the server. There is also rain client console command which opens up a text based UI that you can view and manage the torrents on the server. Run rain help to see other commands.

Usage as library

// Create a session
ses, _ := torrent.NewSession(torrent.DefaultConfig)

// Add magnet link
tor, _ := ses.AddURI(magnetLink, nil)

// Watch the progress
for range time.Tick(time.Second) {
	s := tor.Stats()
	log.Printf("Status: %s, Downloaded: %d, Peers: %d", s.Status.String(), s.Bytes.Completed, s.Peers.Total)
}

More complete example can be found under handleDownload function at main.go file.

See package documentation for complete API.

Configuration

All values have sensible defaults, so you can run Rain with an empty config but if you want to customize it's behavior, you can pass a YAML config with -config flag. Config keys must be in lowercase. See the description of values in here: config.go

Difference from other clients

Rain is the main BitTorrent client used at put.io. It is designed to handle hundreds of torrents while using low system resources. The main difference from other clients is that Rain uses a separate peer port for each torrent. This allows Rain to download same torrent for multiple accounts in same private tracker and keep reporting their ratio correctly.

Missing features

FAQs

What is rain?

🌧 BitTorrent client and library in Go. Visit Snyk Advisor to see a full health score report for rain, including popularity, security, maintenance & community analysis.

Is rain popular?

The golang package rain receives a total of ? weekly downloads. As such, rain popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is rain well maintained?

We found that rain demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is rain safe to use?

The golang package rain was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 3 May-2024, at 22:58 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Usage Popularity

Security risks

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Readme

rain

Features

Screenshot

Installing

Usage as torrent client

Usage as library

Configuration

Difference from other clients

Missing features

FAQs

What is rain?

Is rain popular?

Is rain well maintained?

Is rain safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues