indianopensourcefoundation / dynamic-cli Goto Github PK

💥 Proposal

As per issue #94 discussions, contributors are looking forward to windows support, and the termos package we are using is only implemented for Linux machines.

Till the time we release a proper windows version, the contributors should be able to contribute to the code base. What if I tell you that you can do your development in a Linux environment and still use windows machines? No, I am not talking about dual boot or virtualization. It's WSL!

Windows subsystem for Linux (WSL) is a compatibility layer for running Linux binary executables natively on Windows 10, Windows 11, and Windows Server 2019. I think most of the Windows developers are using Windows 10 and it would be great news for them to use WSL as their development environment.

I am using WSL2 for quite some time and I tried testing dynamic cli. It worked like a charm.

I can create a quick demo resource/ text tutorial on setting up dynamic cli on Windows machines.

Let me know your thoughts. CC: @GouravSardana @sakshatl

We added an action when somebody sends a pull request then one of our action is failing for the first time and when contributors will send one more commit in the same pull then it works.

For example -

• Gourav sends a pull request - Greeting.yaml check will fail.

• Add a new commit - Remove extra spaces or anything

• In the same pull request - Greeting.yaml check will pass.

You can send us a test PR and see it live :)

💥 Proposal

The Dynamic now shows multiple relevant questions accessible by their question number. For ease of use, enable the user to cycle through questions with arrow keys instead. Instead of entering 0, allow the user to exit with Esc key.

Have you read the Contributing Guidelines on Pull Requests?

Yes I have read it.

Allow me to work on this issue if it is selected.

📚 Documentation

"Embedding an animated gif in your README quickly demonstrates what your project does and catches the reader's eye"

In the animated GIF, capture the project in action to help beginners get an idea of what the project is all about. For reference, check this.

Sidenote

In the 4th step here, it is specified to type in pip3 install -e dynamic-cli/ I would suggest using pip3 install -e . instead.

We want an args where we can display our dynamic-cli version.

For example:-

• dynamic --version / dynamic -V
  It will give the version as 0.1 by default and when we published on PyPI then it will show up the new released version

Install dependencies should come after Clone this repository to your local drive. It's given the other way.

I want to add issue templates for proposal, feature and documentation types so that there is proper way to create a new issue in your repo.

Please assign me this task as a part of GSSoC'21
and add necessary labels.

Getting an indentation error after running dynamic -s in arguments/search.py

I am on master branch with all latest changes

Currently Dynamic CLI has a dependency on the termios module. This module does not support windows OS (refer the links provided below for reference). This issue is to point attention towards this drawback and open up a conversation whether this is something that can be addressed.

Please refer:
https://docs.python.org/3/library/tty.html
https://docs.python.org/3/library/termios.html#module-termios

This feature will include the following things -

1. Once a user will enter dynamic -PUT, it will ask for a URL to put and the default URL would be 127.0.0.1:8000 and it will ask for the endpoint or you can put it directly in the URL itself
2. It will ask for headers then it will ask for payloads
3. Optional param - User-Agent
4. It will build on top of CURL.
5. The output will get in JSON with proper syntax highlighter.

Example -

• dynamic -PUT
• Enter the URL with endpoint - [press enter - default would be 127.0.0.1:800]
• Headers - Enter headers
• User Agent [Optional]
• Codes => 200 (OK) or 204 (No Content). 404 (Not Found), if ID not found or invalid.
  Posting (loading emoji)

{
json output
}

Details : the script displays the result even if the user put empty string in questions and tags which should not happen.

I would like to work on this. Kindly assign me this issue

regards
Honey Bhardwaj

As we are using a library that just works on UNIX platforms, it's difficult to run the application on windows computers. But, recently I found out this library called textual which helps us create beautiful terminal user interfaces like in the image below.

The library is only supported for UNIX platforms right now, but they will be rolling out a windows version soon as per their readme 👇🏾

🚀 Feature

We want to display the search results in an organized manner. Hence, we need to change to the following format to display the results:

• For the most upvoted result:

  • Desc:
  • Ans:
  • Snippet:

