Metadata-Version: 1.1
Name: socli
Version: 3.8
Summary: Stack overflow commnand line interface. SoCLI allows you to search and browse stack overflow from the terminal.
Home-page: http://www.github.com/gautamkrishnar/socli
Author: Gautam krishna R
Author-email: r.gautamkrishna@gmail.com
License: BSD
Description-Content-Type: UNKNOWN
Description: 
        
        SoCLI |PyPI version| |Build Status| |Collaborizm|
        =================================================
        
        Stack Overflow command line written in python. Using SoCLI you can
        search and browse Stack Overflow without leaving the terminal. Just use
        the **socli** command:
        
        .. figure:: https://cloud.githubusercontent.com/assets/8397274/24831468/86c290aa-1cb7-11e7-8161-2665d0c02e4b.gif
           :alt: SoCLI in action
        
           SoCLI in action
        
        Installation
        ~~~~~~~~~~~~
        
        Supported platforms
        '''''''''''''''''''
        
        -  Linux
        -  Windows
        -  Mac
        
        Requirements
        ''''''''''''
        
        -  Python 2.0 or higher
        
        For Linux
        '''''''''
        
        Install **python** and just use **pip** command to install **socli**:
        
        .. code:: bash
        
            sudo apt-get install python python-pip
            sudo pip install socli
        
        For Windows
        '''''''''''
        
        `Download and install Python <https://www.python.org/downloads/>`__.
        Don't forget to check the option "Add to path".
        
        Open a command prompt with administrative privileges and use **pip**
        command to install **socli**:
        
        .. code:: bash
        
            pip install socli
        
        Use **easy\_install** if your python path have a space in it. `Read
        more: "Failed to create
        process" <https://github.com/gautamkrishnar/socli/issues/6>`__:
        
        ::
        
            easy_install socli
        
        For Mac (via homebrew)
        ''''''''''''''''''''''
        
        Install **python** and **socli**:
        
        .. code:: bash
        
            brew install python
            easy_install pip
            pip install socli
        
        Updating
        ~~~~~~~~
        
        Use the command below to update your existing version of **socli** to
        the newest version so that you won't miss any features:
        
        .. code:: bash
        
            sudo pip install --upgrade socli
        
        Usage
        ~~~~~
        
        Quick Search
        ''''''''''''
        
        Use the **socli** command followed by the search query:
        
        .. code:: bash
        
            socli for loop in python syntax
        
        The above command will search for the query "*for loop in python
        syntax*" and displays the first most voted question in Stack Overflow
        with its most voted answer. Pretty quick, right?
        
        Interactive Search
        ''''''''''''''''''
        
        You can search Stack Overflow interactively by using the command below:
        
        .. code:: sh
        
            socli -iq html error 404
        
        This will display a list of questions from Stack Overflow for the query
        "*html error 404*" and it will allow you to choose any of the questions
        you like interactively. When you choose a question, it will display the
        complete description of the chosen question with its most voted answer.
        You can also browse through the other answers to that question using the
        up and down arrow keys as well as go back to the list of questions using
        the left arrow key.
        
        Manual Search
        '''''''''''''
        
        This will allow you to specify a requested question number for your
        query. For example, consider the following command:
        
        .. code:: sh
        
            socli -r 2 -q javascript prototype function
        
        This command searches for "*javascript prototype function*" in Stack
        Overflow and displays the second question that contains it.
        
        Topic-Based Search
        ''''''''''''''''''
        
        Stack Overflow supports topic by using tags. **socli** allows you to
        query Stack Overflow based on specific tags. Just specify the tag via
        the following command:
        
        .. code:: sh
        
            socli -t javascript -q window.open
        
        You can also specify multiple tags, Just seporate them with a comma:
        
        .. code:: sh
        
            socli -t javascript,node.js -q window.open
        
        See the complete list of tags `here <http://stackoverflow.com/tags>`__.
        
        User Profile Browsing
        '''''''''''''''''''''
        
        Just use the command below to set your `user
        ID <http://meta.stackexchange.com/a/111130>`__ in socli. When you
        execute the command next time, it will automaticially fetch the data.
        
        .. code:: sh
        
            socli -u
        
        if your are an extensive user of StackOverflow, **socli** allows you to
        set your own API key to overcome the `StackOverflow API
        Limitations <http://stackapps.com/a/3057/41332>`__. Just use the command
        below:
        
        .. code:: sh
        
            socli --api
        
        You can get an API Key
        `here <http://stackapps.com/apps/oauth/register>`__ by registering as a
        new app. Please don't use SoCLI as app name.
        
        Posting a New Question
        ''''''''''''''''''''''
        
        If you can't find an answer for your question in Stack Overflow,
        **socli** allows you to create a new question via the web browser. Just
        type the command below and **socli** will open the new question page of
        Stack Overflow in the web browser for you:
        
        .. code:: sh
        
            socli -n
        
        Syntax:
        ~~~~~~~
        
        **socli** has the following syntax
        
        ::
        
            Usage: socli [ Arguments] < Search Query >
        
        Arguments (optional)
                            
        
        +-----------+-----------+-----------+-----------+
        | Short     | Long      | Descripti | Example   |
        |           |           | on        |           |
        +===========+===========+===========+===========+
        | -q        | --query   | Used to   | **socli   |
        |           |           | specify   | -q        |
        |           |           | the query | query**   |
        |           |           | when      |           |
        |           |           | arguments |           |
        |           |           | are used. |           |
        |           |           | A query   |           |
        |           |           | value     |           |
        |           |           | must be   |           |
        |           |           | passed to |           |
        |           |           | it. If it |           |
        |           |           | is used   |           |
        |           |           | alone     |           |
        |           |           | (socli -q |           |
        |           |           | query)    |           |
        |           |           | then it   |           |
        |           |           | will      |           |
        |           |           | display   |           |
        |           |           | the same  |           |
        |           |           | result as |           |
        |           |           | **socli   |           |
        |           |           | query**.  |           |
        +-----------+-----------+-----------+-----------+
        | -i        | --interac | Used to   | **socli   |
        |           | tive      | search    | -i -q     |
        |           |           | interacti | query**   |
        |           |           | vely.     |           |
        |           |           | It        |           |
        |           |           | doesn't   |           |
        |           |           | take any  |           |
        |           |           | values.   |           |
        |           |           | It must   |           |
        |           |           | be        |           |
        |           |           | followed  |           |
        |           |           | by a -q   |           |
        |           |           | or        |           |
        |           |           | --query   |           |
        |           |           | after it. |           |
        +-----------+-----------+-----------+-----------+
        | -r        | --res     | Used for  | **socli   |
        |           |           | manual    | -r 4 -q   |
        |           |           | search.   | query**   |
        |           |           | It takes  |           |
        |           |           | the       |           |
        |           |           | question  |           |
        |           |           | number as |           |
        |           |           | the       |           |
        |           |           | argument  |           |
        |           |           | and it    |           |
        |           |           | must be   |           |
        |           |           | followed  |           |
        |           |           | by a -q   |           |
        |           |           | or        |           |
        |           |           | --query   |           |
        |           |           | after it. |           |
        +-----------+-----------+-----------+-----------+
        | -t        | --tag     | Specifies | **socli   |
        |           |           | the tag   | -t js -q  |
        |           |           | to search | query**   |
        |           |           | for the   |           |
        |           |           | query on  |           |
        |           |           | Stack     |           |
        |           |           | Overflow. |           |
        |           |           | It must   |           |
        |           |           | be        |           |
        |           |           | followed  |           |
        |           |           | by a -q   |           |
        |           |           | or        |           |
        |           |           | --query   |           |
        |           |           | after it. |           |
        +-----------+-----------+-----------+-----------+
        | -n        | --new     | Opens the | **socli   |
        |           |           | web       | --new**   |
        |           |           | browser   |           |
        |           |           | to create |           |
        |           |           | a new     |           |
        |           |           | question  |           |
        |           |           | on Stack  |           |
        |           |           | Overflow. |           |
        +-----------+-----------+-----------+-----------+
        | -u        | --user    | Displays  | **socli   |
        |           |           | the user  | -u        |
        |           |           | profile   | 22656**   |
        |           |           | informati |           |
        |           |           | ons.      |           |
        |           |           | If no     |           |
        |           |           | argument  |           |
        |           |           | is given, |           |
        |           |           | it will   |           |
        |           |           | display   |           |
        |           |           | your      |           |
        |           |           | profile.  |           |
        +-----------+-----------+-----------+-----------+
        | -a        | --api     | Sets a    | **socli   |
        |           |           | custom    | --api**   |
        |           |           | API key.  |           |
        +-----------+-----------+-----------+-----------+
        | -d        | --del     | Deletes   | **socli   |
        |           |           | the       | -d**      |
        |           |           | configura |           |
        |           |           | tion      |           |
        |           |           | file      |           |
        |           |           | generated |           |
        |           |           | by socli  |           |
        |           |           | -u        |           |
        |           |           | manually. |           |
        +-----------+-----------+-----------+-----------+
        | -s        | --sosearc | SoCLI     | **socli   |
        |           | h         | uses      | -s -q for |
        |           |           | Google    | loop      |
        |           |           | search by | python**  |
        |           |           | default   |           |
        |           |           | to search |           |
        |           |           | for       |           |
        |           |           | questions |           |
        |           |           | .         |           |
        |           |           | To        |           |
        |           |           | override  |           |
        |           |           | this and  |           |
        |           |           | use       |           |
        |           |           | stackover |           |
        |           |           | flow's    |           |
        |           |           | default   |           |
        |           |           | search    |           |
        |           |           | instead.  |           |
        +-----------+-----------+-----------+-----------+
        | -h        | --help    | Displays  | **socli   |
        |           |           | the help  | --help**  |
        |           |           | text.     |           |
        +-----------+-----------+-----------+-----------+
        
        Query
             
        
        This term refers to what you're searching for in Stack Overflow.
        
        Features
        ~~~~~~~~
        
        These are the amazing features of SoCLI: \* Manual Search \*
        Interactively browse Stack Overflow using the interactive mode \*
        Coloured interface \* Question stats view \* Tag support \* Can open the
        page in a browser \* Can view user profiles \* Can create a new question
        via the web browser
        
        To Do
        ~~~~~
        
        Command line interface for: - [ ] Stack Overflow authentication - [ ]
        Posting to Stack Overflow - [ ] Upvote answer - [ ] Comment on an answer
        - [ ] Browsing stackoverflow home page
        
        Please check out the list of
        `issues <https://github.com/gautamkrishnar/socli/issues>`__.
        
        Contributing
        ~~~~~~~~~~~~
        
        If you are willing to contribute to SoCLI project, you are awesome! Just
        follow the steps below:
        
        1. Fork it!
        2. Make a local clone:
           ``sh   git clone https://github.com/{YOUR_USERNAME}/socli.git``
        
        3. Switch to the directory: ``cd socli``
        4. Create your new branch: ``git checkout -b feature name``
        5. Make necessary changes to this source code
        6. Add changes to git index by using ``git add --all .``
        7. Commit your changes: ``git commit -am 'Added new feature'``
        8. Push to the branch: ``git push``
        9. Submit a `new pull
           request <https://github.com/gautamkrishnar/socli/pull/new>`__ 
        
        Contributors
        ~~~~~~~~~~~~
        
        Special thanks to these superheroes: \* `Elliott
        Beach <https://github.com/e-beach>`__ for improving color support by
        adding colorama
        `#29 <https://github.com/gautamkrishnar/socli/pull/29>`__, For making
        SoCLI more interactive
        `#35 <https://github.com/gautamkrishnar/socli/pull/35>`__.
        `36 <https://github.com/gautamkrishnar/socli/pull/36>`__
        `#40 <https://github.com/gautamkrishnar/socli/pull/40>`__ You rocks...
        \* `Aaxu <https://github.com/aaxu>`__ for the PR:
        `#59 <https://github.com/gautamkrishnar/socli/pull/59>`__,
        `#58 <https://github.com/gautamkrishnar/socli/pull/58>`__,
        `#56 <https://github.com/gautamkrishnar/socli/pull/56>`__,
        `#54 <https://github.com/gautamkrishnar/socli/pull/54>`__, and
        `#53 <https://github.com/gautamkrishnar/socli/pull/53>`__. High Five! \*
        `Killbee <https://github.com/kilbee>`__ for making SoCLI colorful
        `#3 <https://github.com/gautamkrishnar/socli/pull/3>`__ \* `Sam
        Dean <https://github.com/deanWombourne>`__ for adding Macintosh SoCLI
        installation instructions
        `#1 <https://github.com/gautamkrishnar/socli/pull/1>`__ \*
        `Plinio89s <https://github.com/Plinio89s>`__ for adding the check for
        color support `#8 <https://github.com/gautamkrishnar/socli/pull/8>`__ \*
        `nagracks <https://github.com/nagracks>`__ for improving readability of
        the SoCLI code `#11 <https://github.com/gautamkrishnar/socli/pull/11>`__
        \* `mwwynne <https://github.com/mwwynne>`__ for adding links to the
        SoCLI `#13 <https://github.com/gautamkrishnar/socli/pull/13>`__ \*
        `Carlos J. Puga Medina <https://github.com/cpu82>`__ for finding the bug
        `#11 <https://github.com/gautamkrishnar/socli/issues/14>`__ on SoCLI
        python2 version and for making `SoCLI freshports
        port <https://www.freshports.org/misc/py-socli/>`__ \* `Jon
        Ericson <https://github.com/jericson>`__ (*Community Manager, Stack
        Overflow*) for the PR
        `#18 <https://github.com/gautamkrishnar/socli/pull/18>`__ and letting me
        know about the Stack Overflow attribution policy. Thanks for the `blog
        post <http://jericson.github.io/2016/08/25/long_tail_docs.html>`__ \*
        `Ankit Kr. Singh <https://github.com/kumarankit0411>`__ for fixing some
        typos PR `#21 <https://github.com/gautamkrishnar/socli/pull/21>`__
        `#23 <https://github.com/gautamkrishnar/socli/pull/23>`__ \* `Harsha
        Alva <https://github.com/aharshac>`__ for fixing windows encoding
        problem PR `#24 <https://github.com/gautamkrishnar/socli/pull/21>`__ \*
        `Pia Mancini <https://github.com/piamancini>`__ for adding SoCLI to
        OpenCollective `#27 <https://github.com/gautamkrishnar/socli/pull/27>`__
        \* `Aditya Tandon <https://github.com/adityatandon007>`__ for the issue
        `#30 <https://github.com/gautamkrishnar/socli/issues/30>`__ \* `Akshatha
        Nayak <https://github.com/Aksh77>`__ for your first contribution to an
        open source project. PR
        `#31 <https://github.com/gautamkrishnar/socli/issues/31>`__ \* `Levi
        Sabah <https://github.com/levisabah>`__ for PR
        `#43 <https://github.com/gautamkrishnar/socli/pull/43>`__ \*
        `liamhawkins <https://github.com/liamhawkins>`__ for PR
        `#44 <https://github.com/gautamkrishnar/socli/pull/44>`__ and
        `#45 <https://github.com/gautamkrishnar/socli/pull/45>`__ \*
        `Arount <https://github.com/arount>`__ for fixing issue
        `#48 <https://github.com/gautamkrishnar/socli/issues/48>`__ via PR
        `#47 <https://github.com/gautamkrishnar/socli/pull/47>`__ \* `Cédric
        Picard <https://github.com/cym13>`__ for the issue
        `#42 <https://github.com/gautamkrishnar/socli/issues/42>`__ \* `Amartya
        Chaudhuri <https://github.com/amartyaamp>`__ for his first contribution
        to SOCLI `#51 <https://github.com/gautamkrishnar/socli/pull/51>`__
        
        Bugs
        ~~~~
        
        If you are experiencing any bugs, don’t forget to open a `new
        issue <https://github.com/gautamkrishnar/socli/issues/new>`__.
        
        Thanks
        ~~~~~~
        
        -  Thanks to all the existing users of SoCLI.
        -  Thanks to all upvoters and followers on reddit.
        -  `impress that girl in the Starbucks by browsing SO with your CLI app
           XD
           XD <https://www.reddit.com/r/programmingcirclejerk/comments/4pwil4/impress_that_girl_in_the_starbucks_by_browsing_so/>`__
           by `insane0hflex <https://www.reddit.com/user/insane0hflex>`__.
           Thanks for the post :wink:
        -  Special thanks to people who wrote about SoCLI on their blogs and
           websites:
        
           -  `wykop.pl <http://www.wykop.pl/wpis/18286681/python-stackoverflow-interfejs-bo-sciaga-musi-byc-/>`__
           -  `memect.com <http://forum.memect.com/blog/thread/py-2016-06-26/>`__
           -  `pseudoscripter <https://pseudoscripter.wordpress.com/2016/06/28/socli-stack-overflow-command-line-client/>`__
           -  `b.hatena.ne.jp <http://b.hatena.ne.jp/entry/s/github.com/gautamkrishnar/socli>`__
           -  `jericson.github.io <http://jericson.github.io/2016/08/25/long_tail_docs.html>`__
           -  `The really big list of really interesting Open Source
              projects <https://medium.com/@likid.geimfari/the-list-of-interesting-open-source-projects-2daaa2153f7c#.6qm1v3ioa>`__
           -  `Ostechnix <http://www.ostechnix.com/search-browse-stack-overflow-website-commandline/>`__
           -  `lamiradadelreplicante.com <lamiradadelreplicante.com/2017/04/17/socli-navegando-por-stack-overflow-sin-salir-de-la-terminal>`__
           -  `dou.ua <https://dou.ua/lenta/digests/python-digest-13/>`__
        
        -  Tweets:
        
           -  [@cyb3rops](https://twitter.com/cyb3rops/status/747380776350650368)
           -  [@pythontrending](https://twitter.com/pythontrending/status/745635512803819521)
        
        -  Thanks to my favourite IDE JetBrains PyCharm
        
        Sponsors
        ~~~~~~~~
        
        Sponsor SoCLI on
        `Collaborizm <https://www.collaborizm.com/project/S1cbUui6>`__ or on
        `Open Collective <https://opencollective.com/socli>`__:
        
        -  Thanks `Steven Reubenstone <https://www.collaborizm.com/profile/1>`__
           for contributing $5 for the issue
           `#22 <https://github.com/gautamkrishnar/socli/issues/22>`__
        
        Liked it?
        ~~~~~~~~~
        
        Hope you liked this project, don't forget to give it a star
        
        .. |PyPI version| image:: https://badge.fury.io/py/socli.svg
           :target: https://badge.fury.io/py/socli
        .. |Build Status| image:: https://travis-ci.org/gautamkrishnar/socli.svg?branch=master
           :target: https://travis-ci.org/gautamkrishnar/socli
        .. |Collaborizm| image:: https://img.shields.io/badge/Collaborizm-Join%20Project-brightgreen.svg
           :target: https://www.collaborizm.com/project/S1cbUui6
        
Keywords: stack overflow cli
Platform: UNKNOWN
Requires: BeautifulSoup4
Requires: requests
Requires: colorama
Requires: PyStackExchange
Requires: urwid
