socli

v7.3

Stack overflow command line interface. SoCLI allows you to search and browse stack overflow from the terminal. For more information about how to use this package see README

Latest version published 1 year ago

License: BSD-3-Clause

PyPI

GitHub

Package Health Score

63 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

sociable
9

Popularity

Small

GitHub Stars: 1.09K
Forks: 218
Contributors: 70

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package socli, we found that it has been starred 1,093 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jan 3, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
3
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

BSD-3-Clause

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 10
Open PR: 0
Last Release: 1 year ago
Last Commit: 2 months ago

Further analysis of the maintenance status of socli based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for socli is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 70
Funding: Yes

With more than 10 contributors for the socli repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.5.0

Age: 8 years
Latest Release: 1 year ago
Dependencies: 7 Direct / 17 Total
Versions: 61
Maintainers: 2
Wheels: OS Independent

Not sure how to use socli?

To help you get started, we've collected the most common ways that socli is being used within popular public projects.

gautamkrishnar / socli / socli / socli.py View on Github

self.url = question_url
        self.answer_text = AnswerText(answers)
        self.screenHeight, screenWidth = subprocess.check_output(['stty', 'size']).split()
        self.question_text = urwid.BoxAdapter(QuestionDescription(question_desc), int(max(1, (int(self.screenHeight) - 9) / 2)))
        answer_frame = urwid.Frame(
            header= urwid.Pile( [
                header_for_display,
                QuestionTitle(question_title),
                self.question_text,
                QuestionStats(question_stats),
                urwid.Divider('-')
            ]),
            body=self.answer_text,
            footer= urwid.Pile([
                QuestionURL(question_url),
                UnicodeText(u'p: previous answer, n: next answer, o: open in browser, b: back')
            ])
        )
        return answer_frame

View more ways to use socli

SoCLI

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:

SoCLI in action

Installation

Supported platforms

Linux
Windows
Mac

Requirements

Python 3.5 or higher

For Linux

Install python and just use pip command to install socli:

sudo apt-get install python3 python3-pip
pip install socli

For Windows

Download and install Python. Don't forget to check the option "Add to path".

Open a command prompt with administrative privileges and use pip command to install socli:

pip install socli

Use easy_install if your python path has a space in it. Read more: "Failed to create process":

easy_install socli

For Mac/Linux (via homebrew)

Install socli:

brew tap gautamkrishnar/socli
brew install socli

Enabling the shell autocompletion

If you installed socli via pyPi you may need to enable the shell autocompletion. Add the following to your .bashrc file to enable it:

socli --register

Updating

Use the command below to update your existing version of socli to the newest version so that you won't miss any features:

pip install --upgrade socli

If you installed via homebrew:

brew upgrade socli

Usage

Quick Search

Use the socli command followed by the search query:

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:

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:

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:

socli -t javascript -q window.open

You can also specify multiple tags, Just separate them with a comma:

socli -t javascript,node.js -q window.open

See the complete list of tags here.

User Profile Browsing

Just use the command below to set your user ID in socli. When you execute the command next time, it will automatically fetch the data.

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. Just use the command below:

socli --api

You can get an API Key here 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:

socli -n

Opening a url directly

If you have the url of the Stack Overflow post then you can pass it using --open-url or -o. For example socli --open-url https://stackoverflow.com/questions/20639180/explanation-of-how-nested-list-comprehension-works

Syntax:

socli has the following syntax

Usage: socli [ Arguments] &lt; Search Query &gt;

Arguments (optional)

Short	Long	Description	Example
-q	--query	Used to specify the 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.	socli -q query
-i	--interactive	Used to search interactively. It doesn't take any values. It must be followed by a -q or --query after it.	socli -i -q query
-r	--res	Used for manual search. It takes the question number as the argument and it must be followed by a -q or --query after it.	socli -r 4 -q query
-t	--tag	Specifies the tag to search for the query on Stack Overflow. It must be followed by a -q or --query after it.	socli -t js -q query
-n	--new	Opens the web browser to create a new question on Stack Overflow.	socli --new
-u	--user	Displays the user profile informations. If no argument is given, it will display your profile.	socli -u 22656
-a	--api	Sets a custom API key.	socli --api
-d	--del	Deletes the configuration file generated by socli -u manually.	socli -d
-s	--sosearch	SoCLI uses Google search by default to search for questions. To override this and use stackoverflow's default search instead.	socli -s -q for loop python
-h	--help	Displays the help text.	socli --help
-o	--open-url	Displays the given url in socli if possible if not opens in browser.	socli -o https://stackoverflow.com/questions/20639180/explanation-of-how-nested-list-comprehension-works
-j	--json-output	Gives output to stdout as json	socli -jq for loop python
-g	--register	Registers socli's shell autocompletion	socli -g
-v	--version	Displays the version of socli.	socli -v

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
Can open a Stack Overflow page on the terminal directly from a url

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.

