https://github.com/cedricbonhomme/newspipe

A web news aggregator.
https://github.com/cedricbonhomme/newspipe

news-aggregator news-reader rss

Last synced: 3 months ago
JSON representation

A web news aggregator.

• Host: GitHub
• URL: https://github.com/cedricbonhomme/newspipe
• Owner: cedricbonhomme
• License: agpl-3.0
• Created: 2013-12-02T20:24:52.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-09-07T22:05:48.000Z (5 months ago)
• Last Synced: 2024-09-07T23:21:03.226Z (5 months ago)
• Topics: news-aggregator, news-reader, rss
• Language: Python
• Homepage: https://www.newspipe.org
• Size: 10.8 MB
• Stars: 419
• Watchers: 15
• Forks: 39
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: COPYING
  • Security: SECURITY.md
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

        
# Newspipe

## Presentation

[Newspipe](https://github.com/cedricbonhomme/newspipe) is a web news aggregator.

![Newspipe Home page](docs/static/newspipe_home-page.png "Newspipe Home page")

Newspipe is written in Python. The core technologies are

[Flask](http://flask.pocoo.org),

[asyncio](https://www.python.org/dev/peps/pep-3156/) and

[SQLAlchemy](http://www.sqlalchemy.org).

## Main features

* multiple users can use a Newspipe instance.

* an API to manage feeds (you can connect your own crawler).

* data liberation: export and import your account with a JSON file.

* export and import feeds with OPML files.

* search and favorite articles.

* detection of inactive feeds.

* management of bookmarks (with import from Pinboard).

* optional ldap authentication.

* user interface available with a light theme and a dark theme.

## Deployment

Newspipe is really easy to deploy.

Assuming you have already installed ``git``, ``poetry``, ``npm``,  and

``Python >= 3.10``, you just have to do the following:

```bash

$ git clone https://github.com/cedricbonhomme/newspipe

$ cd newspipe/

$ npm ci

$ poetry install --no-dev

$ poetry shell

$ pybabel compile -d newspipe/translations

$ export NEWSPIPE_CONFIG=sqlite.py

$ flask db_init

$ flask create_admin --nickname  --password 

$ flask run --debug

 * Debug mode: on

```

If you want to use PostgreSQL you can customize

the provided example configuration file (``instance/config.py``):

```bash

$ sudo apt-get install postgresql

$ cp instance/config.py instance/postgresql.py

$ vim instance/postgresql.py # customize it

$ export NEWSPIPE_CONFIG=postgresql.py

$ flask db_create

$ flask db_init

...

```

For production you can use [Gunicorn](https://gunicorn.org) or ``mod_wsgi``.

## License

[Newspipe](https://github.com/cedricbonhomme/newspipe) is under the

[GNU Affero General Public License version 3](https://www.gnu.org/licenses/agpl-3.0.html).

## Donations

If you wish and if you like Newspipe, you can donate:

[![GitHub Sponsors](https://img.shields.io/github/sponsors/cedricbonhomme)](https://github.com/sponsors/cedricbonhomme)

or with Bitcoin to this address:  

bc1q56u6sj7cvlwu58v5lemljcvkh7v2gc3tv8mj0e

Thank you !

## Contact

[Cédric Bonhomme](https://www.cedricbonhomme.org)