~cedric/newspipe

ref: c3e447beef4ac43eb3c9d7dd58932bba5cfac1b9 newspipe/README.md -rw-r--r-- 1.5 KiB
c3e447beCédric Bonhomme Updated README. 11 months ago

#Newspipe

#Presentation

Newspipe is a web-based news aggregator and reader.

For reporting issues, visit the tracker here: https://todo.sr.ht/~cedric/newspipe

For contributions, use the mailing list to send your patches: https://lists.sr.ht/~cedric/newspipe

Newspipe is written in Python. The core technologies are Flask, asyncio and SQLAlchemy.

#Main features

  • multiple users can use a Newspipe instance;
  • an API to manage your 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;
  • share on Pinboard and reddit;
  • management of bookmarks (with import from Pinboard).

#Deployment

Newspipe is really easy to deploy.

#Requirements

$ sudo apt-get install postgresql npm

#Configure and install the application

$ git clone https://git.sr.ht/~cedric/newspipe
$ cd newspipe/
$ poetry install
$ npm install
$ cp instance/production.py instance/development.py
$ poetry shell
$ python manager.py db_create
$ python runserver.py
  * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)

#License

Newspipe is under the GNU Affero General Public License version 3.

#Contact

Cédric Bonhomme