Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ouattararomuald/syndication
A Kotlin library for reading RSS 2.0 and ATOM 1.0 syndication feeds.
https://github.com/ouattararomuald/syndication
atom-feed kotlin rss-feed syndication syndication-feed
Last synced: about 2 months ago
JSON representation
A Kotlin library for reading RSS 2.0 and ATOM 1.0 syndication feeds.
- Host: GitHub
- URL: https://github.com/ouattararomuald/syndication
- Owner: ouattararomuald
- License: apache-2.0
- Created: 2018-12-23T08:35:34.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-30T15:19:15.000Z (over 3 years ago)
- Last Synced: 2023-07-28T17:15:39.638Z (over 1 year ago)
- Topics: atom-feed, kotlin, rss-feed, syndication, syndication-feed
- Language: Java
- Homepage:
- Size: 203 KB
- Stars: 58
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/ouattararomuald/syndication)
[](https://github.com/square/java-code-styles)
[](https://search.maven.org/search?q=g:com.ouattararomuald%20a:syndication)
[](https://oss.sonatype.org/content/repositories/snapshots/)
# Syndication feed
A Kotlin library for reading RSS 2.0 and ATOM 1.0 syndication feeds.
## Usage
You're willing to consume **ATOM 1.0** or **RSS 2.0** feed? Start by creating and interface
```kotlin
interface RssReader {
fun readRss(): RssFeed
fun readAtom(): AtomFeed
}
```
then let `Syndication` class generates an implementation of that interface `RssReader`:
```kotlin
val reader = syndicationReader.create(RssReader::class.java)
val rssFeed = reader.readRss() // this is synchronous
val atomFeed = reader.readAtom() // this is synchronous
```
each call from the created `RssReader` will make an HTTP request and return the expected syndication feed.
By default only `RssFeed` and `AtomFeed` are accepted as return type.
If you would like to do things asynchronously then take a look to existing adapters in this repo.
- **kotlin-coroutines-adapter** for example let you return `Deferred` or `Deferred`.
- **rxjava2-adapter** let you return [RxJava 2.x](https://github.com/ReactiveX/RxJava) types (`Flowable`, `Maybe`, `Single`).
- **rxjava3-adapter** let you return [RxJava 3.x](https://github.com/ReactiveX/RxJava) types (`Flowable`, `Maybe`, `Single`).
## Custom syndication feed
By default only `RssFeed` and `AtomFeed` are accepted as return type but If you would like to
return your **own custom type** then see **wiki**.
## Syndication specifications
- [Atom 1.0](https://tools.ietf.org/html/rfc4287)
- [RSS 2.0](http://www.rssboard.org/rss-specification)
## Download
Download the [latest JAR](https://search.maven.org/search?q=g:com.ouattararomuald%20AND%20a:syndication) or grab via Gradle:
```gradle
implementation 'com.ouattararomuald:syndication:2.1.1'
```
or Maven:
```xml
com.ouattararomuald
syndication
2.1.1
```
Snapshots of the development version are available in [Sonatype's snapshots repository](https://oss.sonatype.org/content/repositories/snapshots/).
## Contributing
Contributions you say? Yes please!
**Bug report?**
If at all possible, please attach a minimal sample project or code which reproduces the bug.
Screenshots are also a huge help if the problem is visual.
**Send a pull request!**
If you're fixing a bug, please add a failing test or code that can reproduce the issue.
## License
```
Copyright 2018 Ouattara Gninlikpoho Romuald
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```