Newspipe is a web news reader. You can register to Newspipe here and support me. 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

#Configuration and deployment

Assuming you have already installed git, npm, poetry, and Python >= 3.8, you just have to do the following:

$ git clone https://git.sr.ht/~cedric/newspipe
$ cd newspipe/
$ npm install
$ poetry install
$ poetry shell
$ pybabel compile -d newspipe/translations
$ export NEWSPIPE_CONFIG=sqlite.py
$ export FLASK_APP=runserver.py
$ export FLASK_ENV=development
$ flask db_create
$ flask create_admin --nickname <nickname> --password <password>
$ flask run
 * Serving Flask app "runserver" (lazy loading)
 * Environment: development
 * Debug mode: on
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 221-873-938

If you want to use PostgreSQL you can customize the provided example configuration file (instance/config.py):

$ sudo apt-get install postgresql
$ cp instance/config.py instance/postgresql.py
$ vim instance/postgresql.py # customize it
$ export NEWSPIPE_CONFIG=postgresql.py

For production you can use Gunicorn or mod_wsgi.

#Updates and migrations

Migrations of the database are managed with the database migrations tool Alembic.

$ cd newspipe/
$ git pull origin master
$ poetry run flask db upgrade
$ poetry run pybabel compile -d newspipe/translations
#Retrieving feeds automatically

Example of a cron rule:

0 */3 * * * poetry run flask fetch_asyncio
#Web services

See the dedicated section about the API v2.

About this wiki

commit f583aa79702061173357072f370cdf025bc95421
Author: C├ędric Bonhomme <cedric@cedricbonhomme.org>
Date:   2020-10-27T14:32:59+01:00

new: added an example on how to look for an article via the API.
Clone this wiki
https://git.sr.ht/~cedric/newspipe-docs (read-only)
git@git.sr.ht:~cedric/newspipe-docs (read/write)