    
# firefox-bookmarks
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).
Raw data
{
"_id": null,
"home_page": "https://github.com/BURG3R5/firefox-bookmarks",
"name": "firefox-bookmarks",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "firefox, bookmarks, browser, util",
"author": "Aditya Rajput",
"author_email": "adiraj20072002@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b9/db/98b033ba56f69f4312d44a660f59ded262733c1e5dc82992dcedb180d77a/firefox_bookmarks-1.2.0.tar.gz",
"platform": null,
"description": "\n\n    \n\n# firefox-bookmarks\n\nManage your Firefox bookmarks with ease\n\n## installation\n\n```shell\npip install firefox-bookmarks\n```\n\n## usage\n\nImport and initialize:\n\n```python\nfrom firefox_bookmarks import *\n\nfb = FirefoxBookmarks()\n\n# You can pass a `ProfileCriterion` to choose from multiple profiles\nfb.connect(criterion=ProfileCriterion.LARGEST)\n```\n\nQuery as you would in peewee (or Django or SQLAlchemy)\n\n```python\ngithub_bookmarks = fb.bookmarks(\n where=Bookmark.url.contains(\"https://github.com\"),\n)\n\nfor bookmark in github_bookmarks:\n print(f\"Title: {bookmark.title}\\nURL: {bookmark.url}\\n\")\n```\n\n## examples\n\nSee [the examples directory](https://github.com/BURG3R5/firefox-bookmarks/tree/main/examples)\n\n## contributing\n\nWant 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!\n\n## license\n\nCopyright (C) 2023 Aditya Rajput & other contributors\n\nThis 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).\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "Manage your Firefox bookmarks with ease",
"version": "1.2.0",
"project_urls": {
"Changelog": "https://github.com/BURG3R5/firefox-bookmarks/blob/main/CHANGELOG.md",
"Documentation": "https://github.com/BURG3R5/firefox-bookmarks",
"Homepage": "https://github.com/BURG3R5/firefox-bookmarks",
"Repository": "https://github.com/BURG3R5/firefox-bookmarks"
},
"split_keywords": [
"firefox",
" bookmarks",
" browser",
" util"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc4f4de7060417f5db318eff22957547f87e010e19d2e7cedc8565f234c17e21",
"md5": "b836370d0d751d70d64c251b143e5c4b",
"sha256": "e5a43ad62fac8feb42845a4d49ae9b9042b260fd39140d76640425bb93e2eaa6"
},
"downloads": -1,
"filename": "firefox_bookmarks-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b836370d0d751d70d64c251b143e5c4b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 24660,
"upload_time": "2024-07-05T08:32:35",
"upload_time_iso_8601": "2024-07-05T08:32:35.602024Z",
"url": "https://files.pythonhosted.org/packages/bc/4f/4de7060417f5db318eff22957547f87e010e19d2e7cedc8565f234c17e21/firefox_bookmarks-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b9db98b033ba56f69f4312d44a660f59ded262733c1e5dc82992dcedb180d77a",
"md5": "936ba155aff57451b97cc988abfe2de6",
"sha256": "4af39bd2ac53281b142a4797c8229a14175617369c7531254f1ada34444138bc"
},
"downloads": -1,
"filename": "firefox_bookmarks-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "936ba155aff57451b97cc988abfe2de6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 21781,
"upload_time": "2024-07-05T08:32:38",
"upload_time_iso_8601": "2024-07-05T08:32:38.061872Z",
"url": "https://files.pythonhosted.org/packages/b9/db/98b033ba56f69f4312d44a660f59ded262733c1e5dc82992dcedb180d77a/firefox_bookmarks-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-05 08:32:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BURG3R5",
"github_project": "firefox-bookmarks",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "firefox-bookmarks"
}
JSON
