TODO list

[jarun]

Rolling TODO list thread No. 3. Previous thread is #83.

---

Possible improvements we'd like to see:

• Support all options at omniprompt
• Highlight searched keywords in abstract
• Ubuntu PPA
• Show YouTube-specific results abstract (more details)
• Document APIs in NumPy format [owner @jarun]
• Refactor and write unit tests
• Option-related improvements (too lazy to clarify, just read the comment)

Suggestions and PRs welcome!

[zmwangx]

Several ideas, all of which should be almost backwards compatible, but when implemented should be more user-friendly going forward:

1. Toggling of options in the prompt (mentioned this before somewhere)?

2. I would also like to support long command names so that commands are not so abstract to new users, especially the kind of new users who have little experience with REPL-styled utilities in general (not sure if this type of users are actually in our target audience, but it doesn't hurt). Examples:

   n(ext)
       navigate to the next page
   p(revious)
       navigate to the previous page
   o(pen) [INDEX]
       open the result corresponding to INDEX in the browser (open the
       current search instead if INDEX is omitted)
   f(irst)
       jump to the first page
   g(oogle) KEYWORD [KEYWORD...]
       initiate a new search for the given keywords with the original
       options
   e(xit), q(uit), double <ENTER>
       exit gooogler
   ?, h(elp)
       show omniprompt help
   INDEX
       equivalent to open INDEX
   KEYWORD [KEYWORD...]
       equivalent to google KEYWORD [KEYWORD...]
   

3. Completion (using readline) for 1 and 2.

4. googler without arguments enter the REPL instead of printing usage and exit. I always felt a bit weird that we have an interactive interface but users need to do at least one query noninteractively (by which I mean in command line args) to access it. It's like a Google that's only accessible through either Chrome's omnibox or the search bar of an ongoing query, but not from the google.com splash page.

   We can add a --help option for help text (standard anyway), and disable n, p, and f if there's no existing query.

[zmwangx]

A bit of clarification on long command names that I forgot to mention: I personally like the type of interfaces where users should be able to enter a partial command as long as it is unambiguous, e.g., n, ne, nex, next all work as the next command. Same for options.

We could also give the interactive part of our program an OO interface, reminiscent of cmd.Cmd from PSL. We might even be able to just extend cmd.Cmd, which is not powerful enough yet, especially if we want to support options.

[jarun]

1. Toggling of options in the prompt (mentioned this before somewhere)?

At this time we don't have any other than filter. I'm good but I think it'll work differently for different for different options.

The rest of the ideas are very useful. 👍

[zmwangx]

At this time we don't have any other than filter. I'm good but I think it'll work differently for different for different options.

I mean real options like --time. Of course, only a subset of options should work in the prompt (excluded ones are --json, --colors, --tld and such). We'll also need --no* counterparts to some options.

[jarun]

👍

[zmwangx]

Note to self: our URL construction could receive an OO refresh too to make some points above easier and avoid awkward and brittle URL updating code like

url = url.replace('start=%d&' % oldstart, 'start=%d&' % start, 1)

I'll do this and point 4 in #87 (comment) tonight.

[jarun]

👍

[zmwangx]

By the way, is "Document APIs in NumPy format [owner @jarun]" considered done?

[jarun]

Yes, I think we can close it. Most important functions are covered.

[zmwangx]

Checked off. Don't want to create an "archive" entry anymore. Just remove checked off items when we roll the thread.

[jarun]

We can remove the item.

[zmwangx]

I think we can leave it checked off. It gives off a sense of accomplishment... And It will disappear the next time we roll the thread anyway, so it won't get in the way for long.

[jarun]

👍
I guess you should add all the items you identified.

[zmwangx]

Added (sort of).