Skip to content
A News Reader as a webapp', bundled with a system for frequent checks of news, and a notifier system using mails, push notifications & pushbullet. Android and iOS apps available!
Python HTML JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
ngnotifier
static/assets
templates
.gitignore
LICENSE
README.md
TODO.md
__init__.py
manage.py
requirements.txt

README.md

NG-Notifier

A News Reader as a webapp' using apscheduler for frequent checks of news, and a notifier system using mails, pushbullet or push notifications for Android & iOS mobile apps.

The current version is running here.

The Android app is available here. The iOS app is available here.

How to?

Goto tl;dr or start below.

Initialization

We will use the virtualenv way, assuming you have python 3, pip 3 & virtualenv installed, python is an alias for python3 and pip is an alias for pip3.

  • First, create a virtual environment with virtualenv -p /usr/bin/python3 --no-site-packages ng-notifier.
  • Second, enter the VE using cd ng-notifier; source bin/activate.
  • Third, clone the repository with git clone https://github.com/Dubrzr/NG-Notifier.git web.

The directory structure should now look like this:

path/ng-notifier/
  bin/
  include/
  lib/
  web/
    README.md
    requirements.txt
    static/
    ...

You will now have to install requirements for this project. Proceed with the following command: cd web; pip install -r requirements.txt (it may take a while).

Configuration

Now you have to set up your own settings in ngnotifier/settings.py file, just rename the example.settings.py file provided.

Things you must/may modify:

  • SECRET_KEY (Generate a new one, google guys)
  • DEBUG (Set to True or False)
  • TEMPLATE_DEBUG (Set to True or False)
  • ALLOWED_HOSTS
  • DATABASES (You may use something else than sqlite3)
  • TIME_ZONE
  • STATIC_URL (website.comSTATIC_URL)
  • SEND_FROM_POSTER (Pay attention to this parameter, you must have your own mail server else your provider may refuse your emails)
  • FROM_ADDR (Will be used if SEND_FROM_POSTER is False)
  • mail_conf (Fill in all parameters)
  • SECONDS_DELTA (Seconds between 2 news checks)
  • hosts (Set up all hosts you want)
  • users (A variable to regiter default accounts - usefull for dev)

Installation

You are now able to install the application.

Just type python manage.py install and it will do everything for you :)

It may take a while if the server has a lot of news.

You now have a ready to run application.

Running the app

  • To run the server just type python manage.py runserver.
  • To execute tasks automatically, type python manage.py tasks

About

This project is maintained, and any pull request will be reviewed! Even for grammar mistakes, and PEP-8.

tldr

Execute this:

virtualenv -p /usr/bin/python3 --no-site-packages ng-notifier;
cd ng-notifier;
source bin/activate;
git clone https://github.com/Dubrzr/NG-Notifier.git web;
cd web;
pip install -r requirements.txt;
cd ng-notifier;
cp example.settings.py settings.py;
"${EDITOR:-vi}" settings.py && cd ..

Here generate a key for SECRET_KEY (google guys). Leave others parameters as they are if you are in a hurry!

Save changes, and continue with:

python manage.py install

And you will now be able to launch your server with:

python manage.py runserver

Run the notifier with:

python manage.py tasks
You can’t perform that action at this time.