Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Add example applications #160

Open
Samyak2 opened this issue Sep 20, 2021 · 4 comments · May be fixed by #175
Open

[DOCS] Add example applications #160

Samyak2 opened this issue Sep 20, 2021 · 4 comments · May be fixed by #175
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest Issues opened for Digital Ocean's Hacktoberfest priority: low Issues that you can procrastinate on

Comments

@Samyak2
Copy link
Member

Samyak2 commented Sep 20, 2021

Is your feature request related to a problem? Please describe.

The documentation has a quick start and a small usage section, but it lacks a complete example of something that browser-history can be used for.

Describe the solution you'd like

At least one example script that can be run directly to show what one can do with browser-history. Some examples:

  • A python script to show the top 10 most visited websites of the user
    • This will demonstrate retrieving history and finding useful information from it
  • A python script to show all bookmarks and how many times each of them was visited
    • This will demonstrate both retrieving history as well as bookmarks

If you have any ideas for this, please suggest below :)

Additional context

To see how to add a section in the documentation refer #136 (https://github.com/pesos/browser-history/pull/136/files)

Refer the contributing guidelines for more information on making documentation changes: https://browser-history.readthedocs.io/en/latest/contributing.html#contributing
@Samyak2 Samyak2 added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers priority: low Issues that you can procrastinate on labels Sep 20, 2021
@Samyak2 Samyak2 added the hacktoberfest Issues opened for Digital Ocean's Hacktoberfest label Oct 3, 2021
@ayushkumar1610
Copy link

Hi @Samyak2,
I liked your idea of providing some samples which can demonstrate the uses of browser-history. I liked your suggestion to show the top 10 visited websites of the user. So, can I work on this?

Thanks

@Samyak2
Copy link
Member Author

Samyak2 commented Oct 10, 2021

@ayushkumar1610 Sounds great! You can go ahead with it.

@ayushkumar1610
Copy link

Thanks @Samyak2, I'm working on it.

@ayushkumar1610
Copy link

ayushkumar1610 commented Oct 14, 2021 •
edited

Hi @Samyak2, I've made a pull request regarding the same please review it and suggest if any change is needed.
Pull request

@ayushkumar1610 ayushkumar1610 linked a pull request Oct 20, 2021 that will close this issue
Open
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest Issues opened for Digital Ocean's Hacktoberfest priority: low Issues that you can procrastinate on
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

another usages added ayushkumar1610/browser-history
2 participants
@Samyak2 @ayushkumar1610