Metadata-Version: 2.1
Name: anybt
Version: 1.0.3
Summary: An Open Sourced Decentralized BitTorrent Search Engine
Author: j2qk3b
Requires-Python: >=3.7,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: rich (>=13.7.1,<14.0.0)
Description-Content-Type: text/markdown

# AnyBT: An Open Sourced Decentralized BitTorrent Search Engine

Introducing AnyBT, a tool for searching magnet link of all kinds of BitTorrent contents. It's based on a decentralized data protocol - [Glitter Protocol](https://twitter.com/GlitterProtocol).

You could use AnyBT to search for magnet links base on file names and displays search results with a simple interface.

There is also [a web version of AnyBT](https://anybt.eth.limo) works on [ENS](https://ens.domains/) and [IPFS](https://ipfs.tech/) available if you do not have Python environment.

## Getting Started

To get started, please follow these steps:

### Prerequisites

- Python (v3.7 or higher)

### Installation

Installing the tool, and you should make sure `your/download/path` in the `$PATH`, then you can use the command line tool.

```shell
pip install anybt
``` 

### Options

- `-f <filename>` or `--file <filename>`:Specifies the filename to be processed. Required:yes.

- `-l <resultlimit>` or `--limit <resultlimit>`:Specifies the number of results to display. Default: 20.

- `-o <order type>` or `--order <order type>`:Specifies the ordering sequence of results to display. Default: none.
  - `hot` :order by the file heat
  - `size` :order by the size of file
  - `date` :order by the original publication time of the file

- `-ft <filter type>` or `--fliter <fliter type>`:Specifies the category of result to display. Default: all.
  - `video` :video categories.
  - `document`:document categories.
  - `image` :image categories.
  - `ads` :ads categories.
  - `music` :music categories.
  - `software` :software categories.
  - `package` :package categories.

### Examples

1. Search for keyword "Chaplin":

```shell
anybt -f Chaplin
```

2. Search for keywords "Charlie Chaplin":

```shell
anybt -f "Charlie Chaplin"
```

3. Search for keywords "Charlie Chaplin" and order by file size:

```shell
anybt -f "Charlie Chaplin" -o size
```

4. Search for keywords "Charlie Chaplin" and only keep the video resource:

```shell
anybt -f "Charlie Chaplin" -ft video
```


## Built With

- [glitter-sdk-py](https://github.com/glitternetwork/glitter-sdk-py) A Python SDK for interacting with the Glitter Protocol.

## Contributing

If you would like to contribute to this project, feel free to fork the repository and submit a pull request with your changes.

## License

This project is licensed under the MIT License - see the LICENSE file for details.


