Welcome to sphinx’s documentation!¶

Introduction ¶

Readit is command line bookmark manager. It is a command line utility to add, delete, update and display the bookmarks. It is a powerful bookmark manager written in Python. It uses SQLite3 to store the bookmarks.

Contents

Welcome to sphinx’s documentation!
Indices and tables

Features ¶

Bookmark multiple URLs at a time
Bookmark URL with respective Tags
Search and display Bookmarks by TAG
Display all Bookmarks in table format
Remove a Bookmarked URL
Remove all Bookmarked URLs
Update a Bookmarked URL with specific ID
URL validation
Open URL in browser

Installation ¶

Dependencies ¶

Features	Dependancy
`Scripting Language`	Python 2.7+
`HTTP(S)`	requests
`Command-Line Option and argument parsing`	Click
`Database Used`	SQLite3
`Display Bookmarks in Table`	beautifultable

From a package manager ¶

PyPi (pip3 install –user readit).

Release Packages ¶

Packages for Fedora are availabe with the latest release.

Usage ¶

Cmdline options ¶

Usage: readit [OPTIONS] [INSERT]...

  Readit - Command-line bookmark manager tool.

Options:
-a, --add TEXT...     Add URLs with space-separated
-t, --tag TEXT...     Add Tag with space-separated URL
-d, --delete TEXT     Remove a URL of particular ID
-c, --clear TEXT...   Clear bookmarks
-u, --update TEXT...  Update a URL for specific ID
-s, --search TEXT     Search all bookmarks by Tag
-v, --view TEXT...    Show bookmarks
-o, --openurl TEXT    Open URL in Browser
-V, --version         Check latest version
--help                Show this message and exit.

Examples ¶

Bookmark multiple URLs:

$ readit url1 url2 ...
or
$ readit --add url1 url2 ...
or
$ readit -a url1 url2 ...

View all available bookmarks:

$ readit -v
or
$ readit --view

Update a bookmark using it’s ID:

$ readit -u url_id url
or
$ readit --update url_id url

Delete a bookmarked URL using it’s ID:

$ readit -d url_id
or
$ readit --delete url_id

Clear all the bookmarks:

$ readit -c
or
$ readit --clear

Bookmark URL with TAG:

$ readit -t tag_name url
or
$ readit --tag tag_name url

Search and Display all bookmarks using TAG:

$ readit -s tag_name
or
$ readit --search tag_name

Open URL in Browser using specific ID:

$ readit -o urlid
or
$ readit --openurl urlid

How to Contribute ¶

Clone project from github:

$ git clone https://github.com/projectreadit/readit.git

We recommend to create and activate a virtualenv first:

$ cd readit/

$ virtualenv venv

$ source venv/bin/activate

(venv) $

To install using setup.py file:

(venv) $ python setup.py install

To make build of project:

(venv) $ python setup.py build

Project Structure ¶

Flowchart
Modules