Metadata-Version: 2.0
Name: xdcc-dl
Version: 0.2.0
Summary: An XDCC Downloader
Home-page: https://gitlab.namibsun.net/namboy94/xdcc-downloader
Author: Hermann Krumrey
Author-email: hermann@krumreyh.com
License: GNU GPL3
Download-URL: https://gitlab.namibsun.net/namboy94/xdcc-downloader/repository/archive.zip?ref=master
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 1 - Planning
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 2
Classifier: Topic :: Communications :: File Sharing
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Dist: bs4
Requires-Dist: irc
Requires-Dist: raven
Requires-Dist: requests

XDCC Downloader
===============

An XDCC File downloader based on the
`irclib <https://github.com/jaraco/irc>`__ framework.

Installation
------------

Via Pip (Preferred):
~~~~~~~~~~~~~~~~~~~~

**As User (Preferred)**

::

    $ pip install xdcc_dl --user

**Systemwide**

::

    # pip install xdcc_dl
    or
    $ sudo pip install xdcc_dl

Via setup.py
~~~~~~~~~~~~

**As User (Preferred)**

::

    $ python setup.py install --user

**Systemwide**

::

    # python setup.py install
    or
    $ sudo python setup.py install

Binaries
~~~~~~~~

The supplied binaries at the `Github
Releases <https://github.com/namboy94/xdcc-downloader/releases>`__ page
do not require installation nor any dependencies. They can simply be
executed.

Usage
-----

Message-based CLI
~~~~~~~~~~~~~~~~~

XDCC Packlists usually list xdcc commands in the folowing form:

::

    /msg <BOTNAME> xdcc send #<PACKNUMBER>

By supplying this message as the ``-m`` parameter, the pack can be
downloaded.

**Example:**

::

    # This is the xdcc message:  /msg the_bot xdcc send #1

    # This command downloads pack 1 from the_bot
    xdcc_dl -m "/msg the_bot xdcc send #1"

    # It's possible to download a range of packs (1-10 in this case):
    xdcc_dl -m "/msg the_bot xdcc send #1-10"

    # you can also specify the destination file or directory:
    xdcc_dl -m "/msg the_bot xdcc send #1" -d /home/user/Downloads
    # The destination defaults to your current working directory

    # if the bot is on a different server than irc.rizon.net, a server
    # has to be specified:
    xdcc_dl -m "/msg the_bot xdcc send #1" --server irc.freenode.org

    # You can also specify an IRC username. If none was supplied, a
    # random string of numbers will be used instead
    xdcc_dl -m "/msg the_bot xdcc send #1" --user Me

Further Information
-------------------

`Documentation(HTML) <https://docs.namibsun.net/html_docs/xdcc_downloader/index.html>`__

`Documentation(PDF) <https://docs.namibsun.net/pdf_docs/xdcc_downloader.pdf>`__

`Python Package Index Site <https://pypi.python.org/pypi/xdcc_dl>`__

`Git Statistics
(gitstats) <https://gitstats.namibsun.net/gitstats/xdcc_downloader/index.html>`__

`Git Statistics
(git\_stats) <https://gitstats.namibsun.net/git_stats/xdcc_downloader/index.html>`__

`Changelog <https://gitlab.namibsun.net/namboy94/xdcc-downloader/raw/master/CHANGELOG>`__