• For the rest of the results:

  • Question title - URL

Motivation

Currently, as shown in the screenshot below, the results aren't displayed in an organized manner and it's difficult to get the right results.

Pitch

This feature, if implemented, would allow users to get instant access to the most upvoted answer in the same way as on the StackOverflow website.

Hey,

I installed dynamic cli on my local. I'm facing issue -

➜  ~ dynamic -s        
Traceback (most recent call last):
  File "/Users/gsard00/.pyenv/versions/cc362/bin/dynamic", line 11, in <module>
    load_entry_point('dynamic', 'console_scripts', 'dynamic')()
  File "/Users/gsard00/.pyenv/versions/3.6.2/envs/cc362/lib/python3.6/site-packages/pkg_resources/__init__.py", line 565, in load_entry_point
    return get_distribution(dist).load_entry_point(group, name)
  File "/Users/gsard00/.pyenv/versions/3.6.2/envs/cc362/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2631, in load_entry_point
    return ep.load()
  File "/Users/gsard00/.pyenv/versions/3.6.2/envs/cc362/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2291, in load
    return self.resolve()
  File "/Users/gsard00/.pyenv/versions/3.6.2/envs/cc362/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2297, in resolve
    module = __import__(self.module_name, fromlist=['__name__'], level=0)
  File "/Users/gsard00/Desktop/dynamic-cli/main.py", line 4, in <module>
    from src.arguments.search import Search
  File "/Users/gsard00/Desktop/dynamic-cli/src/arguments/search.py", line 7, in <module>
    from .utility import Utility
  File "/Users/gsard00/Desktop/dynamic-cli/src/arguments/utility.py", line 12, in <module>
    from simple_term_menu import TerminalMenu
  File "/Users/gsard00/.pyenv/versions/3.6.2/envs/cc362/lib/python3.6/site-packages/simple_term_menu.py", line 118, in <module>
    class BoxDrawingCharacters:
  File "/Users/gsard00/.pyenv/versions/3.6.2/envs/cc362/lib/python3.6/site-packages/simple_term_menu.py", line 119, in BoxDrawingCharacters
    if getlocale()[1] == "UTF-8":
  File "/Users/gsard00/.pyenv/versions/3.6.2/lib/python3.6/locale.py", line 581, in getlocale
    return _parse_localename(localename)
  File "/Users/gsard00/.pyenv/versions/3.6.2/lib/python3.6/locale.py", line 490, in _parse_localename
    raise ValueError('unknown locale: %s' % localename)
ValueError: unknown locale: UTF-8

To solve this, You'll have to follow below instructions in bashrc or zshrc depend upon your mac.

1. Open bashrc/zshrc and copy paste below line

export LC_ALL=en_US.UTF-8
export LANG=en_US.UTF-8

2. run source ~/.bash_profile

Now issue will be resolved. Link here

💥 Proposal

This is one of the results from a search in the dynamic-cli:

As you can see the syntax highlighting is not very prominent among a few other issues - so I would like to propose the following changes:

• Better syntax highlighting (preferrably with a contrasting color)
• If user searches for a query/phrase/keyword, it is better to include the questions along with answers as well - Right now only the answers' source links are provided, which might force the user from quitting the terminal and heading over to the site straightaway - which violates the main objective of this application.
• Also as a user, I would like to have a proper demarcation(preferrably line breaks) between any 2 answers. Right now we are just providing a series of dashes(---).

Have you read the Contributing Guidelines on Pull Requests?

(Write your answer here.)

We need a new GIF for our readme. The previous one is quite old. We have new features as well with better UX

We can have a Codacy integration in this project. So that before merging it will automatically analyze the quality of the code.

Learn more about Codacy here

The user should able to copy the code from the StackOverflow answer. For more, you can see this PR #82 and see the GIF

Description

When we run it, HTML entities are used in place of string

For Ex. ,
&lt; instead of <
&gt; instead of >

I would like to work on it.

Also Please add gssoc labels

🚀 Feature

