Welcome to Frostmark’s documentation!

Getting started

Config

Modify how the application runs with the Environment variables.

React GUI

FROSTMARK_HOST

Specify what host you want to run the server layer between Frostmark and React frontend displaying the bookmarks.

Development

REACT_PROXY

Specify the endpoint for all the requests attempted to fetch from with Node’s fetch().

Entrypoint

Module for interfacing with the package via python command:

python -m frostmark

Common

Module for common functions.

DB Base

Module for creating a connection to SQLite DB and SQLAlchemy declarative base home.

Database

Module for creating SQLite DB schema and session retrieving.

frostmark.db.folder_check_root(session)

Check whether default rows for Folder model exist and create them if not.

frostmark.db.get_session()

Create DB schema and return a new session.

Models

ORM SQLAlchemy models for Frostmark application storage.

class frostmark.models.Bookmark(**kwargs)

Bookmark item containing URL, title, icon (favicon.ico) and folder_id.

class frostmark.models.Folder(**kwargs)

Folder item for grouping bookmarks. ID 0 is reserved for ROOT folder.

get_root

Return root folder constants to e.g. create root folder value in DB if it does not exist.

User data

Parser

Module for parsing arguments from console.

class frostmark.parser.ExecuteAction(*a, func=None, func_args=(), func_kwargs={}, **kw)

ArgumentParser action for add_argument(action=…)

Executes a function and its args + kwargs passed as the __init__ arguments:

• func
• func_args
• func_kwargs

together with argument values inserted into func_kwargs as ‘arg_values’ and exits immediately.

class frostmark.parser.FrostmarkArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=<class 'argparse.HelpFormatter'>, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True)

Inheriting from ArgumentParser to print custom print message.

Profiles

Module for retrieving all ‘profiles’ from specified browser.

Importer

Import bookmarks from various bookmarks database files into internal database.

class frostmark.importer.Importer

Interface for retrieving and importing bookmarks into local storage for multiple backends.

import_from

Import bookmarks from particular path into internal storage.

Exporter

Export bookmarks from internal database into various formats.

class frostmark.exporter.Exporter

Interface for retrieving and exporting bookmarks from local storage to multiple backends.

export_to

Export bookmarks from internal storage to particular path.

Core

Tests

Test: Database

Module for creating a connection to SQLite DB and SQLAlchemy declarative base home.

class frostmark.tests.test_database.DBBaseTestCase(methodName='runTest')

TestCase for SQLite database backend.

test_db_base()

Test all variables, locations, files for creating DB base.

test_db_create()

Test creating SQLite3 DB only (without tables) in the user_data section.

test_db_session()

Test getting session for SQLite DB which passively creates a new DB (new .sqlite file) if it isn’t present yet.

Indices and tables

• Index
• Module Index
• Search Page