Skip to content

BURG3R5/firefox-bookmarks

Repository files navigation

README banner for firefox-bookmarks

CI Status PyPI License - AGPL v3 or later Code style: YAPF Code style: isort

firefox-bookmarks

Manage your Firefox bookmarks with ease

installation

pip install firefox-bookmarks

usage

Import and initialize:

from firefox_bookmarks import *

fb = FirefoxBookmarks()

# You can pass a `ProfileCriterion` to choose from multiple profiles
fb.connect(criterion=ProfileCriterion.LARGEST)

Query as you would in peewee (or Django or SQLAlchemy)

github_bookmarks = fb.bookmarks(
    where=Bookmark.url.contains("https://github.com"),
)

for bookmark in github_bookmarks:
    print(f"Title: {bookmark.title}\nURL: {bookmark.url}\n")

examples

See the examples directory

contributing

Want to fix a bug, add a feature, or improve documentation? Awesome! Read up on our guidelines for contributing and then visit our /contribute page to find good first issues! Pull requests are always welcome!

license

Copyright (C) 2023 Aditya Rajput & other contributors

This software is licensed under the Affero GPL v3. You should have received a copy of the Affero GPL v3 along with this program. If not, you can visit the original here.