Testing

Automated tests are setup by using pytest, the tests can be run locally by invoking a python setup.py test.

All tests are in the socli/tests/ subdirectory of this repository.

TravisCI is supposed to run the test-suite on build.

💥 How to Contribute ?

If you are willing to contribute to SoCLI project, you are awesome! Just follow the steps given in CONTRIBUTING.md 😃

Maintainers

Please reach out to any of the following people if you have any queries:

_{Gautam krishna R}
💻

_{Hedy Li}
💻

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_aaxu 💻	_kilbee 💻	_{Sam Dean} 📖	_mwwynne 💻	_{Carlos J. Puga Medina} 🐛	_{Jon Ericson} 💻	_{Ankit Kr. Singh} 💻
_{Harsha Alva} 💻	_{Pia Mancini} 📖	_{Aditya Tandon} 🐛	_{Akshatha Nayak} 💻	_{Liam Hawkins} 💻	_Arount 💻	_{Cédric Picard} 🐛
_{Amartya Chaudhuri} 💻	_{Elliott Beach} 💻	_{Prashant Chahal} 💻	_{Insiyah Hajoori} 💻	_C 💻	_{Liam Byrne} 💻	_{Tran Chi Khang} 💻
_{Alix Poulsen} 📖	_albalitz 💻	_{Aniruddha Bhattacharjee} 💻	_{Daniel St.Jacques} 💻	_{Donnell Muse} 💻	_{JM Lopez} 💻	_{JOBIN PHILIP ABRAHAM} 📖
_{Jakub Kukul} 💻	_Pigeon 📖	_{Rajdeep Biswas} 💻	_{Sachin Kukreja} 💻	_{Simon Reap} 💻	_Srisaila 💻	_{agarwalnishtha} 💻
_{Frederick Kozlowski} 💻	_{Esha Lath} 💻	_thumpri 💻	_{Adam Zhang} 💻	_{prathampowar2001} 💻	_{Subhankar Hotta} 💻	_{ankushduacodes} 💻
_{Shriram Bhat} 💻	_{Vjs Pranav} 💻	_{Saif Kazi} 💻	_pstreff 💻	_anshik1998 💻	_abstanton 💻	_{Sabu Siyad} 💻
_pspiagicw 💻	_{Ryan Hertz} 💻	_tharunc 📖	_{Ananthakrishnan Nair RS} 📖	_{Muthu Annamalai.V} 📖	_Ayushman 💻	_{Tushar Nankani} 💻
_{Ikko Ashimine} 📖	_{Sidharth Ajithkumar} 💻	_{Sam Sheffres} 💻	_{Rushi Dolas} 💻	_{mostlyvirtual} 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Bugs

If you are experiencing any bugs, don’t forget to open a new issue.

Error Solving

If you encounter "AttributeError: 'module' object has no attribute 'SSL ST INIT'

sudo pip uninstall pyopenssl
sudo pip install pyopenssl or sudo easy_install pyopenssl

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 by insane0hflex. Thanks for the post 😉
Special thanks to people who wrote about SoCLI on their blogs and websites:
Tweets:
- @cyb3rops
- @pythontrending
Thanks to my favourite IDE JetBrains PyCharm ❤️ 😄

Liked it?

Hope you liked this project, don't forget to give it a star ⭐

socli dependencies

argcomplete beautifulsoup4 colorama py-stackexchange requests sentry-sdk urwid

FAQs

What is socli?

Stack overflow command line interface. SoCLI allows you to search and browse stack overflow from the terminal. Visit Snyk Advisor to see a full health score report for socli, including popularity, security, maintenance & community analysis.

Is socli popular?

The python package socli receives a total of 350 weekly downloads. As such, socli popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is socli well maintained?

We found indications that socli is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is socli safe to use?

The python package socli was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 12 May-2024, at 12:39 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP