============= 🗞 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.6 is required. Documentation ------------- A documentation is available `here `_ and provides different ways to `install Newspipe `_. Test Newspipe on Heroku: .. image:: https://www.herokucdn.com/deploy/button.png :target: https://heroku.com/deploy?template=https://github.com/newspipe/newspipe.git 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: .. code-block:: bash 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. .. code-block:: bash git clone https://github.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 `_