My idea:
After displaying the results(from StackExchange), we can open up the stdin to receive keypresses. So that we can perform specific tasks(or functions) with keyboard shortcuts.

Examples:
ctrl+s - > to save results to a file
ctrl+r -> Reload the results.

And many more...

The keyboard module will help us listen for keypresses.

Have you read the Contributing Guidelines on Pull Requests?

Yes

Motivation

I implemented this feature while I was working on a project. I thought we could implement this feature in dynamic-cli because it makes it easier for people to use the cli.

Pitch

explained above

In this feature, we need these things -

1. Create a notion account and generate the token. The flow would be like this -

   • dynamic --notion -> Open up notion login to the browser and ask them to log in.

   • After this -> The terminal will show. 'Notion Logged in' or 'Notion logged in failed'

2. Now it's time to upload. Use dynamic --notionupload or nu. Then it will automatically fill up the question to the notion. We have to implement a similar thing like this. We have to make this from scratch.

🚀 Feature

If a question searched on the cli, if that doesn't in StackOverflow then it will automatically call Reddit API to search it on Reddit and provide you the link or the description.

You can create your function here

Pitch

This feature is good because we are using Reddit as a backup. If there is no answer in the StackOverflow.

This is related to GirlScript Summer of Code 2021. Anyone can pick this.

For now, we don't have any test which will give us a surety that we can deploy our new changes without affecting the previous one. If we have our own test where we can surely say that it might not fail when we release a new version or new feature.

I will like to add a feature this will update contributor list in read me automatically !! Will start to work on this issue as soon as i get assigend !!

📚 Documentation

(A clear and concise description of what the issue is.)
There is no code of conduct file explaining all the rules that should be followed while contributing to a project so would like to add one under gssoc

Have you read the Contributing Guidelines on Pull Requests?

Yes
(Write your answer here.)

We have a feature where you can make a post request from the terminal using dynamic --POST. We need to add a new thing to test the API concurrency.

Suppose, you are testing the performance of an API i.e How many loads it can take at one time. Make an args for this and it will take 1 more parameter i.e value
Example -
Dynamic --POST --perftest [args name can be anything other than perftest but should be meaningful]
->API URL
->Payload [If required] [Optional]
-> How much thread you want to create - [User input] #Let say I gave 100

It'll make 100 requests at the same time to that API with the payload [if required] and return the output in the table format which displays how much time each request takes and download as a pdf or text file. If the request fails or takes time we can return the timeout

In our dynamic cli, we are using one default API key. We can have an option where the user can set his own custom API key rather than using our own.

@pranavbaburaj Can talk about it more!

Integrate Travis CI with our dynamic-cli and add relevant build (pass/fail) icon in the readme as well.

For more information about Travis click here

