**************************
Readit - Command Line Tool
**************************
.. class:: no-web no-pdf
|Python| |Licence| |Build Status| |docs passing|
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 database to store the bookmarks.
Features
********
* Bookmark multiple URLs at a time
* Bookmark URL with respective Tags at the same time [NEW]
* Search and display Bookmarks by TAG and URL's substring
* Display all Bookmarks in table format
* Remove single or all Bookmarked URL
* Update a Bookmarked URL with a specific ID
* URL validation
* Open multiple URLs in the browser
* Choose specific folder and Export bookmarks into the CSV file [NEW]
* Show all Tags available in the database
* Bookmark URLs either online or offline
Dependencies
************
============================================= ==================
Features Dependancy
============================================= ==================
``Scripting Language`` Python 3.0+
``HTTP(S)`` requests
``Command-line parsing`` click
``Database`` SQLite3
``Display Bookmarks in Table`` beautifultable
============================================= ==================
Installation
************
Readit is available on PyPI and can be installed with pip3:
.. code-block:: bash
pip3 install --user readit
Command line options
********************
.. code-block:: bash
Usage: readit [OPTIONS] [INSERT]...
Readit - Command-line bookmark manager tool.
Options:
-a, --add TEXT Add urls --> readit -a <url1> <url2>
-t, --tag TEXT Use to tag url --> readit -a <url1> -t <tag1>
-d, --delete TEXT Remove a URL of particular ID --> readit -d <url_id>
-c, --clear TEXT Clear bookmarks --> readit -c
-u, --update TEXT Update a URL for specific ID --> readit -u
<existing_id> <new_url>
-s, --search TEXT Search for bookmarks using either a tag or a
substring of the URL --> readit -s <tag> or
<substring>
-v, --view TEXT... Show bookmarks --> readit -v
-o, --openurl TEXT Open a URL in your browser by entering a part of the
URL. --> readit -o <url_substring>
-V, --version Check latest version --> readit -V
-e, --export TEXT... Export URLs in csv file --> readit -e
-tl, --taglist TEXT... Show all Tags --> readit -tl
--help Show this message and exit.
Examples
********
1. **Bookmark** multiple URLs:
.. code-block:: bash
$ readit <url1> <url2> ...
or
$ readit --add <url1> <url2> ...
or
$ readit -a <url1> <url2> ...
2. **Bookmark** urls and tags at the same time
.. code-block:: bash
$ readit -a <url1> -t <tag1>
2. **View** all available bookmarks:
.. code-block:: bash
$ readit -v
or
$ readit --view
3. **Update** a bookmark using its ID:
.. code-block:: bash
$ readit -u <url_id> <url>
or
$ readit --update <url_id> <url>
4. **Delete** a bookmarked URL using its ID:
.. code-block:: bash
$ readit -d <url_id>
or
$ readit --delete <url_id>
5. **Clear** all the bookmarks:
.. code-block:: bash
$ readit -c
or
$ readit --clear
6. **Search** and **Display** all bookmarks using the TAG or URL's substring:
.. code-block:: bash
$ readit -s <tag_name> or <url_substring>
or
$ readit --search <tag_name> or <url_substring>
7. Open URL in the Browser using URL's substring:
.. code-block:: bash
$ readit -o <url_substring>
or
$ readit --openurl <url_substring>
8. **Export** bookmarks into the CSV file:
.. code-block:: bash
$ readit --export
or
$ readit -e
9. Show all Tags available in the database
.. code-block:: bash
$ readit -tl
or
$ readit --taglist
How to install source code for development
**********************************************
* Clone project from github:
.. code-block:: bash
$ git clone https://github.com/pythonpune/readit.git
* We recommend to create and activate a virtualenv first:
.. code-block:: bash
$ cd readit/
$ python3 -m venv env
$ source env/bin/activate
$ pip3 install setuptools
* To install using setup.py file:
.. code-block:: bash
(env) $ python setup.py install
* To make a build of the project:
.. code-block:: bash
(env) $ python setup.py build
************************************************************************
`Licence <https://github.com/pythonpune/readit/blob/master/LICENSEE>`_
************************************************************************
Readit - Command line tool is licensed under `GNU General Public License v3.0. <https://github.com/pythonpune/readit/blob/master/LICENSE>`_
.. |Python| image:: https://img.shields.io/badge/python-3.6-blue.svg
.. |Licence| image:: https://img.shields.io/badge/license-GPLv3-yellow.svg?maxAge=2592000
:target: https://github.com/pythonpune/readit/blob/master/LICENSE
.. |Build Status| image:: https://travis-ci.org/pythonpune/readit.svg?branch=master
:target: https://travis-ci.org/pythonpune/readit
.. |docs passing| image:: https://readthedocs.org/projects/readit/badge/?version=latest
:target: http://readittool.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Raw data
{
"_id": null,
"home_page": "https://github.com/projectreadit/readit",
"name": "readit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "clitool, bookmark, readit",
"author": "Ganesh, Shital, Daivshala",
"author_email": "ganeshhubale03@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1d/81/178312000a7324317866cf9e1d3ac576ebbb75f79ebc7ca9d408d1d42102/readit-1.0.3.tar.gz",
"platform": null,
"description": "**************************\nReadit - Command Line Tool\n**************************\n\n.. class:: no-web no-pdf\n\n|Python| |Licence| |Build Status| |docs passing|\n\n\nIntroduction\n************\nReadit 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 database to store the bookmarks.\n\n\nFeatures\n********\n* Bookmark multiple URLs at a time\n* Bookmark URL with respective Tags at the same time [NEW]\n* Search and display Bookmarks by TAG and URL's substring\n* Display all Bookmarks in table format\n* Remove single or all Bookmarked URL\n* Update a Bookmarked URL with a specific ID\n* URL validation\n* Open multiple URLs in the browser\n* Choose specific folder and Export bookmarks into the CSV file [NEW]\n* Show all Tags available in the database\n* Bookmark URLs either online or offline\n\n\nDependencies\n************\n============================================= ==================\n Features Dependancy\n============================================= ==================\n``Scripting Language`` Python 3.0+\n``HTTP(S)`` requests\n``Command-line parsing`` click\n``Database`` SQLite3\n``Display Bookmarks in Table`` beautifultable\n============================================= ==================\n\nInstallation\n************\nReadit is available on PyPI and can be installed with pip3:\n\n.. code-block:: bash\n\n pip3 install --user readit\n\nCommand line options\n********************\n.. code-block:: bash\n\n Usage: readit [OPTIONS] [INSERT]...\n\n Readit - Command-line bookmark manager tool.\n Options:\n -a, --add TEXT Add urls --> readit -a <url1> <url2>\n -t, --tag TEXT Use to tag url --> readit -a <url1> -t <tag1>\n -d, --delete TEXT Remove a URL of particular ID --> readit -d <url_id>\n -c, --clear TEXT Clear bookmarks --> readit -c\n -u, --update TEXT Update a URL for specific ID --> readit -u\n <existing_id> <new_url>\n -s, --search TEXT Search for bookmarks using either a tag or a\n substring of the URL --> readit -s <tag> or\n <substring>\n -v, --view TEXT... Show bookmarks --> readit -v\n -o, --openurl TEXT Open a URL in your browser by entering a part of the\n URL. --> readit -o <url_substring>\n -V, --version Check latest version --> readit -V\n -e, --export TEXT... Export URLs in csv file --> readit -e\n -tl, --taglist TEXT... Show all Tags --> readit -tl\n --help Show this message and exit.\n\n\nExamples\n********\n1. **Bookmark** multiple URLs:\n\n.. code-block:: bash\n\n $ readit <url1> <url2> ...\n or\n $ readit --add <url1> <url2> ...\n or\n $ readit -a <url1> <url2> ...\n\n2. **Bookmark** urls and tags at the same time\n\n.. code-block:: bash\n\n $ readit -a <url1> -t <tag1>\n\n2. **View** all available bookmarks:\n\n.. code-block:: bash\n\n $ readit -v\n or\n $ readit --view\n\n3. **Update** a bookmark using its ID:\n\n.. code-block:: bash\n\n $ readit -u <url_id> <url>\n or\n $ readit --update <url_id> <url>\n\n4. **Delete** a bookmarked URL using its ID:\n\n.. code-block:: bash\n\n $ readit -d <url_id>\n or\n $ readit --delete <url_id>\n\n5. **Clear** all the bookmarks:\n\n.. code-block:: bash\n\n $ readit -c\n or\n $ readit --clear\n\n6. **Search** and **Display** all bookmarks using the TAG or URL's substring:\n\n.. code-block:: bash\n\n $ readit -s <tag_name> or <url_substring>\n or\n $ readit --search <tag_name> or <url_substring>\n\n7. Open URL in the Browser using URL's substring:\n\n.. code-block:: bash\n\n $ readit -o <url_substring>\n or\n $ readit --openurl <url_substring>\n\n8. **Export** bookmarks into the CSV file:\n\n.. code-block:: bash\n\n $ readit --export\n or\n $ readit -e\n\n9. Show all Tags available in the database\n\n.. code-block:: bash\n\n $ readit -tl\n or\n $ readit --taglist\n\nHow to install source code for development\n**********************************************\n* Clone project from github:\n\n.. code-block:: bash\n\n $ git clone https://github.com/pythonpune/readit.git\n\n* We recommend to create and activate a virtualenv first:\n\n.. code-block:: bash\n\n $ cd readit/\n\n $ python3 -m venv env\n\n $ source env/bin/activate\n\n $ pip3 install setuptools\n\n* To install using setup.py file:\n\n.. code-block:: bash\n\n (env) $ python setup.py install\n\n* To make a build of the project:\n\n.. code-block:: bash\n\n (env) $ python setup.py build\n\n************************************************************************\n`Licence <https://github.com/pythonpune/readit/blob/master/LICENSEE>`_\n************************************************************************\nReadit - Command line tool is licensed under `GNU General Public License v3.0. <https://github.com/pythonpune/readit/blob/master/LICENSE>`_\n\n.. |Python| image:: https://img.shields.io/badge/python-3.6-blue.svg\n\n.. |Licence| image:: https://img.shields.io/badge/license-GPLv3-yellow.svg?maxAge=2592000\n :target: https://github.com/pythonpune/readit/blob/master/LICENSE\n\n.. |Build Status| image:: https://travis-ci.org/pythonpune/readit.svg?branch=master\n :target: https://travis-ci.org/pythonpune/readit\n\n.. |docs passing| image:: https://readthedocs.org/projects/readit/badge/?version=latest\n :target: http://readittool.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n",
"bugtrack_url": null,
"license": "GNU General Public License v3.0",
"summary": "Readit - Command Line Bookmark Manager Tool",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/projectreadit/readit"
},
"split_keywords": [
"clitool",
" bookmark",
" readit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "580f94079d76d415dda345b9db193a1f9be0993c76d625a992e89235e5b9e15f",
"md5": "f43e3b1a17c40c12f48546fe985b9a86",
"sha256": "73e85da06f6c39ce1db9958edbb6bc5a2b18158f68e8b6f877ba55469fcb9b3e"
},
"downloads": -1,
"filename": "readit-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f43e3b1a17c40c12f48546fe985b9a86",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 24230,
"upload_time": "2024-10-25T06:57:12",
"upload_time_iso_8601": "2024-10-25T06:57:12.290212Z",
"url": "https://files.pythonhosted.org/packages/58/0f/94079d76d415dda345b9db193a1f9be0993c76d625a992e89235e5b9e15f/readit-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1d81178312000a7324317866cf9e1d3ac576ebbb75f79ebc7ca9d408d1d42102",
"md5": "908e80b6acfc368dc60a53fd48baf96f",
"sha256": "59fc799474a04657135389163b868c01ffb0f8dea72c22541cf9144e20582d6b"
},
"downloads": -1,
"filename": "readit-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "908e80b6acfc368dc60a53fd48baf96f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 66096,
"upload_time": "2024-10-25T06:57:13",
"upload_time_iso_8601": "2024-10-25T06:57:13.329922Z",
"url": "https://files.pythonhosted.org/packages/1d/81/178312000a7324317866cf9e1d3ac576ebbb75f79ebc7ca9d408d1d42102/readit-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 06:57:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "projectreadit",
"github_project": "readit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "readit"
}