This repository has been archived by the owner. It is now read-only.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
migrations
src
.bowerrc
.buildpacks
.gitignore
AUTHORS.rst
CHANGELOG.rst
COPYING
Pipfile
Pipfile.lock
Procfile
README.rst
app.json
bower.json
install.sh
package.json
runtime.txt

README.rst

🗞 Newspipe 🗞

Presentation

Newspipe is a web-based news aggregator and reader.

Main features

  • can be easily deployed on Heroku or on a traditional server;
  • multiple users can use a Newspipe instance;
  • a RESTful API to manage your articles (or connect your own crawler);
  • data liberation: export and import all your account with a JSON file;
  • export and import feeds with OPML files;
  • favorite articles;
  • detection of inactive feeds;
  • share articles with Google +, Pinboard and reddit;
  • personal management of bookmarks (with import from Pinboard).

The core technologies are Flask, asyncio , SQLAlchemy and React.

Python >= 3.7.0 is required.

Documentation

A documentation is available here and provides different ways to install Newspipe.

Test Newspipe on Heroku:

https://www.herokucdn.com/deploy/button.png

It is important to specify an application name and the URL of your instance (PLATFORM_URL) through the Heroku form.

Contributions

Contributions are welcome. If you want to contribute to Newspipe I highly recommend you to install it in a Python virtual environment. For example:

sudo apt-get install postgresql npm

It seems that today a proof of good taste is to install first pyenv, then pipsi, and finally pew and pipenv with pipsi.

git clone https://gitlab.com/newspipe/newspipe.git
cd newspipe/
pipenv install
✨🍰✨
npm install
cp src/conf/conf.cfg-sample src/conf/conf.cfg
pipenv shell
python src/manager.py db_create
python src/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