- Notifications
You must be signed in to change notification settings - Fork42
cedricbonhomme/newspipe
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Newspipe is a web news aggregator.
Newspipe is written in Python. The core technologies areFlask,asyncio andSQLAlchemy.
- 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 (see the example configuration file)
- user interface available with a light theme and a dark theme
Newspipe is really easy to deploy.Assuming you have already installedgit
,poetry
,npm
, andPython >= 3.10
, you just have to do the following:
$ git clone https://github.com/cedricbonhomme/newspipe$cd newspipe/$ npm ci$ poetry install$ poetry shell$ pybabel compile -d newspipe/translations$export NEWSPIPE_CONFIG=sqlite.py$ flask db_init$ flask create_admin --nickname<nickname> --password<password>$ flask run --debug* Debug mode: on
If you want to use PostgreSQL you can customizethe 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$ flask db_create$ flask db_init...
For production you can useGunicorn ormod_wsgi
.
$cd newspipe/$ git pull origin master$ poetry install$ poetry run flask db upgrade$ poetry run pybabel compile -d newspipe/translations
A dedicated Flask command is available to run the RSS/Atom feed importer.You can schedule it using a cron job, for example:
0*/3*** poetry run flask fetch_asyncio
When using cron it is usally best to be more precise with the command location, for example:
0*/3*** FLASK_APP=app.py /home/cedric/.cache/pypoetry/virtualenvs/newspipe-19mdZ4UL-py3.12/bin/flask fetch_asyncio
Newspipe is under theGNU Affero General Public License version 3.
If you wish and if you like Newspipe, you can donate:
or with Bitcoin to this address:bc1q56u6sj7cvlwu58v5lemljcvkh7v2gc3tv8mj0e
Thank you !
About
A self-hosted news reader.
Topics
Resources
License
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.
Contributors8
Uh oh!
There was an error while loading.Please reload this page.