davep / tinboard Goto Github PK

View Code? Open in Web Editor NEW

63.0 5.0 2.0 1.78 MB

A terminal-based client for pinboard.in

Home Page: https://pypi.org/project/tinboard/

License: GNU General Public License v3.0

Makefile 2.08% Python 97.92%

pinboard pinboard-account pinboard-bookmarks python python3 terminal terminal-based textual

tinboard's Introduction

Tinboard

Introduction

Tinboard is a terminal-based client application for the Pinboard bookmarking service. It provides the ability to manage and search your bookmarks in the terminal.

Installing

pipx

The package can be installed using pipx:

$ pipx install tinboard

Once installed run the tinboard command.

Homebrew

The package is available via Homebrew. Use the following commands to install:

$ brew tap davep/homebrew
$ brew install tinboard

Once installed run the tinboard command.

Getting started

To use Tinboard you will need a Pinboard account (this application isn't going to be useful to anyone who isn't a Pinboard user). Assuming you do have a Pinboard account, you can get going by running up tinboard and providing your API token when asked:

If you're not sure where to find your API token, just press F1, or the Go to token button, and you'll be taken to the relevant Pinboard page in your browser; copy the token, come back to this dialog and paste it in.

Once done Tinboard will download your bookmarks and you're good to go!

NOTE: if it's your preference, you can set the token in an environment variable called TINBOARD_API_TOKEN.

Using Tinboard

The best way to get to know Tinboard is to read the help screen, once in the main application you can see this by pressing F1.

Quick add on the command line

Tinboard has a (currently experimental) quick inline add feature. If you run:

$ tinboard add

an inline version of the bookmark editor will be shown in your terminal, allowing you to quickly add a bookmark and then carry on without running up the full application.

Getting help

If you need help, or have any ideas, please feel free to raise an issue or start a discussion.

TODO

Things I'm considering adding or addressing:

Double-check the rate limits on the API calls to be sure they're correct.
A bookmark export facility.
A bookmark availability checker.
- Check the current bookmark.
- A mode that slowly checks all bookmarks.
Support for Pinboard Notes.
Optionally sort the tags by count.

tinboard's People

Contributors

Stargazers

Watchers

Forkers

tsvenson scarvy

tinboard's Issues

Add Wayback Machine support

Add a feature for quickly looking up a URL on the Wayback Machine.

Move the bookmark data out of the `Bookmarks` widget

Currently the Bookmarks widget is where all the bookmark data lives in Tinboard. This was quick and easy to get going and, initially, just made a lot of sense. Since then I've started to add the quick-add option (which shows the bookmark editor in add mode, as an inline Textual application) and it would be useful to be able to:

Update the local copy of the bookmarks when saving.
Get all the tags used in the bookmarks when populating the bookmarks suggester.

amongst other things. Also, now that there are a couple of good reasons for this, it makes sense to go with a more correct design and have the data decoupled from the view.

So... move all the bookmark data stuff into its own code such that it can be used outwith of any Textual-oriented code.

Add a feature to replace a bookmark with a Wayback archive URL

Now that #44 is in place it would make sense to add a feature where a bookmark can be replaced with its related Wayback Machine archive URL (if it has one); this would make for a handy quick-swap feature when the URL for a bookmark has gone 404 or worse.

Update for Textual v0.48.x or greater

Textual v0.48 is out and has changed to OptionList and TextArea that affect tinboard. Changes to make include:

Update the minimum version of Textual in setup.cfg
Remove the Textualize/textual#3714 workaround in OptionListEx.
Remove tinboard.widgets.TextArea altogether, as TextArea out of the box is totally what I want now.

Also:

Double-check the widgets of Inputs vs other widgets in the bookmark editor dialog; this should be fixed now.
Double-check how the TextArea looks and feels (pay attention to size, colour, cursor, etc).

Note that as of right now I can't really move on this because of Textualize/textual#4101 which breaks the application any time bookmarks are updated.

Look at a feature to request a bookmark be archived in the Wayback Machine

Now that #44 is in place, look to see if there's a mechanism that lets you say "please archive this" and add it as an option to Tinboard.

Tag suggestions can be confused by a space on the end

Tweak the tag suggestion code so that it doesn't do this:

The final suggestion was httpx, I typed http then space and the x remained.

Additional Configuration Paramaters for New Bookmaks

Feature request to be able to add configuration options and defaults for new bookmarks :

Public or Private by default
Read or Unread by default

Error when launching Tinboard

Hey,

Thanks for creating Tinboard!

After upgrading from 0.60 to 0.70, I have this error:
ReactiveError: Node is missing data; Check you are calling super().__init__(...) in the Filters() constructor, before getting reactives.
Thanks!