pjht/buku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix a few typos

Browse Source
This commit is contained in:
Sébastien Lavoie 2019-01-10 21:13:20 -06:00
parent af23fef30d
commit 5e487c3e69
7 changed files with 62 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CHANGELOG
View File

@ -16,7 +16,7 @@ Buku v3.9
What's in?
- Set number of search results per page (default 10)
- Retrieve description and tags from page, if available
- Visit cached version on Wayback machine
- Visit cached version on Wayback Machine
- Export works with all search options now
- Changed user agent to Firefox on Ubuntu
- Several dependencies made _required_ for installation
@ -29,18 +29,18 @@ Buku v3.8
What's in?
- A self-hosted http server, bukuserver, that exposes core functionality
- browsable frontend on a local webhost server
- browsable front-end on a local web host server
- flask default cli interface is used instead custom one
- handle not only api but also html request
- handle not only API but also HTML request
- statistic page
- CRUD on bookmark
- replaces the earlier api module
- replaces the earlier API module
- Import complete folder hierarchy as tags during auto-import
- Merge tags on import even if bookmark URL exists
- Orgfile import/export
- Show bookmarks to be deleted before deletion
- Merge tags during import if bookmark exists
- Escape regex metachars in regex input
- Escape regex metacharacters in regex input
-------------------------------------------------------------------------------
@ -147,7 +147,7 @@ Buku v3.0
What's in?
- Edit bookmarks in EDITOR at prompt
- Import folder names as tags from browser html (thanks @mohammadKhalifa)
- Import folder names as tags from browser HTML (thanks @mohammadKhalifa)
- Append, overwrite, delete tags at prompt using >>, >, << (familiar, eh? ;))
- Negative indices with `--print` (like `tail`)
- Update in EDITOR along with `--immutable`
@ -213,7 +213,7 @@ Modifications
- Support environment variable *https_proxy*
- Support option `--immutable` to pin titles
- Keyword `immutable` to search (`-S`) pinned titles
- Show index in Json output
- Show index in JSON output
- New key *q* to quit prompt
- Support deflate compression
- Add option `--tacit` to reduce verbosity of some operations
@ -279,7 +279,7 @@ Modifications
- Use the logging framework for debug info instead of print
- Fixed an issue with gzip stream decoding
- Using only relative path to fetch resource on server
- Fixed auto-completion errors with zsh
- Fixed auto-completion errors with Zsh
- A lot of code cleanup and globals removed, additional test cases
-------------------------------------------------------------------------------
@ -304,7 +304,7 @@ Buku v2.1
2016-05-28
Modifications
- Import bookmarks from Firefox, Google Chrome or IE html bookmark exports
- Import bookmarks from Firefox, Google Chrome or IE HTML bookmark exports
- Support comments on bookmarks
- Prettier output using symbols (`>` title, `+` comments, `#` tags)
- New option (`--st`, `--stag`) to search by tag
@ -431,7 +431,7 @@ Modifications
<pre>$ mkdir ~/.cache/buku/
$ mv ~/.cache/markit/bookmarks.db ~/.cache/buku/bookmarks.db
$ rm -rf ~/.cache/markit/bookmarks.db</pre>
- Manual AES256 encryption and decryption support (password protection) implemented. This adds dependency on PyCrypto module. Installation instructions updated in README.
- Manual AES-256 encryption and decryption support (password protection) implemented. This adds dependency on PyCrypto module. Installation instructions updated in README.
- Some typos fixed (thanks @GuilhermeHideki)
-------------------------------------------------------------------------------

34
README.md
View File

