Giter Club home page Giter Club logo

newspipe's Introduction

Newspipe

builds.sr.ht status

Presentation

Newspipe is a web news aggregator.

Newspipe Home page

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

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

The documentation is here: https://man.sr.ht/~cedric/newspipe

The official instance is here: https://www.newspipe.org

Main features

  • 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;
  • share articles on Pinboard, Reddit and Twitter;
  • management of bookmarks (with import from Pinboard).

Deployment

Newspipe is really easy to deploy.

Manual 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
$ export Newspipe_CONFIG=sqlite.py
$ poetry shell
$ pybabel compile -d newspipe/translations
$ python manager.py db_create
$ python manager.py create_admin <nickname> <password>
$ python runserver.py
  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

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.

Deployment with Docker

$ git clone https://git.sr.ht/~cedric/newspipe
$ cd newspipe/
$ docker-compose up

The login will be admin and the password password.

License

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

Contact

Cédric Bonhomme

newspipe's People

Contributors

cedricbonhomme avatar edwardbetts avatar jaesivsm avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.