Examples in documentation

[csm10495]

Can there be examples added? Things like:

• Listing current torrents
• Getting status names for current torrents
• Removing torrents
• Adding torrents

Thanks.

[mhadam]

Thanks for the suggestion, I'll try to get this done soon.

[csm10495]

Thanks! Merry Christmas!

[mhadam]

Getting status names for current torrents

I started putting together the examples in an update to the docs and it occured to me that currently clutch only returns what Transmission provides: an integer corresponding to various states.

I think it'd be better for clutch to return an enum so you don't have to dig into the Transmission code to figure out what they mean. I'll put this in a new release soon.

In the meantime, from here:

1652:    TR_STATUS_STOPPED = 0, /* Torrent is stopped */
1653:    TR_STATUS_CHECK_WAIT = 1, /* Queued to check files */
1654:    TR_STATUS_CHECK = 2, /* Checking files */
1655:    TR_STATUS_DOWNLOAD_WAIT = 3, /* Queued to download */
1656:    TR_STATUS_DOWNLOAD = 4, /* Downloading */
1657:    TR_STATUS_SEED_WAIT = 5, /* Queued to seed */
1658:    TR_STATUS_SEED = 6 /* Seeding */

[csm10495]

Cool. I was using version 1.0 and was doing something like this to get done torrents:

for key, info in client.list().items():
    status = info['status']
    if 'stopped' in status.name and info['left_until_done'] == 0 :
        # ... 

An enum would be nicer than this weirdness.

[mhadam]

@csm10495 should be fixed in v6.0.0, there's an enum now Status