Add the guidelines to install dynamic on the window OS because the user needs to set up WSL in the window OS to make it work [It doesn't take much time]. We are working on it to make it independent but some of the binaries are different in window and termios is causing the issue. For more detail refer #94

💥 Proposal: Emoji in CLI

We can add relevant emojis in the CLI like minikube (Kubernetes). Check the screenshot below for reference:

📚 Documentation

The starting of the readme file has the project name and the description which looks very simple i want to update that so that it look nice.

Have you read the Contributing Guidelines on Pull Requests?

yes i have read it.

i would love to work on it
Regards
Honey Bhardwaj

This feature will include the following things -

1. Once a user will enter dynamic -GET, it will ask for a URL to put and the default URL would be 127.0.0.1:8000 and it will ask for the end point or you can put directly in the URL itself
2. It will build on top of CURL.
3. Output will get in JSON with proper syntax highlighter.

Example -
dynamic -GET
Enter the URL - [press enter - default would be 127.0.0.1:800]

Trying (loading emoji)

{
json result;
}

Greeting.yaml build is failing while someone sends a pull request. Anybody can pick this up and fix this.

You can find the greeting.yaml here

Discussed in #114

@utsabc Please research and work on this issue as mentioned #90

Add all the args which we have in our dynamic-CLI to the Readme. So that If new users/contributors will come, It will easily find out all the information from the readme itself.
For Example: -

Usage

Usage: Dynamic [OPTIONS]

A Modern, user-friendly command-line HTTP client for the API testing, and if you're stuck - Search and browse StackOverflow without leaving the CLI.

Options:
  -v, --version                 gives the version of our CLI
  -s, --search                  Search a question on StackOverflow
 -d,  --debug                   Turn on debugging mode
  --help                        Show this message and exit.

As you all know our Dynamic CLI is used to find out answers from Stackoverflow. What if users want to save that question to their playbook.

Idea is to maintain a playbook in their local storage where all the package data will store and we can add an option after giving the answers to the StackOverflow question - Do you want to save this in your playbook? Y/N

If users replied yes then save it to their local storage and if users want to get those data back use - dynamic --playbook or dynamic --p. It will display the data in table form.

💥 Proposal

(A clear and concise description of what the proposal is.)

A pull request template explains all about a pr including its description and set of checklists that it follows

Have you read the Contributing Guidelines on Pull Requests?

yes
(Write your answer here.)

🚀 Feature

This feature will view one answer at a time & the user can navigate through the answers with the help of arrow keys. This will make it easier for the user to see an answer.

Have you read the Contributing Guidelines on Pull Requests?

Yes

Motivation

It was very frustrating for me to scroll through every time to find an answer among so many.

Pitch

It increases the ease of use of this project.

Please assign me this Issue and Add gssoc label. @GouravSardana

The Readme file can be enhanced by adding a list of all the Open Source programs in which this project was listed in.

Running dynamic -s after following installation instructions throws AttributeError.

We need dynamic-cli logo. If anybody wants to contribute :)

@GouravSardana I will pick this up.

CLI related code should be in different file and core code in other files.

Type - Refactor

This feature will include the following things -

1. Once a user will enter dynamic -DELETE, it will ask for a URL to put and the default URL would be 127.0.0.1:8000 and it will ask for the endpoint or you can put it directly in the URL itself
2. It will ask for headers then it will ask for payloads
3. Optional param - User-Agent
4. It will build on top of CURL or Request
5. The output will get in JSON with proper syntax highlighter.

Example -

• dynamic -DELETE
• Enter the URL with endpoint - [press enter - default would be 127.0.0.1:800]
• Headers - Enter headers
• User Agent [Optional]
• Codes => 200 (OK). 404 (Not Found), if ID not found or invalid.
  Posting (loading emoji)

{
json output
}

📚 Documentation

The utility.py file contains functionalities which are used in fetching answers from APIs. It would be better to mention concise comments(before each function) mentioning the functionality of the methods and if the function is relatively long - a little bit of description about the flow as to what exactly that function does

Have you read the Contributing Guidelines on Pull Requests?

We have 2 options right now. One is to enter from the terminal and the other is to upload a .json file for payload. We can add a new option that I have discussed with @harshakhmk in PR #111 . We have to implement it for a better user experience.

📚 Documentation

I would like on work on this under GSSoC, I would like to update the Readme, to make it easier for the students to see how they can contribute, from forking the project to creating a pull request. If this is okay, kindly assign it to me, otherwise would you create other issues?

Have you read the Contributing Guidelines on Pull Requests?

Yes

We don't have any feature where we can add a new question on Stackoverflow using our Dynamic-cli.

Here are some details: -
Example -

1. dynamic --new
   It will open up the default web browser and open StackOverflow in it with this link

2. dynamic --new [title] [desc]
   It will open up the default browser but with all the relevant fields filled already like title and description.

This feature will include the following things -

1. Once a user will enter dynamic -POST, it will ask for a URL to put and the default URL would be 127.0.0.1:8000 and it will ask for the endpoint or you can put it directly in the URL itself
2. It will ask for headers then it will ask for payloads
3. Optional param - User-Agent
4. It will build on top of CURL.
5. The output will get in JSON with proper syntax highlighter.

Example -

• dynamic -POST
• Enter the URL with endpoint - [press enter - default would be 127.0.0.1:800]
• Headers - Enter headers
• User Agent [Optional]

Posting (loading emoji)

{
json output
}