App to create and send messages to public persons. It's a component of POPLUS project.
Python HTML CSS JavaScript Shell
Switch branches/tags
Nothing to show
Latest commit 0830395 Oct 25, 2016 @mhl mhl committed with lfalvarez Replace the broken references to chosen.css (#1199)
Two template files referenced {% static 'css/chosen.css' %}, which was
removed in 6009225.  That causes errors in production when
loading pages base on those templates.

That earlier commit switched to using bootstrap's styling for
the chosen.js-enhanced UI elements; this commit does the same to replace
the chosen.css references that are left.
Permalink
Failed to load latest commit information.
.tx Add the Transifex client and its configuration Aug 22, 2016
config_examples Adding .forward example file Apr 23, 2015
contactos Django 1.7 upgrade: Add new Django 1.7 initial migrations Jul 7, 2016
instance Django 1.7 upgrade: Add new Django 1.7 initial migrations Jul 7, 2016
locale Add new languages pulled from Transifex Aug 22, 2016
mailit Django 1.7 upgrade: Add new Django 1.7 initial migrations Jul 7, 2016
nuntium Replace the broken references to chosen.css (#1199) Oct 25, 2016
scripts Update docs and provisioning to run compilemessages Aug 22, 2016
writeit Add DEFAULT_URL_SCHEME setting and set to http Sep 20, 2016
.coveragerc Adding travis and coverall modifications for the new app mailit Apr 24, 2013
.gitignore Ignore any files matching local_settings_*.py Apr 14, 2015
.landscape.yaml Removing docstring warnings for landscape Feb 4, 2014
.travis.yml Switch to using container-based builds on Travis Jul 5, 2016
LICENSE.txt Adding GPLv3 License Aug 20, 2014
MANIFEST.in Adding MANIFEST.in Apr 8, 2014
Procfile Adding dash to procfile Aug 18, 2014
README.md Update docs and provisioning to run compilemessages Aug 22, 2016
Vagrantfile Increase vagrant memory to 1024 Apr 9, 2015
coverage.sh Modifiying README.md and adding test.sh and coverage.sh May 8, 2013
deploying_to_heroku.md Update docs and provisioning to run compilemessages Aug 22, 2016
diagram.png Adding diagram and django-extensions for requirements.txt and settings Jul 10, 2013
example_data.yaml Fix intermittent test failures Sep 20, 2016
global_test_case.py Removing all skipUnless no local popit running because there is no lo… May 4, 2015
hook-pre-commit Add a pre-commit hook to check for PEP8 compliance. Jan 20, 2015
manage.py Changing mangeme.py mode for execution Aug 12, 2013
requirements-amazon.txt Renaming old production requirements for the ones in amazon Jul 9, 2013
requirements-production.txt Preparing for postgresql starting Feb 17, 2014
requirements.txt Add the Transifex client and its configuration Aug 22, 2016
requirements_testing.txt Pin django-nose to the last version that works with Django < 1.7 Jul 5, 2016
schema.xml Adding search for messages and result html Jul 31, 2013
setup.cfg Make all code PEP8 compliant. Jan 20, 2015
setup.py Pin django-tastypie to the latest version (works with Django 1.7) Jul 7, 2016
start_local_popit_api.bash Adding a local popit-api to pull people from Sep 11, 2013
writeit_utils.py Escape HTML in the rendered email templates. Mar 20, 2015

README.md

You write it, and we deliver it.

Build Status Coverage Status Code Health

Write-it is an application that aims to deliver messages to people whose contacts are to be private or the messages should be public, for example: members of congress.

Write-it is a layer on top of popit from where it takes the people and adds contacts. The way it delivers messages is using plugins for example: mailit. And this approach allows for future ways of delivering for example: twitter, whatsapp, fax or pager.

Future uses are in congresoabierto to replace the old "preguntales" (You can check here, to see how it used to work) feature, it was inspired by writetothem.

Quick Installation (Vagrant)

Assuming you have Vagrant installed, run the following:

git clone https://github.com/ciudadanointeligente/write-it.git
cd write-it
vagrant up

Vagrant will automatically install WriteIt and all of its dependencies. This can take a few minutes.

Once it’s complete, log into the virtual machine with:

vagrant ssh

Once you’re inside the virtual machine, you can load some fixtures with:

./manage.py loaddata example_data.yaml

Then run the development server with:

./manage.py runserver 0.0.0.0:8000

And visit http://127.0.0.1.xip.io:8000 on your host machine to use WriteIt.

Background jobs

./manage.py celery worker

This handles syncing contact details from remote sources. If you have created a new instance and the contacts do not seem to be syncing it is probably because a celery worker is not running.

Scheduled jobs

./manage.py celery beat

This sends emails to recipients and periodically re-sync contacts from remote sources.

Manual Installation (without Vagrant)

System Requirements

It's required if you want to play around seaching messages and answers, this part is optional.

Your version of the Python elasticsearch package must match the version of Elasticsearch you have. The requirements.txt file in this repository currently specifies elasticsearch==1.6.0, which will only work with Elasticsearch with a major version of 1. If you have a 0.x or 2.x version of Elasticsearch you will need to install a different version of the Python elasticsearch package. For more details on how to pick the right version to use, see: https://elasticsearch-py.readthedocs.io/en/master/#compatibility

In ubuntu you can do sudo apt-get install libffi-dev

  • Libssl

In ubuntu you can do sudo apt-get install libssl-dev

  • GCC (G++) 4.3+ (used by python libsass package)

In ubuntu you can do sudo apt-get install g++

  • yui-compressor

In ubuntu you can do sudo apt-get install yui-compressor

Write-it is built using Django. You should install Django and its dependencies inside a virtualenv. We suggest you use virtualenvwrapper to create and manage virtualenvs, so if you don’t already have it, go install it, remembering in particular to add the required lines to your shell startup file.

With virtualenvwrapper installed, clone this repo, cd into it, and create a virtualenv:

git clone git@github.com:ciudadanointeligente/write-it.git
cd write-it
mkvirtualenv writeit

Install the requirements:

pip install -r requirements.txt

Set up the database, creating an admin user when prompted:

./manage.py syncdb && ./manage.py migrate

Compile all the available translations:

./manage.py compilemessages

Troubleshooting database migration

There's a problem migrating and the problem looks like

django.db.utils.OperationalError: no such table: tastypie_apikey

It can be fixed by running it twice.

Then run the server:

./manage.py runserver

Testing and Development

If you want to test without Elasticsearch

Elasticsearch is optional and can be turned off by creating a new local_settings.py file vi writeit/local_settings.py with the following content

LOCAL_ELASTICSEARCH = False

Running tests

For testing you need to run ./manage.py test nuntium contactos mailit

Coverage Analysis

For coverage analysis run ./coverage.sh

Logging in

At this point you probably have write-it running without any users. You could create a (super) user by running:

python manage.py createsuperuser

It will ask you the username and password (which you will need to repeat).

With that done you will be able to access '/accounts/login/'.

API clients

Write-it has been used mostly through its REST API for which there are a number of API clients. The github repos and the status of the development are listed below:

There are instructions to install write-it in heroku

The instructions are in the following link.