Metadata-Version: 2.1
Name: firefox-bookmarks
Version: 1.0.0
Summary: Manage your Firefox bookmarks with ease
Home-page: https://github.com/BURG3R5/firefox-bookmarks
License: AGPL-3.0-or-later
Keywords: firefox,bookmarks,browser,util
Author: Aditya Rajput
Author-email: adiraj20072002@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Database
Classifier: Topic :: Internet :: WWW/HTTP :: Browsers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Dist: peewee (>=3.16.2,<4.0.0)
Project-URL: Changelog, https://github.com/BURG3R5/firefox-bookmarks/blob/main/CHANGELOG.md
Project-URL: Documentation, https://github.com/BURG3R5/firefox-bookmarks
Project-URL: Repository, https://github.com/BURG3R5/firefox-bookmarks
Description-Content-Type: text/markdown

# firefox-bookmarks

<p align="center">
    <a href="https://github.com/BURG3R5/firefox-bookmarks/actions/workflows/ci.yml">
        <img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/BURG3R5/firefox-bookmarks/ci.yml?branch=main&style=flat-square">
    </a>
    <a href="https://github.com/BURG3R5/firefox-bookmarks/blob/main/LICENSE">
        <img alt="License - AGPL v3 or later" src="https://img.shields.io/pypi/l/firefox-bookmarks?style=flat-square">
    </a>
    <a href="https://pypi.org/project/firefox-bookmarks/">
        <img alt="PyPI" src="https://img.shields.io/pypi/v/firefox-bookmarks?style=flat-square">
    </a>
    <a href="https://github.com/google/yapf">
        <img alt="Code style: YAPF" src="https://img.shields.io/badge/code%20style-yapf-blue?style=flat-square">
    </a>
    </a>
    <a href="https://pycqa.github.io/isort">
        <img alt="Code style: isort" src="https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat-square">
    </a>
</p>

Manage your Firefox bookmarks with ease

## installation

```shell
pip install firefox-bookmarks
```

## usage

Import and initialize:

```python
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)

```python
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](https://github.com/BURG3R5/firefox-bookmarks/tree/main/examples)

## contributing

Want to fix a bug, add a feature, or improve documentation? Awesome! Read up on our [guidelines for contributing](https://github.com/BURG3R5/firefox-bookmarks/blob/main/.github/CONTRIBUTING.md) and then visit our [/contribute page](https://github.com/BURG3R5/firefox-bookmarks/contribute) 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](https://github.com/BURG3R5/firefox-bookmarks/blob/main/LICENSE) of the Affero GPL v3 along with this program. If not, you can visit the original [here](https://www.gnu.org/licenses/agpl-3.0.html#license-text).