@ -26,11 +26,11 @@
### Introduction
`buku` is a powerful bookmark manager written in Python3 and SQLite3. When I started writing it, I couldn't find a flexible cmdline solution with a private, portable, merge-able database along with seamless GUI integration. Hence, `Buku` (after my son's nickname, meaning *close to the heart* in my language).
`buku` is a powerful bookmark manager written in Python3 and SQLite3. When I started writing it, I couldn't find a flexible command-line solution with a private, portable, merge-able database along with seamless GUI integration. Hence, `Buku` (after my son's nickname, meaning *close to the heart* in my language).
[bukuserver](https://github.com/jarun/Buku/tree/master/bukuserver) exposes a browsable frontend on a local webhost server.
[bukuserver](https://github.com/jarun/Buku/tree/master/bukuserver) exposes a browsable front-end on a local web host server.
`buku` fetches the title, tags and description of a bookmarked url from the web and stores it. You can use your favourite editor to compose and update bookmarks. With multiple search options, including regex and a deep scan mode (particularly for URLs), it can find any bookmark instantly. Multiple search results can be opened in the browser at once. `buku` can look up the latest snapshot of a broken link on the Wayback Machine. There's an Easter egg to revisit random forgotten bookmarks too! *Buku* is too busy to track you - no hidden history, obsolete records, usage analytics or homing. For more details, please refer to the wiki page on [operational notes](https://github.com/jarun/Buku/wiki/Operational-notes).
`buku` fetches the title, tags and description of a bookmarked url from the web and stores it. You can use your favourite editor to compose and update bookmarks. With multiple search options, including regex and a deep scan mode (particularly for URLs), it can find any bookmark instantly. Multiple search results can be opened in the browser at once. `buku` can look up the latest snapshot of a broken link on the Wayback Machine. There's an Easter egg to revisit random forgotten bookmarks too! *Buku* is too busy to track you: no hidden history, obsolete records, usage analytics or homing. For more details, please refer to the wiki page on [operational notes](https://github.com/jarun/Buku/wiki/Operational-notes).
To get started right away, jump to the [Quickstart](#quickstart) section. We have one of the best documentation around. You'll find handy examples in the man page too.
@ -53,7 +53,7 @@ There are several [projects based on `buku`](#related-projects), including a bro
- [Running standalone](#running-standalone)
- [Shell completion](#shell-completion)
- [Usage](#usage)
- [Cmdline options](#cmdline-options)
- [Command-line options](#command-line-options)
- [Colors](#colors)
- [Quickstart](#quickstart)
- [Examples](#examples)
@ -152,7 +152,7 @@ Shell completion scripts for Bash, Fish and Zsh can be found in respective subdi
### Usage
#### Cmdline options
#### Command-line options
```
usage: buku [OPTIONS] [KEYWORD [KEYWORD ...]]
@ -218,25 +218,25 @@ ENCRYPTION OPTIONS:
POWER TOYS:
--ai auto-import from Firefox/Chrome/Chromium
-e, --export file export bookmarks to Firefox format html
export markdown, if file ends with '.md'
-e, --export file export bookmarks to Firefox format HTML
export Markdown, if file ends with '.md'
format: [title](url), 1 entry per line
export orgfile, if file ends with '.org'
export Orgfile, if file ends with '.org'
format: *[[url][title]], 1 entry per line
export buku DB, if file ends with '.db'
combines with search results, if opted
-i, --import file import bookmarks html in Firefox format
import markdown, if file ends with '.md'
import orgfile, if file ends with '.org'
-i, --import file import bookmarks HTML in Firefox format
import Markdown, if file ends with '.md'
import Orgfile, if file ends with '.org'
import buku DB, if file ends with '.db'
-p, --print [...] show record details by indices, ranges
print all bookmarks, if no arguments
-n shows the last n results (like tail)
-f, --format N limit fields in -p or Json search output
-f, --format N limit fields in -p or JSON search output
N=1: URL, N=2: URL and tag, N=3: title,
N=4: URL, title and tag. To omit DB index,
use N0, e.g., 10, 20, 30, 40.
-j, --json Json formatted output for -p and search
-j, --json JSON formatted output for -p and search
--colors COLORS set output colors in five-letter string
--nc disable color output
-n, --count N show N results per page (default 10)
@ -344,14 +344,14 @@ PROMPT KEYS:
$ buku -u 15012014 -c this is a new comment
Applies to --url, --title and --tag too.
9. **Export** bookmarks tagged `tag 1` or `tag 2` to HTML, markdown, orgfile or a new database:
9. **Export** bookmarks tagged `tag 1` or `tag 2` to HTML, Markdown, Orgfile or a new database:
$ buku -e bookmarks.html --stag tag 1, tag 2
$ buku -e bookmarks.md --stag tag 1, tag 2
$ buku -e bookmarks.org --stag tag 1, tag 2
$ buku -e bookmarks.db --stag tag 1, tag 2
All bookmarks are exported if search is not opted.
10. **Import** bookmarks from HTML, markdown or orgfile:
10. **Import** bookmarks from HTML, Markdown or Orgfile:
$ buku -i bookmarks.html
$ buku -i bookmarks.md
@ -486,8 +486,8 @@ Missing a feature? There's a rolling [ToDo List](https://github.com/jarun/Buku/i
### Related projects
- [bukubrow](https://github.com/SamHH/bukubrow), WebExtension for browser integration
- [oil](https://github.com/AndreiUlmeyda/oil), search-as-you-type cli frontend
- [buku_run](https://github.com/carnager/buku_run), rofi frontend
- [oil](https://github.com/AndreiUlmeyda/oil), search-as-you-type cli front-end
- [buku_run](https://github.com/carnager/buku_run), rofi front-end
- [pinku](https://github.com/mosegontar/pinku), a Pinboard-to-Buku import utility
- [buku-dmenu](https://gitlab.com/benoliver999/buku-dmenu), a simple bash dmenu wrapper

6
auto-completion/fish/buku.fish
View File

@ -7,17 +7,17 @@
complete -c buku -s a -l add -r --description 'add bookmark'
complete -c buku -l ai --description 'auto-import bookmarks'
complete -c buku -s c -l comment --description 'comment on bookmark'
complete -c buku -l cached -r --description 'visit wayback machine cached version'
complete -c buku -l cached -r --description 'visit Wayback Machine cached version'
complete -c buku -l colors -r --description 'set output colors in 5-letter string'
complete -c buku -s d -l delete --description 'delete bookmark'
complete -c buku -l deep --description 'search matching substrings'
complete -c buku -s e -l export -r --description 'export bookmarks'
complete -c buku -l expand -r --description 'expand a tny.im shortened URL'
complete -c buku -s f -l format -r --description 'limit fields in print and Json output'
complete -c buku -s f -l format -r --description 'limit fields in print and JSON output'
complete -c buku -s h -l help --description 'show help'
complete -c buku -s i -l import -r --description 'import bookmarks'
complete -c buku -l immutable -r --description 'disable title update from web'
complete -c buku -s j -l json --description 'show Json output for print and search'
complete -c buku -s j -l json --description 'show JSON output for print and search'
complete -c buku -s k -l unlock --description 'decrypt database'
complete -c buku -s l -l lock --description 'encrypt database'
complete -c buku -s n -l count -r --description 'results per page'

6
auto-completion/zsh/_buku
View File

@ -12,17 +12,17 @@ args=(
'(-a --add)'{-a,--add}'[add bookmark]:URL tags'
'(--ai)--ai[auto-import bookmarks]'
'(-c --comment)'{-c,--comment}'[comment on bookmark]'
'(--cached)--cached[visit wayback machine cached version]:index/url'
'(--cached)--cached[visit Wayback Machine cached version]:index/url'
'(--colors)--colors[set output colors in 5-letter string]:color string'
'(-d --delete)'{-d,--delete}'[delete bookmark]'
'(--deep)--deep[search matching substrings]'
'(-e --export)'{-e,--export}'[export bookmarks]:html/md/db output file'
'(--expand)--expand[expand a tny.im shortened URL]:index/shorturl'
'(-f --format)'{-f,--format}'[limit fields in print and Json output]:value'
'(-f --format)'{-f,--format}'[limit fields in print and JSON output]:value'
'(-h --help)'{-h,--help}'[show help]'
'(-i --import)'{-i,--import}'[import bookmarks]:html/md/db input file'
'(--immutable)--immutable[disable title update from web]:value'
'(-j --json)'{-j,--json}'[show Json output for print and search]'
'(-j --json)'{-j,--json}'[show JSON output for print and search]'
'(-k --unlock)'{-k,--unlock}'[decrypt database]'
'(-l --lock)'{-l,--lock}'[encrypt database]'
'(-n --count)'{-n,--count}'[results per page]:value'

42
buku
View File

@ -2038,7 +2038,7 @@ class BukuDb:
If destination file name ends with '.db', bookmarks are
exported to a Buku database file.
If destination file name ends with '.md', bookmarks are
exported to a markdown file.
exported to a Markdown file.
If destination file name ends with '.org' bookmarks are
exported to a org file.
Otherwise, bookmarks are exported to a Firefox bookmarks.html
@ -2377,10 +2377,10 @@ class BukuDb:
print('\nAuto-generated tag: %s' % newtag)
def importdb(self, filepath, tacit=False):
"""Import bookmarks from a html or a markdown file.
"""Import bookmarks from a HTML or a Markdown file.
Supports Firefox, Google Chrome, and IE exported html bookmarks.
Supports markdown files with extension '.md, .org'.
Supports Firefox, Google Chrome, and IE exported HTML bookmarks.
Supports Markdown files with extension '.md, .org'.
Supports importing bookmarks from another Buku database file.
Parameters
@ -2389,7 +2389,7 @@ class BukuDb:
Path to file to import.
tacit : bool, optional
If True, no questions asked and folder names are automatically
imported as tags from bookmarks html.
imported as tags from bookmarks HTML.
If True, automatic timestamp tag is NOT added.
Default is False.
@ -2612,7 +2612,7 @@ class BukuDb:
else:
url = arg
# Try fetching cached page from wayback machine
# Try fetching cached page from Wayback Machine
api_url = 'https://archive.org/wayback/available/?url=' + quote_plus(url)
manager = get_PoolManager()
resp = manager.request('GET', api_url)
@ -2852,14 +2852,14 @@ def walk(root):
def import_md(filepath, newtag):
"""Parse bookmark markdown file.
"""Parse bookmark Markdown file.
Parameters
----------
filepath : str
Path to markdown file.
Path to Markdown file.
newtag : str
New tag for bookmarks in markdown file.
New tag for bookmarks in Markdown file.
Returns
-------
@ -2868,7 +2868,7 @@ def import_md(filepath, newtag):
"""
with open(filepath, mode='r', encoding='utf-8') as infp:
for line in infp:
# Supported markdown format: [title](url)
# Supported Markdown format: [title](url)
# Find position of title end, url start delimiter combo
index = line.find('](')
if index != -1:
@ -2906,7 +2906,7 @@ def import_org(filepath, newtag):
Parsed result.
"""
with open(filepath, mode='r', encoding='utf-8') as infp:
# Supported markdown format: * [[url][title]]
# Supported Markdown format: * [[url][title]]
# Find position of url end, title start delimiter combo
for line in infp:
index = line.find('][')
@ -3063,12 +3063,12 @@ def import_firefox_json(json, add_bookmark_folder_as_tag=False, unique_tag=None)
def import_html(html_soup, add_parent_folder_as_tag, newtag):
"""Parse bookmark html.
"""Parse bookmark HTML.
Parameters
----------
html_soup : BeautifulSoup object
BeautifulSoup representation of bookmark html.
BeautifulSoup representation of bookmark HTML.
add_parent_folder_as_tag : bool
True if bookmark parent folders should be added as tags else False.
newtag : str
@ -3246,12 +3246,12 @@ def is_unusual_tag(tagstr):
def parse_decoded_page(page):
"""Fetch title, description and keywords from decoded html page.
"""Fetch title, description and keywords from decoded HTML page.
Parameters
----------
page : str
Decoded html page.
Decoded HTML page.
Returns
-------
@ -4777,16 +4777,16 @@ POSITIONAL ARGUMENTS:
power_grp = argparser.add_argument_group(
title='POWER TOYS',
description=''' --ai auto-import from Firefox/Chrome/Chromium
-e, --export file export bookmarks to Firefox format html
export markdown, if file ends with '.md'
-e, --export file export bookmarks to Firefox format HTML
export Markdown, if file ends with '.md'
format: [title](url), 1 entry per line
export orgfile, if file ends with '.org'
export Orgfile, if file ends with '.org'
format: *[[url][title]], 1 entry per line
export buku DB, if file ends with '.db'
combines with search results, if opted
-i, --import file import bookmarks html in Firefox format
import markdown, if file ends with '.md'
import orgfile, if file ends with '.org'
-i, --import file import bookmarks HTML in Firefox format
import Markdown, if file ends with '.md'
import Orgfile, if file ends with '.org'
import buku DB, if file ends with '.db'
-p, --print [...] show record details by indices, ranges
print all bookmarks, if no arguments

14
buku.1
View File

@ -44,7 +44,7 @@ Bookmarks with immutable titles are listed with '(L)' after the title.
\fBTags\fR:
- Comma (',') is the tag delimiter in DB. A tag cannot have comma(s) in it. Tags are filtered (for unique tags) and sorted. Tags are stored in lower case and can be replaced, appended or deleted.
- Page keywords having a word to comma ratio > 3 are appended to description rather than tags.
- Parent folder (and subfolder) names are converted to all-lowercase tags during bookmarks html import.
- Parent folder (and subfolder) names are converted to all-lowercase tags during bookmarks HTML import.
- Releases prior to v2.7 support both capital and lower cases in tags. From v2.7 all tags are stored in lowercase. An undocumented option --\fIfixtags\fR is introduced to modify the older tags. It also fixes another issue where the same tag appears multiple times in the tagset of a record. Run \fBbuku --fixtags\fR once.
- Tags can be edited from the prompt very easily using '>>' (append), '>' (overwrite) and '<<' (remove) symbols. The LHS of the operands denotes the indices and ranges of tags to apply (as listed by --tag or key 't' at prompt) and the RHS denotes the actual DB indices and ranges of the bookmarks to apply the change to.
.PP
@ -80,7 +80,7 @@ Bookmarks with immutable titles are listed with '(L)' after the title.
- URLs starting with `place:`, `file://` and `apt:` are ignored during import.
- Parent folder (and subfolder) names are automatically imported as tags if --tacit is used.
- Tags are merged even if bookmark URL exists when --tacit is used.
- An auto-generated tag in the format 'YYYYMonDD' is added if --tacit is not used in html, markdown or orgfile import.
- An auto-generated tag in the format 'YYYYMonDD' is added if --tacit is not used in HTML, Markdown or Orgfile import.
.PP
.IP 10. 4
\fBEncryption\fR is optional and manual. AES256 algorithm is used. To use encryption, the database file should be unlocked (-k) before using \fBbuku\fR and locked (-l) afterwards. Between these 2 operations, the database file lies unencrypted on the disk, and NOT in memory. Also, note that the database file is \fBunencrypted on creation\fR.
@ -203,9 +203,9 @@ Orgfile format: * [[url][title]], 1 entry per line. A buku database is generated
has extension '.db'.
.TP
.BI \-i " " \--import " file"
Import bookmarks from Firefox bookmarks formatted html.
Import bookmarks from Firefox bookmarks formatted HTML.
.I file
is considered Markdown (compliant with --export format) if it has '.md' extension, orgfile if the extension is '.org' or another buku database if the extension is '.db'.
is considered Markdown (compliant with --export format) if it has '.md' extension, Orgfile if the extension is '.org' or another buku database if the extension is '.db'.
.TP
.BI \-p " " \--print " [...]"
Show details (DB index, URL, title, tags and comment) of bookmark record by DB index. If no arguments, all records with actual index from DB are shown. Accepts hyphenated ranges and space-separated indices. A negative value (introduced for convenience) behaves like the tail utility, e.g., -n shows the details of the last n bookmarks.
@ -228,7 +228,7 @@ Show selective monochrome output with specific fields. Works with --print. Searc
To omit DB index from printed results, use N0, e.g., 10, 20, 30, 40.
.TP
.BI \-j " " \--json
Output data formatted as json, works with --print output and search results.
Output data formatted as JSON, works with --print output and search results.
.TP
.BI \--colors " COLORS"
Set output colors. Refer to the \fBCOLORS\fR section below for details.
@ -526,7 +526,7 @@ This will open the existing bookmark's details in the editor for modifications.
Applies to --url, --title and --tag too.
.PP
.IP 9. 4
\fBExport\fR bookmarks tagged 'tag 1' or 'tag 2' to HTML, markdown, orgfile or a new database:
\fBExport\fR bookmarks tagged 'tag 1' or 'tag 2' to HTML, Markdown, Orgfile or a new database:
.PP
.EX
.IP
@ -543,7 +543,7 @@ Applies to --url, --title and --tag too.
All bookmarks are exported if search is not opted.
.PP
.IP 10. 4
\fBImport\fR bookmarks from HTML, markdown or orgfile:
\fBImport\fR bookmarks from HTML, Markdown or Orgfile:
.PP
.EX
.IP

2
bukuserver/templates/bukuserver/statistic.html
View File

@ -36,7 +36,7 @@
</table>
</div>
{% else %}
<span> No boookmark found.</span>
<span> No bookmark found.</span>
{% endif %}
{% if show_netloc_table %}