# Tinboard
## Introduction
Tinboard is a terminal-based client application for the [Pinboard
bookmarking service](https://pinboard.in/about/). It provides the ability to
manage and search your bookmarks in the terminal.
## Installing
### pipx
The package can be installed using [`pipx`](https://pypa.github.io/pipx/):
```sh
$ pipx install tinboard
```
Once installed run the `tinboard` command.
### Homebrew
The package is available via Homebrew. Use the following commands to install:
```sh
$ 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 <kbd>F1</kbd>,
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 <kbd>F1</kbd>.
### Quick add on the command line
Tinboard has a (currently experimental) quick inline add feature. If you
run:
```sh
$ 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](https://github.com/davep/tinboard/issues) or [start a
discussion](https://github.com/davep/tinboard/discussions).
## 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.
- [X] Optionally sort the tags by count.
[//]: # (README.md ends here)
Raw data
{
"_id": null,
"home_page": "https://github.com/davep/tinboard",
"name": "tinboard",
"maintainer": "Dave Pearson",
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": "davep@davep.org",
"keywords": "bookmark, pinboard, terminal",
"author": "Dave Pearson",
"author_email": "davep@davep.org",
"download_url": "https://files.pythonhosted.org/packages/87/aa/dcb0c52baced639cac6a2cafc9438db5721390b5b5094ee7e5beee5ea6ec/tinboard-0.13.0.tar.gz",
"platform": null,
"description": "# Tinboard\n\n\n\n## Introduction\n\nTinboard is a terminal-based client application for the [Pinboard\nbookmarking service](https://pinboard.in/about/). It provides the ability to\nmanage and search your bookmarks in the terminal.\n\n## Installing\n\n### pipx\n\nThe package can be installed using [`pipx`](https://pypa.github.io/pipx/):\n\n```sh\n$ pipx install tinboard\n```\n\nOnce installed run the `tinboard` command.\n\n### Homebrew\n\nThe package is available via Homebrew. Use the following commands to install:\n\n```sh\n$ brew tap davep/homebrew\n$ brew install tinboard\n```\n\nOnce installed run the `tinboard` command.\n\n## Getting started\n\nTo use Tinboard you will need a Pinboard account (this application isn't\ngoing to be useful to anyone who isn't a Pinboard user). Assuming you *do*\nhave a Pinboard account, you can get going by running up `tinboard` and\nproviding your API token when asked:\n\n\n\nIf you're not sure where to find your API token, just press <kbd>F1</kbd>,\nor the `Go to token` button, and you'll be taken to the relevant Pinboard\npage in your browser; copy the token, come back to this dialog and paste it\nin.\n\nOnce done Tinboard will download your bookmarks and you're good to go!\n\n*NOTE: if it's your preference, you can set the token in an environment\nvariable called `TINBOARD_API_TOKEN`.*\n\n## Using Tinboard\n\nThe best way to get to know Tinboard is to read the help screen, once in the\nmain application you can see this by pressing <kbd>F1</kbd>.\n\n\n\n### Quick add on the command line\n\nTinboard has a (currently experimental) quick inline add feature. If you\nrun:\n\n```sh\n$ tinboard add\n```\n\nan inline version of the bookmark editor will be shown in your terminal,\nallowing you to quickly add a bookmark and then carry on without running up\nthe full application.\n\n## Getting help\n\nIf you need help, or have any ideas, please feel free to [raise an\nissue](https://github.com/davep/tinboard/issues) or [start a\ndiscussion](https://github.com/davep/tinboard/discussions).\n\n## TODO\n\nThings I'm considering adding or addressing:\n\n- [ ] Double-check the rate limits on the API calls to be sure they're correct.\n- [ ] A bookmark export facility.\n- [ ] A bookmark availability checker.\n - [ ] Check the current bookmark.\n - [ ] A mode that slowly checks all bookmarks.\n- [ ] Support for Pinboard Notes.\n- [X] Optionally sort the tags by count.\n\n[//]: # (README.md ends here)\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
"summary": "A Pinboard client for the terminal",
"version": "0.13.0",
"project_urls": {
"Discussions": "https://github.com/davep/tinboard/discussions",
"Documentation": "https://github.com/davep/tinboard/blob/main/README.md",
"Homepage": "https://github.com/davep/tinboard",
"Issues": "https://github.com/davep/tinboard/issues",
"Source": "https://github.com/davep/tinboard"
},
"split_keywords": [
"bookmark",
" pinboard",
" terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "37911cdd015534c085e6642ba83bb76fdbcedc8333c05f2644c11ba06e284721",
"md5": "dc820094934c70ebf4bd416cf9479426",
"sha256": "d3d4bef90a56e797d6bb00e9fc1651594d7bc79872da71912e2d6d4bb533dcfb"
},
"downloads": -1,
"filename": "tinboard-0.13.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc820094934c70ebf4bd416cf9479426",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 48397,
"upload_time": "2024-05-02T07:26:21",
"upload_time_iso_8601": "2024-05-02T07:26:21.716500Z",
"url": "https://files.pythonhosted.org/packages/37/91/1cdd015534c085e6642ba83bb76fdbcedc8333c05f2644c11ba06e284721/tinboard-0.13.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "87aadcb0c52baced639cac6a2cafc9438db5721390b5b5094ee7e5beee5ea6ec",
"md5": "9622c6a7238af453d57f63efe35a7fb8",
"sha256": "c4c052fd0d45140163446c8c88d8afe232c2d27f2e8e8315b31dd5ce4d213052"
},
"downloads": -1,
"filename": "tinboard-0.13.0.tar.gz",
"has_sig": false,
"md5_digest": "9622c6a7238af453d57f63efe35a7fb8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 35422,
"upload_time": "2024-05-02T07:26:23",
"upload_time_iso_8601": "2024-05-02T07:26:23.656299Z",
"url": "https://files.pythonhosted.org/packages/87/aa/dcb0c52baced639cac6a2cafc9438db5721390b5b5094ee7e5beee5ea6ec/tinboard-0.13.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-02 07:26:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davep",
"github_project": "tinboard",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tinboard"
}
JSON
