Data

Tools

Indexes

Applications

Experiments

Open Source Science

reader

A Python feed reader library.

https://github.com/lemon24/reader

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.9%) to scientific vocabulary

Keywords

atom-feed feed feed-aggregator feed-reader json-feed library podcast podcast-aggregator podcast-client podcast-fetcher podcatcher python python-library rss rss-aggregator rss-feed rss-reader twitter
Last synced: 6 months ago · JSON representation

Repository

A Python feed reader library.

Basic Info
  • Host: GitHub
  • Owner: lemon24
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: master
  • Homepage: https://reader.readthedocs.io
  • Size: 5.25 MB
Statistics
  • Stars: 501
  • Watchers: 15
  • Forks: 38
  • Open Issues: 36
  • Releases: 83
Topics
atom-feed feed feed-aggregator feed-reader json-feed library podcast podcast-aggregator podcast-client podcast-fetcher podcatcher python python-library rss rss-aggregator rss-feed rss-reader twitter
Created about 8 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License

README.rst 

.. begin-intro

**reader** is a Python feed reader library.

It is designed to allow writing feed reader applications
without any business code,
and without depending on a particular framework.

.. end-intro


|build-status-github| |code-coverage| |documentation-status| |pypi-status| |type-checking| |code-style|


.. |build-status-github| image:: https://github.com/lemon24/reader/workflows/build/badge.svg
  :target: https://github.com/lemon24/reader/actions?query=workflow%3Abuild
  :alt: build status (GitHub Actions)

.. |code-coverage| image:: https://codecov.io/gh/lemon24/reader/branch/master/graph/badge.svg?token=lcLZaSFysf
  :target: https://codecov.io/gh/lemon24/reader
  :alt: code coverage

.. |documentation-status| image:: https://readthedocs.org/projects/reader/badge/?version=latest&style=flat
  :target: https://reader.readthedocs.io/en/latest/?badge=latest
  :alt: documentation status

.. |pypi-status| image:: https://img.shields.io/pypi/v/reader.svg
  :target: https://pypi.python.org/pypi/reader
  :alt: PyPI status

.. |type-checking| image:: http://www.mypy-lang.org/static/mypy_badge.svg
  :target: http://mypy-lang.org/
  :alt: checked with mypy

.. |code-style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
  :target: https://github.com/psf/black
  :alt: code style: black


.. begin-features

*reader* allows you to:

* retrieve, store, and manage **Atom**, **RSS**, and **JSON** feeds
* mark articles as read or important
* add arbitrary tags/metadata to feeds and articles
* filter feeds and articles
* full-text search articles
* get statistics on feed and user activity
* write plugins to extend its functionality
* skip all the low level stuff and focus on what makes your feed reader different

...all these with:

* a stable, clearly documented API
* excellent test coverage
* fully typed Python

What *reader* doesn't do:

* provide an UI
* provide a REST API (yet)
* depend on a web framework
* have an opinion of how/where you use it

The following exist, but are optional (and frankly, a bit unpolished):

* a minimal web interface

  * that works even with text-only browsers
  * with automatic tag fixing for podcasts (MP3 enclosures)

* a command-line interface

.. end-features


Documentation: `reader.readthedocs.io`_

.. _reader.readthedocs.io: https://reader.readthedocs.io/


Usage:

.. begin-usage

.. code-block:: bash

    $ pip install reader

.. code-block:: python

    >>> from reader import make_reader
    >>>
    >>> reader = make_reader('db.sqlite')
    >>> reader.add_feed('http://www.hellointernet.fm/podcast?format=rss')
    >>> reader.update_feeds()
    >>>
    >>> entries = list(reader.get_entries())
    >>> [e.title for e in entries]
    ['H.I. #108: Project Cyclops', 'H.I. #107: One Year of Weird', ...]
    >>>
    >>> reader.mark_entry_as_read(entries[0])
    >>>
    >>> [e.title for e in reader.get_entries(read=False)]
    ['H.I. #107: One Year of Weird', 'H.I. #106: Water on Mars', ...]
    >>> [e.title for e in reader.get_entries(read=True)]
    ['H.I. #108: Project Cyclops']
    >>>
    >>> reader.update_search()
    >>>
    >>> for e in reader.search_entries('year', limit=3):
    ...     title = e.metadata.get('.title')
    ...     print(title.value, title.highlights)
    ...
    H.I. #107: One Year of Weird (slice(15, 19, None),)
    H.I. #52: 20,000 Years of Torment (slice(17, 22, None),)
    H.I. #83: The Best Kind of Prison ()

