Metadata-Version: 1.1
Name: mal
Version: 0.1.4
Summary: A command line interface to your MyAnimeList profile
Home-page: https://github.com/ryukinix/mal
Author: Manoel Vilela
Author-email: manoel_vilela@engineer.com
License: GPL
Download-URL: https://github.com/ryukinix/mal/archive/v0.1.4.tar.gz
Description: mal -- MyAnimeList Command Line Interface
        =========================================
        
        |PyPi version| |Requirements Status| |PyPi License| |PyPI pyversions|
        |PyPI status|
        
        Description
        -----------
        
        ``mal`` is a command-line client for
        `MyAnimeList.net <http://myanimelist.net/>`__. It uses their official
        `API <http://myanimelist.net/modules.php?go=api>`__, so it should remain
        functional indefinitely (unlike screen-scraping alternatives). But is in
        alpha development yet, so new ideas is welcome! This version is a
        inspired tool from the slow-maintained
        `mal <https://github.com/pushrax/mal>`__.
        
        TL;DR \| Demo
        -------------
        
        .. figure:: https://i.imgur.com/f3ShSUe.gif
           :alt: demonstration
        
           demonstration
        
        Requirements
        ------------
        
        -  Python 3.0+
        -  `pypandoc <https://pypi.python.org/pypi/pypandoc/>`__ (only for
           developing & PyPI submission)
        -  `requests <http://docs.python-requests.org/en/latest/index.html>`__
        
        Installation
        ------------
        
        -  ``sudo pip install mal``
        
        Manual Installation
        ~~~~~~~~~~~~~~~~~~~
        
        Download the package using ``git clone git@github.com:ryukinix/mal.git``
        or as ``zip`` file, so then:
        
        -  ``sudo python setup.py install``
        -  ``sudo make install`` (alternative)
        
        For develop you can try: - ``sudo python setup.py develop`` -
        ``sudo make develop`` (alternative)
        
        In develop mode an EGG file is linked with the actual source, that way
        you can try modifications and get instant feedbacks in each execution
        
        Usage
        -----
        
        First Steps
        -----------
        
        Login
        -----
        
        -  ``mal login``
        
        .. figure:: https://i.imgur.com/5PpIB8K.gif
           :alt: login
        
           login
        
        The program need your credentials to access your list. In the first
        call, the program will ask your ``username/password`` and SAVE IN PLAIN
        TEXT on the default\_path (generally ``~/.myanimelist.ini``):
        
        .. code:: ini
        
            [mal]
            username = your_username
            password = your_password
        
        Why save in plain text? Because the bad design of MAL API, maybe we can
        change this in future, but for now you can blame her.
        
        Now you can try any of the functionalties provide in the sequence above.
        
        Functionalities:
        ----------------
        
        -  Search in your anime list
        -  List anime in the sublist (e.g: watching)
        -  Increment/Decrement anime watching
        -  Score in final watching
        -  Fetch all anime list
        
        Search in your anime list
        -------------------------
        
        -  ``mal anime-by-regex``
        
        .. figure:: https://i.imgur.com/B8QNHzB.png
           :alt: search
        
           search
        
        Search current anime in the sublists:
        -------------------------------------
        
        -  ``mal watching``
        -  ``mal plan to watch``
        -  ``mal rewatching``
        -  ``mal on hold``
        -  ``mal dropped``
        
        .. figure:: https://i.imgur.com/X1K9EyV.gif
           :alt: filtering
        
           filtering
        
        Increment/Decrement
        -------------------
        
        -  Increment/Decrement the number of episodes watched with
           ``mal [inc | dec] [regex]`` (you can swap the order too!). If there
           are multiple matches, it prompts you to select which one. If
           incrementing from ``0``, it sets the anime status to "watching" and
           sets the start date to today. If incrementing to the total episode
           count, it sets the anime status to "completed" and sets the end date
           to today.
        
        -  Increment:
        
           -  ``mal inc anime-regex``
           -  ``mal anime-regex inc``
           -  ``mal +1 anime-regex``
           -  ``mal anime-regex +1``
        
        -  Decrement:
        
           -  ``mal dec anime-regex``
           -  ``mal anime-regex dec``
           -  ``mal -1 anime-regex``
           -  ``mal -1 anime-regex``
        
        .. figure:: https://i.imgur.com/5b1RCX6.gif
           :alt: inc-dec
        
           inc-dec
        
        List all animes or any by regex
        ===============================
        
        -  ``mal all``
        -  ``mal list``
        -  ``mal .+`` (is regex right? :D)
        
        .. figure:: https://i.imgur.com/KofvxNY.gif
           :alt: all-regex
        
           all-regex
        
        License
        =======
        
        GPLv3
        
        .. |PyPi version| image:: https://img.shields.io/pypi/v/mal.svg
           :target: https://pypi.python.org/pypi/mal/
        .. |Requirements Status| image:: https://requires.io/github/ryukinix/mal/requirements.svg?branch=master
           :target: https://requires.io/github/ryukinix/mal/requirements/?branch=master
        .. |PyPi License| image:: https://img.shields.io/pypi/l/mal.svg
           :target: https://pypi.python.org/pypi/mal/
        .. |PyPI pyversions| image:: https://img.shields.io/pypi/pyversions/mal.svg
           :target: https://pypi.python.org/pypi/mal/
        .. |PyPI status| image:: https://img.shields.io/pypi/status/mal.svg
           :target: https://pypi.python.org/pypi/mal/
        
Keywords: mal myanimelist cli anime manager
Platform: unix
Classifier: Environment :: Console
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Internet
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Utilities
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
