Table of Contents TOC

• Introduction
  • Supported resources (WIP)
• Installation
  • From pip
  • From source
• Usages
  • Exporting user data (opened tabs, reading list, cloud tabs, bookmarks, histories)
  • Using scripts
  • Notes
• TODO
• Contribution
  • Formatting Code
• References

Introduction

resworb is a Python library for manipulating browser data.

Supported resources (WIP)

	Safari	Firefox	Chrome
Opened tabs	✅	✅
Cloud tabs	✅
Reading list	✅
Bookmarks	✅	✅	✅
Histories	✅	✅	✅

Installation

From pip

pip install resworb

From source

pip install git+https://github.com/Yevgnen/resworb.git

Usages

Please note that the browser database may be locked if your browser is running.

Exporting user data (opened tabs, reading list, cloud tabs, bookmarks, histories)

# -*- coding: utf-8 -*-

from resworb.browsers.safari import Safari

safari = Safari()

print(safari.export(kinds="cloud_tabs"))
print(safari.export(kinds="readings"))
print(safari.export(kinds="bookmarks"))
print(safari.export(kinds="histories"))
print(safari.export(kinds="all"))
print(safari.export(kinds=["bookmarks", "histories"]))

Using scripts

safari export -s all -t output.yaml

Notes

1. Currently on tested on macOS.
2. Some interfaces may only work as expected when the browser is not running.

TODO

• Better exception handling.
• Cross-platform support.
  • Support for Linux, Windows.
  • Remove platform dependent code.
• Fine-grained interfaces.

Contribution

Formatting Code

To ensure the codebase complies with a style guide, please use flake8, black and isort tools to format and check codebase for compliance with PEP8.

References

• GitHub - kcp18/browserhistory: A simple Python module that extracts browser history
• Parse Safari Reading List using Python · GitHub
• helper/SafariBookmarkEditor at master · jedetaste/helper · GitHub
• python-catalin: Get bookmarks from your Firefox browser database.
• List all Firefox tabs with title and URL · GitHub
• This AppleScript saves all the tabs open in all Safari windows to a Markdown file. · GitHub
• Find Safari Tabs with AppleScript