Name | tenkan JSON |
Version |
0.2.4
JSON |
| download |
home_page | |
Summary | RSS/atom feed converter from html to gemini |
upload_time | 2022-12-21 20:37:08 |
maintainer | |
docs_url | None |
author | Quentin Ferrand |
requires_python | ==3.*,>=3.8.0 |
license | WTFPL |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
[![Build Status](https://drone.fqserv.eu/api/badges/takaoni/tenkan/status.svg)](https://drone.fqserv.eu/takaoni/tenkan)
# tenkan
Command line tool to convert HTTP RSS/Atom feeds to gemini format.
## Installation
```shell script
pip install tenkan
```
## Usage
Add a feed
```shell script
# Any valid RSS/Atom feed
tenkan add feedname url
```
Update content of feed list
```shell script
tenkan update
```
Delete feed
```shell script
tenkan delete feedname
```
List subscripted feeds
```shell script
tenkan list
```
## Options
A debug mode is avaible via --debug option.
If you want to use your configuration or feeds file in another place than default one, you can use --config and --feedsfile options.
## Configuration
tenkan searches for a configuration file at the following location:
`$XDG_CONFIG_HOME/tenkan/tenkan.conf`
### Example config
This can be found in tenkan.conf.example.
```ini
[tenkan]
gemini_path = /usr/local/gemini/
gemini_url = gemini://foo.bar/feeds/
# will purge feed folders having more than defined element count
# purge_feed_folder_after = 100
[filters]
# authors we don't want to read
# authors_blacklist = foo, bar
# blacklist of article titles, if provided, it won't be processed
# titles_blacklist = foo, bar
# blacklist of article links, if provided, it won't be processed
# links_blacklist = foo/bar.com, bar/foo, bla
[formatting]
# maximum article title size, 120 chars if not provided
# title_size = 120
# feeds with a truncated content
# will be fetched and converted using readability
# truncated_feeds = foo, bar
```
## Todolist
- [ ] Add a edit command
- [ ] Add a --feedname option to update command, to update a single feed
- [ ] Rewrite configuration checks
- [ ] add configuration option to log output into a logfile
- [ ] Improve tests
- [ ] Refactor needed parts like write_article
- [ ] (not sure if relevant) migrate images too, for gemini clients that can handle it
## Development
I recommend using pre-commit. The pre-commit configuration I use is located in .pre-commit-config.yamlfile.
Run pre-commit command before every pull request and fix the warnings or errors it produces.
Raw data
{
"_id": null,
"home_page": "",
"name": "tenkan",
"maintainer": "",
"docs_url": null,
"requires_python": "==3.*,>=3.8.0",
"maintainer_email": "",
"keywords": "",
"author": "Quentin Ferrand",
"author_email": "quentin.ferrand@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/3b/f5/55a3ee50423d567ffb0a6a1365d33405525d5c7407df85f59337309b5a49/tenkan-0.2.4.tar.gz",
"platform": null,
"description": "[![Build Status](https://drone.fqserv.eu/api/badges/takaoni/tenkan/status.svg)](https://drone.fqserv.eu/takaoni/tenkan)\n\n# tenkan\n\nCommand line tool to convert HTTP RSS/Atom feeds to gemini format.\n\n## Installation\n```shell script\npip install tenkan\n```\n\n## Usage\n\nAdd a feed\n```shell script\n# Any valid RSS/Atom feed\ntenkan add feedname url\n```\n\nUpdate content of feed list\n```shell script\ntenkan update\n```\n\nDelete feed\n```shell script\ntenkan delete feedname\n```\n\nList subscripted feeds\n```shell script\ntenkan list\n```\n## Options\nA debug mode is avaible via --debug option.\nIf you want to use your configuration or feeds file in another place than default one, you can use --config and --feedsfile options.\n\n\n## Configuration\ntenkan searches for a configuration file at the following location:\n\n`$XDG_CONFIG_HOME/tenkan/tenkan.conf`\n\n### Example config\nThis can be found in tenkan.conf.example.\n\n```ini\n[tenkan]\ngemini_path = /usr/local/gemini/\ngemini_url = gemini://foo.bar/feeds/\n# will purge feed folders having more than defined element count\n# purge_feed_folder_after = 100\n\n[filters]\n# authors we don't want to read\n# authors_blacklist = foo, bar\n# blacklist of article titles, if provided, it won't be processed\n# titles_blacklist = foo, bar\n# blacklist of article links, if provided, it won't be processed\n# links_blacklist = foo/bar.com, bar/foo, bla\n\n[formatting]\n# maximum article title size, 120 chars if not provided\n# title_size = 120\n\n# feeds with a truncated content\n# will be fetched and converted using readability\n# truncated_feeds = foo, bar\n```\n\n## Todolist\n- [ ] Add a edit command\n- [ ] Add a --feedname option to update command, to update a single feed\n- [ ] Rewrite configuration checks\n- [ ] add configuration option to log output into a logfile\n- [ ] Improve tests\n- [ ] Refactor needed parts like write_article\n- [ ] (not sure if relevant) migrate images too, for gemini clients that can handle it\n\n## Development\nI recommend using pre-commit. The pre-commit configuration I use is located in .pre-commit-config.yamlfile.\n\nRun pre-commit command before every pull request and fix the warnings or errors it produces.\n",
"bugtrack_url": null,
"license": "WTFPL",
"summary": "RSS/atom feed converter from html to gemini",
"version": "0.2.4",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "6325b2083c61c5c4c0226f4c8efc5d0d",
"sha256": "2df26e1ff1859a0d01bed8997917366f1468c73040b7da5c1341fd7040d30bcd"
},
"downloads": -1,
"filename": "tenkan-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "6325b2083c61c5c4c0226f4c8efc5d0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "==3.*,>=3.8.0",
"size": 12978,
"upload_time": "2022-12-21T20:37:08",
"upload_time_iso_8601": "2022-12-21T20:37:08.380040Z",
"url": "https://files.pythonhosted.org/packages/3b/f5/55a3ee50423d567ffb0a6a1365d33405525d5c7407df85f59337309b5a49/tenkan-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-21 20:37:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "tenkan"
}