Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lioman/nextcloud_news_filter
Mirror of https://gitlab.com/lioman/nextcloud_news_filter/
https://github.com/lioman/nextcloud_news_filter
Last synced: 8 days ago
JSON representation
Mirror of https://gitlab.com/lioman/nextcloud_news_filter/
- Host: GitHub
- URL: https://github.com/lioman/nextcloud_news_filter
- Owner: lioman
- License: agpl-3.0
- Created: 2024-03-20T10:34:54.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-30T15:25:31.000Z (4 months ago)
- Last Synced: 2024-07-31T09:54:15.181Z (4 months ago)
- Language: Python
- Size: 124 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Nextcloud News Filter
This library is designed to filter Feeds from [Nextcloud News](https://nextcloud.github.io/news/), by marking them as read.
It is originally based on [nextcloud-news-filter](https://github.com/mathisdt/nextcloud-news-filter) by mathisdt.
[](https://pypi.python.org/pypi/nextcloud_news_filter)
[](https://gitlab.com/lioman/nextcloud_news_filter/-/commits/main)
[](https://gitlab.com/lioman/nextcloud_news_filter/-/commits/main)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/astral-sh/ruff)
## State of this package
This package is in an early stage of development. Things like configuration may change heavily in this early stage.
## Usage
This can be used directly on the system via a cli or as serverless function
### Installation
#### CLI
If you want to use the CLI install it with `pipx install nextcloud_news_filter[cli]`
#### Scaleway Serverless function
A full documentation will follow. These are just the steps you need to follow.
- create a namespace
- add a function via UI
- Get the last Release file: nextcloud_news_filter-$TAG.zip
- upload this via UI or with `scw` cli
- add your credentials as variables/secrets
- create a cron trigger with your filter configuration
### Configuration
All settings concerning the nextcloud server is done via environment variables:
- NEXTCLOUD_URL - the url of your instance e.g 'https://nextcloud.example.com'
- NEXTCLOUD_USER - your username
- NEXTCLOUD_PASS - the password of your user
It is using Basic authentication, if you have enabled 2-factor-authentication it will probably not work
#### Filter
The json to configure your filters consists of two keys
`skipFeeds` to ignore Feeds from all filters.
and `filter` to actually filter feeds. These are the options:
- name: Name of the filter. **Mandatory**
- feedId: Id of the feed the filter should be limited to (if not there, the filter rule is applied to all feeds). **Optional**
- bodyRegex: Regex that is applied to search in body of the feed item. **Optional**
- titleRegex: Regex that is applied to search in the title of the feed entry. **Optional**
- hoursAge: Maximum lifetime of the feed entry.
**Example:**
```json
{
"skipFeeds": [
1678, 1683, 1681, 1682, 1684, 1680, 1659, 1654, 1658, 1657, 1656, 1660, 1655
],
"filter": [
{
"name": "heise+",
"feedId": 1592,
"titleRegex": "heise\\+|heise\\-Angebot|TechStage"
},
{
"name": "All with Advertisement in Body",
"feedId": 1594,
"bodyRegex": "^Advertisement: "
},
{
"name": "Feed older then one day, for feed 1595",
"feedId": 1595,
"hoursAge": 24
},
{
"name": "all > 20 Days all feeds (except for skipped ones)",
"hoursAge": 480
}
]
}
```