84 lines
4.5 KiB
Markdown
84 lines
4.5 KiB
Markdown
[![Releases][releases-shield]][releases-url]
|
|
[![Contributors][contributors-shield]][contributors-url]
|
|
[![Forks][forks-shield]][forks-url]
|
|
[![Stargazers][stars-shield]][stars-url]
|
|
[![Issues][issues-shield]][issues-url]
|
|
[![GPL3 License][license-shield]][license-url]
|
|
[![Coveralls][coveralls-shield]][coveralls-url]
|
|
[![Docker Image][docker-pulls-shield]][docker-pulls-url]
|
|
<!-- PROJECT LOGO -->
|
|
<br />
|
|
<p align="center">
|
|
<a href="https://github.com/distribyted/distribyted">
|
|
<img src="mkdocs/docs/images/distribyted_icon.png" alt="Logo" width="100">
|
|
</a>
|
|
|
|
<h3 align="center">distribyted</h3>
|
|
|
|
<p align="center">
|
|
Torrent client with on-demand file downloading as a filesystem.
|
|
<br />
|
|
<br />
|
|
<a href="https://github.com/distribyted/distribyted/issues">Report a Bug</a>
|
|
·
|
|
<a href="https://github.com/distribyted/distribyted/issues">Request Feature</a>
|
|
</p>
|
|
</p>
|
|
|
|
## About The Project
|
|
|
|
![Distribyted Screen Shot][product-screenshot]
|
|
|
|
Distribyted tries to make easier integrations with other applications among torrent files, presenting them as a standard filesystem.
|
|
|
|
We aim to use some compressed file characteristics to avoid download it entirely, just the parts that we'll need.
|
|
|
|
Also, if the file format is not supported, distribyted can stream and seek through the file if needed.
|
|
|
|
**Note that distribyted is in alpha version, it is a proof of concept with a lot of bugs.**
|
|
|
|
### Use Cases
|
|
|
|
- Play **multimedia files** on your favorite video or audio player. These files will be downloaded on demand and only the needed parts.
|
|
- Explore TBs of data from public **datasets** only downloading the parts you need. Use **Jupyter Notebooks** directly to process or analyze this data.
|
|
- Play your **ROM backups** directly from the torrent file. You can have virtually GBs in games and only downloaded the needed ones.
|
|
|
|
### Supported _Expandable_ File Formats
|
|
Distribyted can show some kind of files directly as folders, making it possible for applications read only the parts that they need. Here is a list of supported, to be supported and not supported formats.
|
|
|
|
#### Supported
|
|
- zip: Able to uncompress just one file. The file is decompressed to a temporal file sequentially to make possible seek over it. The decompression stops if no one is reading it.
|
|
|
|
#### To Be Supported
|
|
- tar: Seek to any file and inside that files using a [modified standard library](https://github.com/ajnavarro/go-tar). Not useful on `.tar.gz` files.
|
|
- 7zip: Similar to Zip. Need for a library similar to [zip](https://github.com/saracen/go7z).
|
|
- xz: Only worth it when the file is created using blocks. Possible library [here](https://github.com/ulikunitz/xz) and [here](https://github.com/frrad/bxzf).
|
|
|
|
#### Not Supported
|
|
- gzip: As far as I know, it doesn't support random access.
|
|
|
|
## Documentation
|
|
|
|
Check [here][main-url] or [here][doc-folder-url] for further documentation.
|
|
|
|
[doc-folder-url]: https://github.com/distribyted/distribyted/mkdocs/docs
|
|
[main-url]: https://distribyted.com
|
|
[releases-shield]: https://img.shields.io/github/v/release/distribyted/distribyted.svg?style=flat-square
|
|
[releases-url]: https://github.com/distribyted/distribyted/releases
|
|
[docker-pulls-shield]:https://img.shields.io/docker/pulls/distribyted/distribyted.svg?style=flat-square
|
|
[docker-pulls-url]:https://hub.docker.com/r/distribyted/distribyted
|
|
[contributors-shield]: https://img.shields.io/github/contributors/distribyted/distribyted.svg?style=flat-square
|
|
[contributors-url]: https://github.com/distribyted/distribyted/graphs/contributors
|
|
[forks-shield]: https://img.shields.io/github/forks/distribyted/distribyted.svg?style=flat-square
|
|
[forks-url]: https://github.com/distribyted/distribyted/network/members
|
|
[stars-shield]: https://img.shields.io/github/stars/distribyted/distribyted.svg?style=flat-square
|
|
[stars-url]: https://github.com/distribyted/distribyted/stargazers
|
|
[issues-shield]: https://img.shields.io/github/issues/distribyted/distribyted.svg?style=flat-square
|
|
[issues-url]: https://github.com/distribyted/distribyted/issues
|
|
[releases-url]: https://github.com/distribyted/distribyted/releases
|
|
[license-shield]: https://img.shields.io/github/license/distribyted/distribyted.svg?style=flat-square
|
|
[license-url]: https://github.com/distribyted/distribyted/blob/master/LICENSE
|
|
[product-screenshot]: mkdocs/docs/images/distribyted.gif
|
|
[example-config]: https://github.com/distribyted/distribyted/blob/master/examples/conf_example.yaml
|
|
[coveralls-shield]: https://img.shields.io/coveralls/github/distribyted/distribyted?style=flat-square
|
|
[coveralls-url]: https://coveralls.io/github/distribyted/distribyted
|