Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jlilja/bookie

Automating firefox bookmarks as code
https://github.com/jlilja/bookie

firefox firefox-addon

Last synced: 13 days ago
JSON representation

Automating firefox bookmarks as code

Awesome Lists containing this project

README

        

# Bookie

This is a project aimed to automate the process of adding and administrating bookmarks for Firefox.

### Requirements

* Python 3
* Firefox version >= 3

### Usage

`$ python3 app.py [browser] [profile]`

[browser] currently only supports 'firefox'.

[profile] Can be found by browsing `about:profiles`. Looks like `kyy5y7i1.default-release`.

For usage of this script without any modification, Bookie will use the `bookmarks-example.yml` file as reference to which bookmarks to create.

This script will append bookmarks to the existing bookmarks in your filefox profile.

### bookmarks yml file

#### Bookmark

```
type [STRING, REQUIRED] "bookmark"
title [STRING, REQURED] The title of the bookmark.
url [STRING, REQUIRED] The URL to the website of the bookmark.
children [LIST] A list of records with bookmarks and/or folders.
```
Example:

```
- type: bookmark
title: Reddit
url: https://www.reddit.com
```

#### Folder

```
type [STRING, REQUIRED] "folder"
title [STRING, REQURED] The title of the folder.
children [LIST] A list of records with bookmarks and/or folders.
```

Example:

```
- type: folder
title: work
children:

- type: bookmark
title: Github
url: https://github.com

- type: folder
title: WFH
children:

- type: bookmark
title: jitsi
url: https://jitsi.org/
```

### What is missing?

* Option to clear all existing bookmarks and populate the bookmarks defined in `bookmarks-example/private.yml`.
* creating other bookmark yml file beside bookmarks-example.yml