Developer Resources

General Notes

Flake Settings

Flake is used to statically verify code syntax. If the developer is running flake from the command line, they should ignore the following checks in order to emulate the same checks as the CI machine.

Code Description
E402 module level import not at top of file
E501 line too long (82 characters) or max-line = 100
E731 do not assign a lambda expression, use a def
W503 line break occurred before a binary operator
W504 line break occurred after a binary operator

To run flake locally call:

tox -e flake8

Django Notes

Adding New Fields to Database

Adding new fields to SEED can be complicated since SEED has a mix of typed fields (database fields) and extra data fields. Follow the steps below to add new fields to the SEED database:

  1. Add the field to the PropertyState or the TaxLotState model. Adding fields to the Property or TaxLot models is more complicated and not documented yet.
  2. Add field to list in the following locations:
  • models/ Column.DATABASE_COLUMNS
  • TaxLotState.coparent or PropertyState.coparent: SQL query and keep_fields
  1. Run ./ makemigrations

  2. Add in a Python script in the new migration to add in the new column into every organizations list of columns. Note that the new_db_fields will be the same as the data in the Column.DATABASE_COLUMNS that were added.

    def forwards(apps, schema_editor):
        Column = apps.get_model("seed", "Column")
        Organization = apps.get_model("orgs", "Organization")
        new_db_fields = [
                'column_name': 'geocoding_confidence',
                'table_name': 'PropertyState',
                'display_name': 'Geocoding Confidence',
                'data_type': 'number',
            }, {
                'column_name': 'geocoding_confidence',
                'table_name': 'TaxLotState',
                'display_name': 'Geocoding Confidence',
                'data_type': 'number',
        # Go through all the organizatoins
        for org in Organization.objects.all():
            for new_db_field in new_db_fields:
                columns = Column.objects.filter(
                if not columns.count():
                    new_db_field['organization_id'] =
                elif columns.count() == 1:
                    # If the column exists, then just update the display_name and data_type if empty
                    c = columns.first()
                    if c.display_name is None or c.display_name == '':
                        c.display_name = new_db_field['display_name']
                    if c.data_type is None or c.data_type == '' or c.data_type == 'None':
                        c.data_type = new_db_field['data_type']
                    print("  More than one column returned")
    class Migration(migrations.Migration):
        dependencies = [
            ('seed', '0090_auto_20180425_1154'),
        operations = [
            ... existing db migrations ...,
  3. Run migrations ./ migrate

  4. Run unit tests, fix failures. Below is a list of files that need to be fixed (this is not an exhaustive list)

  1. (Optional) Update example files to include new fields
  2. Test import workflow with mapping to new fields

AngularJS Integration Notes

Template Tags

Angular and Django both use {{ and }} as variable delimiters, and thus the AngularJS variable delimiters are renamed {$ and $}.

window.BE.apps.seed = angular.module('BE.seed', ['$interpolateProvider'], function ($interpolateProvider) {

Django CSRF Token and AJAX Requests

For ease of making angular $http requests, we automatically add the CSRF token to all $http requests as recommended by ($http, $cookies) {
    $http.defaults.headers.common['X-CSRFToken'] = $cookies['csrftoken'];

Routes and Partials or Views

Routes in static/seed/js/seed.js (the normal angularjs app.js)

SEED_app.config(['stateHelperProvider', '$urlRouterProvider', '$locationProvider', function (stateHelperProvider, $urlRouterProvider, $locationProvider) {
      name: 'home',
      url: '/',
      templateUrl: static_url + 'seed/partials/home.html'
      name: 'profile',
      url: '/profile',
      templateUrl: static_url + 'seed/partials/profile.html',
      controller: 'profile_controller',
      resolve: {
        auth_payload: ['auth_service', '$q', 'user_service', function (auth_service, $q, user_service) {
          var organization_id = user_service.get_organization().id;
          return auth_service.is_authorized(organization_id, ['requires_superuser']);
        user_profile_payload: ['user_service', function (user_service) {
          return user_service.get_user_profile();

HTML partials in static/seed/partials/


Information about error logging can be found here -

Below is a standard set of error messages from Django.

A logger is configured to have a log level. This log level describes the severity of the messages that the logger will handle. Python defines the following log levels:

DEBUG: Low level system information for debugging purposes
INFO: General system information
WARNING: Information describing a minor problem that has occurred.
ERROR: Information describing a major problem that has occurred.
CRITICAL: Information describing a critical problem that has occurred.

Each message that is written to the logger is a Log Record. The log record is stored in the web server & Celery

BEDES Compliance and Managing Columns

Columns that do not represent hardcoded fields in the application are represented using a Django database model defined in the seed.models module. The goal of adding new columns to the database is to create seed.models.Column records in the database for each column to import. Currently, the list of Columns is dynamically populated by importing data.

There are default mappings for ESPM are located here:

Resetting the Database

This is a brief description of how to drop and re-create the database for the seed application.

The first two commands below are commands distributed with the Postgres database, and are not part of the seed application. The third command below will create the required database tables for seed and setup initial data that the application expects (initial columns for BEDES). The last command below (spanning multiple lines) will create a new superuser and organization that you can use to login to the application, and from there create any other users or organizations that you require.

Below are the commands for resetting the database and creating a new user:

psql -c 'DROP DATABASE "seeddb"'
psql -c 'CREATE DATABASE "seeddb" WITH OWNER = "seeduser";'
psql -c 'GRANT ALL PRIVILEGES ON DATABASE "seeddb" TO seeduser;'
psql -c 'ALTER ROLE seeduser SUPERUSER;
psql -d seeddb -c "CREATE EXTENSION postgis;"
./ migrate
./ create_default_user \ \
    --password=password \

Migrating the Database

Migrations are handles through Django; however, various versions have customs actions for the migrations. See the migrations page for more information based on the version of SEED.


JS tests can be run with Jasmine at the url /angular_js_tests/.

Python unit tests are run with

python test --settings=config.settings.test
Note on geocode-related testing:

Most of these tests use and cassettes to capture and reuse recordings of HTTP requests and responses. Given that, unless you want to make changes and/or refresh the cassettes/recordings, there isn’t anything needed to run the geocode tests.

In the case that the geocoding logic/code is changed or you’d like to the verify the MapQuest API is still working as expected, you’ll need to run the tests with a small change. Namely, you’ll want to provide the tests with an API key via an environment variable called “TESTING_MAPQUEST_API_KEY” or within your file with that same variable name.

In order to refresh the actual cassettes, you’ll just need to delete or move the old ones which can be found at “.seed/tests/data/vcr_cassettes”. The API key should be hidden within the cassettes, so these new cassettes can and should be pushed to GitHub.

Run coverage using

coverage run test --settings=config.settings.test
coverage report --fail-under=83

Python compliance uses PEP8 with flake8

# or
tox -e flake8

JS Compliance uses jshint

jshint seed/static/seed/js

Release Instructions

To make a release do the following:

  1. Github admin user, on develop branch: update the package.json file with the most recent version number. Always use MAJOR.MINOR.RELEASE.
  2. Update the docs/sources/migrations.rst file with any required actions.
  3. Run the docs/scripts/ script and add the changes to the file for the range of time between last release and this release. Only add the Closed Issues. Also make sure that all the pull requests have a related Issue in order to be included in the change log.
python docs/scripts/ –k GITHUB_API_TOKEN –s 2018-02-26 –e 2018-05-30
  1. Paste the results (remove unneeded Accepted Pull Requests) into the Make sure to cleanup the formatting.
  2. Make sure that any new UI needing localization has been tagged for translation, and that any new translation keys exist in the project. (see translation documentation).
  3. Once develop passes, then create a new PR from develop to master.
  4. Draft new Release from Github (
  5. Include list of changes since previous release (i.e. the content in the
  6. Verify that the Docker versions are built and pushed to Docker hub (
  7. Go to Read the Docs and enable the latest version to be active (