Skip to main content

It is bookmark manager.

Project description

# Readit - Command Line Tool

[![Python](https://img.shields.io/badge/python-2.7%2C%203.6-blue.svg)]() [![LICENSE](https://img.shields.io/badge/license-GPLv3-yellow.svg?maxAge=2592000)]() [![Build Status](https://travis-ci.org/ganeshhubale/readit.svg?branch=master)](https://travis-ci.org/ganeshhubale/readit)

## 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.

## 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

#### Dependencies

| Feature | Dependency |
| --- | --- |
| Scripting language | Python 2.7+ |
| HTTP(S) | Requests |
| Command-Line Option and Argument Parsing | Click |
| Database used | SQLite3 |
| Display Bookmarks in Table | beautifultable |


#### Command line 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


1. **Bookmark** multiple URLs:

readiturl1url2...or readit --add url1 url2 ...
or
readitaurl1url2...2.Viewallavailablebookmarks: readit -v
or
readitview3.UpdateabookmarkusingitsID: readit -u url_id url
or
readitupdateurlidurl4.DeleteabookmarkedURLusingitsID: readit -d url_id
or
readitdeleteurlid5.Clearallthebookmarks: readit -c
or
readitclear6.BookmarkURLwithTAG: readit -t tag_name url
or
readittagtagnameurl7.SearchandDisplayallbookmarksusingTAG: readit -s tag_name
or
readitsearchtagname8.OpenURLinBrowserusingspecificID: readit -o urlid
or
You can't use 'macro parameter character #' in math mode git clone https://github.com/ganeshhubale/readit.git
```

* We recommend to create and activate a virtualenv first:
```
cdreadit/ virtualenv venv

sourcevenv/bin/activate(venv)
```

* To install using setup.py file:
```
(venv) pythonsetup.pyinstallTomakebuildofproject:(venv) python setup.py build
```



#### [License](https://github.com/ganeshhubale/readit/blob/master/LICENSE)
----

Readit - Command line tool is licensed under [GNU General Public License v3.0](https://github.com/ganeshhubale/readit/blob/master/LICENSE).

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page