script.module.torrent_parser/README.md

# Torrent file parser and creator for Python

A simple parser for `.torrent` file.

Can also edit and write back to torrent format after version 0.2.0.

## Features

- Decoder and encoder for torrent files
- Auto decode bytes field to string with used specified encoding and error handler
- Auto detect encoding when use `auto` as encoding(need `chardet` installed)
- Auto decode hash value filed to hash blocks
- Uniform exception type
- CLI provided, with JSON output

## Install

```
pip install torrent_parser
```

## Usage:

### CLI

```
$ pytp test.torrent
```

```
$ cat test.torrent | pytp
```

![][screenshots-help]

![][screenshots-normal]

![][screenshots-indent]


### As a module

```pycon
>>> import torrent_parser as tp
>>> data = tp.parse_torrent_file('test.torrent')
>>> data['announce']
http://tracker.trackerfix.com:80/announce
>>> data['announce'] = 'http://127.0.0.1:12345'
>>> tp.create_torrent_file('new.torrent', data)
```

or you don't operate with file, just raw bytes:

```pycon
>>> import torrent_parser as tp
>>> data = tp.decode(b'd3:negi-1ee')
>>> data['neg']
-1
>>> tp.encode(data)
b'd3:negi-1ee'
```

## Test

```bash
python -m unittest tests
```

## Changelog

See [Changelog][CHANGELOG].

## LICENSE

See [License][LICENSE].

[screenshots-help]: http://rikka-10066868.image.myqcloud.com/7c23f6d0-b23f-4c57-be93-d37fafe3292a.png
[screenshots-normal]: http://rikka-10066868.image.myqcloud.com/1492616d-9f14-4fe2-9146-9a3ac06c6868.png
[screenshots-indent]: http://rikka-10066868.image.myqcloud.com/eadc4184-6deb-42eb-bfd4-239da8f50c08.png
[LICENSE]: https://github.com/7sDream/torrent_parser/blob/master/LICENSE
[CHANGELOG]: https://github.com/7sDream/torrent_parser/blob/master/CHANGELOG.md