.. end-usage

Owner

  • Login: lemon24
  • Kind: user

I do Python stuff on the internet.

GitHub Events

Total
  • Create event: 8
  • Release event: 4
  • Issues event: 14
  • Watch event: 55
  • Delete event: 3
  • Issue comment event: 33
  • Push event: 81
  • Pull request event: 13
  • Fork event: 6
Last Year
  • Create event: 8
  • Release event: 4
  • Issues event: 14
  • Watch event: 55
  • Delete event: 3
  • Issue comment event: 33
  • Push event: 81
  • Pull request event: 13
  • Fork event: 6

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 2,107
  • Total Committers: 3
  • Avg Commits per committer: 702.333
  • Development Distribution Score (DDS): 0.002
Past Year
  • Commits: 151
  • Committers: 1
  • Avg Commits per committer: 151.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
lemon24 d****4@g****m 2,103
Mirek Długosz m****k@m****m 3
dependabot-preview[bot] 2****] 1
Committer Domains (Top 20 + Academic)
mirekdlugosz.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 158
  • Total pull requests: 33
  • Average time to close issues: 7 months
  • Average time to close pull requests: 1 day
  • Total issue authors: 13
  • Total pull request authors: 12
  • Average comments per issue: 2.39
  • Average comments per pull request: 1.42
  • Merged pull requests: 24
  • Bot issues: 0
  • Bot pull requests: 7
Past Year
  • Issues: 7
  • Pull requests: 19
  • Average time to close issues: 5 days
  • Average time to close pull requests: about 14 hours
  • Issue authors: 3
  • Pull request authors: 5
  • Average comments per issue: 2.14
  • Average comments per pull request: 1.47
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 6
View more stats
Top Authors
Issue Authors
  • lemon24 (140)
  • maksverver (4)
  • TheLovinator1 (3)
  • mirekdlugosz (2)
  • SorenDalsgaard (1)
  • nobrowser (1)
  • dbrennand (1)
  • kei49 (1)
  • adsharma (1)
  • balki (1)
  • sorasful (1)
  • clemera (1)
  • Scylla2020 (1)
Pull Request Authors
  • maksverver (8)
  • lemon24 (8)
  • pre-commit-ci[bot] (7)
  • SHRISHTISHUKLA-0 (2)
  • CMH12345 (1)
  • chenthur (1)
  • rajan5511 (1)
  • chenedwin54288 (1)
  • Sakunam (1)
  • mirekdlugosz (1)
  • rouilj (1)
  • RachealIfe (1)
Top Labels
Issue Labels
core (67) API (44) plugin (17) performance (17) bug (15) web app (12) enhancement (12) help wanted (10) feed parsing (9) tags (8) documentation (6) wontfix (5) enclosure tags (3) question (1) good first issue (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 3,861 last-month
  • Total docker downloads: 34,186
  • Total dependent packages: 2
  • Total dependent repositories: 34
  • Total versions: 83
  • Total maintainers: 1
pypi.org: reader

A Python feed reader library.

  • Versions: 83
  • Dependent Packages: 2
  • Dependent Repositories: 34
  • Downloads: 3,861 Last month
  • Docker Downloads: 34,186
Rankings
Docker downloads count: 1.2%
Dependent repos count: 2.5%
Dependent packages count: 3.2%
Stargazers count: 3.3%
Average: 3.9%
Downloads: 4.5%
Forks count: 8.5%
Maintainers (1)
lemon24
Last synced: 6 months ago

Dependencies

.github/workflows/build.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v1.5.0 composite
pyproject.toml pypi
  • beautifulsoup4 >=4.5
  • feedparser >=6
  • iso8601 >=1
  • requests >=2.18
  • typing-extensions >=4
  • werkzeug >2