Metadata-Version: 1.1
Name: opus_api
Version: 0.1.9
Summary: OPUS (opus.lingfil.uu.se) Python API
Home-page: https://github.com/yonkornilov/opus-api
Author: Yonathan Koren
Author-email: yonkornilov@live.com
License: MIT license
Description: ::
        
                      /$$$$$$            /$$$$$$$  /$$   /$$  /$$$$$$
                     /$$__  $$          | $$__  $$| $$  | $$ /$$__  $$
            /$$$$$$$| $$  \ $$  /$$$$$$ | $$  \ $$| $$  | $$| $$  \__/
           /$$_____/| $$  | $$ /$$__  $$| $$$$$$$/| $$  | $$|  $$$$$$
          | $$      | $$  | $$| $$  \__/| $$____/ | $$  | $$ \____  $$
          | $$      | $$  | $$| $$      | $$      | $$  | $$ /$$  \ $$
          |  $$$$$$$|  $$$$$$/| $$      | $$      |  $$$$$$/|  $$$$$$/
           \_______/ \______/ |__/      |__/       \______/  \______/
        
        .. image:: https://img.shields.io/pypi/v/opus-api.svg
                :target: https://pypi.python.org/pypi/opus-api
        
        .. image:: https://img.shields.io/travis/yonkornilov/opus-api.svg
                :target: https://travis-ci.org/yonkornilov/opus-api
        
        .. image:: https://readthedocs.org/projects/opus-api/badge/
                :target: http://opus-api.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://pyup.io/repos/github/yonkornilov/opus-api/shield.svg
                :target: https://pyup.io/repos/github/yonkornilov/opus-api/
                :alt: Updates
        
        .. _OPUS: http://opus.lingfil.uu.se/
        
        OPUS_ (opus.lingfil.uu.se) Python API
        
        * Free software: MIT license
        * Documentation: https://opus-api.readthedocs.io.
        
        .. _requirements:
        
        .. highlight:: console
        .. _PhantomJS: http://phantomjs.org/download.html
        
        ============
        Requirements
        ============
        
        Download PhantomJS_ and make sure its in your PATH, eg:
        
        .. code-block:: console
        
          $ wget -qO- https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-linux-x86_64.tar.bz2 | tar xvj -C ~/.local/bin --strip 2 phantomjs-2.1.1-linux-x86_64/bin
        
        .. highlight:: shell
        
        ============
        Installation
        ============
        
        ##############
        Stable release
        ##############
        
        To install Opus API, run this command in your terminal:
        
        .. code-block:: console
        
            $ pip install opus_api
        
        This is the preferred method to install Opus API, as it will always install the most recent stable release. 
        
        If you don't have `pip`_ installed, this `Python installation guide`_ can guide
        you through the process.
        
        .. _pip: https://pip.pypa.io
        .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
        
        ############
        From sources
        ############
        
        The sources for Opus API can be downloaded from the `Github repo`_.
        
        You can either clone the public repository:
        
        .. code-block:: console
        
            $ git clone git://github.com/yonkornilov/opus_api
        
        Or download the `tarball`_:
        
        .. code-block:: console
        
            $ curl  -OL https://github.com/yonkornilov/opus_api/tarball/master
        
        Once you have a copy of the source, you can install it with:
        
        .. code-block:: console
        
            $ python setup.py install
        
        .. _Github repo: https://github.com/yonkornilov/opus_api
        .. _tarball: https://github.com/yonkornilov/opus_api/tarball/master
        
        .. highlight:: shell
        
        =====
        Usage
        =====
        
        Find your languages:
        
        .. code-block:: console
        
          $ opus_api langs
        
          [
          ...
            {
              "description": "en (English)", 
              "id": 69, 
              "name": "en"
            },
            ...
            {
              "description": "ru (Russian)", 
              "id": 198, 
              "name": "ru"
            }...
          ]
        
        Find corpora:
        
        .. code-block:: console
        
          $ opus_api get en ru --maximum 300 --minimum 3
        
          {
            "corpora": [
              {
                "id": 1, 
                "name": "OpenSubtitles2016", 
                "src_tokens": "157.5M", 
                "trg_tokens": "133.6M", 
                "url": "http://opus.lingfil.uu.se/download.php?f=OpenSubtitles2016%2Fen-ru.txt.zip"
              },
            ...
              {
                "id": 13, 
                "name": "KDE4", 
                "src_tokens": "1.8M", 
                "trg_tokens": "1.4M", 
                "url": "http://opus.lingfil.uu.se/download.php?f=KDE4%2Fen-ru.txt.zip"
              }
            ]
          }
        
        =======
        Credits
        =======
        
        This package's CLI is powered by click_.
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _click: https://github.com/pallets/click
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.0 (2017-10-03)
        ------------------
        
        * First release on PyPI.
        
        0.1.9 (2017-10-08)
        __________________
        
        * Documentation released
        
Keywords: opus_api
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
