• What is this?
• Assumptions
• What's in here?
• Bootstrap the project
• Configuration
• Run the project
• Adding a new graphic to the project
• Deploy to S3
• Embedding
• Connecting to a Google Spreadsheet
• Storing media assets

dailygraphics is a framework for creating and deploying responsive graphics suitable for publishing inside a CMS with pym.js.

Blog Post: Read more about how NPR Visuals uses dailygraphics

The following things are assumed to be true in this documentation.

• You are running OSX.
• You are using Python 2.7. (Probably the version that came OSX.)
• You have virtualenv and virtualenvwrapper installed and working.
• You have your Amazon Web Services credentials stored as environment variables locally.

For more details on the technology stack used with this project, see our development environment blog post.

The project contains the following folders and important files:

• data -- Place for downloaded COPY spreadsheets and other incidental data.
• etc -- Miscellanous Python libraries.
• fabfile -- Fabric commands for automating setup and deployment.
• new_graphic -- This directory is copied for each new graphic.
• templates -- HTML (Jinja2) templates, to be compiled locally.
• www -- Static assets to be deployed.
• app.py -- A Flask app for rendering the project locally.
• app_config.py -- Global project configuration for scripts, deployment, etc.
• render_utils.py -- Code supporting template rendering.
• requirements.txt -- Python requirements.
• static.py -- Flask views for serving static files.

cd dailygraphics
mkvirtualenv --no-site-packages dailygraphics
pip install -r requirements.txt

You'll now need to create a folder to hold the graphics created and deployed by this rig. This is configured in app_config.GRAPHICS_PATH and defaults to ../graphics. By keeping the graphics in a separate folder they can easily be easily version controlled in their own repository.

The dailygraphics project configuration defaults are specific to NPR. If you want to use it in your newsroom you should fork this repository and update app_config.py with your own configuration.

At a minimum you will want to change REPOSITORY_URL, PRODUCTION_S3_BUCKETS and STAGING_S3_BUCKETS.

A Flask app is used to run the project locally. It will automatically recompile templates on-demand.

workon dailygraphics
python app.py

Visit localhost:8000 for a list of graphics in the repo. Click on the graphic you are working on to view it.

Alternately, visit http://localhost:8000/graphics/NAME_OF_GRAPHIC in your browser to view the specific graphic you are working on.

To add a new graphic, run fab add_graphic:name-of-graphic.

This will create the folder name-of-graphic within your app_config.GRAPHICS_PATH folder. Within the new folder will be a child_template.html file and some boilerplate javascript files. child_template.html is a Jinja template that will be rendered with a context containing the contents of app_config.py, graphic_config.py and the COPY document for that graphic.

Create your graphic in the template file, and add any of the CSS/JS that you need within that folder.

Note: name-of-graphic should be URL-safe, e.g., lowercase and with dashes instead of spaces and no special characters.

Here are some examples:

• Good: my-project-name
  Bad: My-Project-NAME

• Good: my-project-name
  Bad: my project name

• Good: my-wonderful-project
  Bad: my wonderful project!

When it's time to publish your graphic, it's better to deploy a single graphic rather than the entire repo, to minimize the risk of publishing edits that aren't yet ready to go live.

To deploy a specific graphic:

fab staging deploy:NAME_OF_GRAPHIC

fab production deploy:NAME_OF_GRAPHIC

To deploy all graphics, leave off the graphic slug (but don't do this unless you're absolutely sure — you may deploy something that's not ready to be deployed yet):

fab production deploy

fab staging deploy

Deploy the project to production. Visit http://apps.npr.org/graphics/NAME_OF_GRAPHIC, and on that page should be an iframe with your graphic inside of it, and an embed code below the graphic. Paste the embed code into an HTML assets in your CMS.

(Note: this section describes usage of NPR's copytext rig for syncing text from a Google Spreadsheet. This is optional and you don't need to use it in order to use dailygraphics.)

I order to use the Google Spreadsheet syncing you will need to have environment variables set for APPS_GOOGLE_EMAIL and APPS_GOOGLE_PASS. If you use bash you might add these to ~/.bash_profile.

New graphics by default point to the main app-template's copy spreadsheet template. If you want to use this spreadsheet template as the basis for your project, make a copy of it first.

To connect this spreadsheet (or any spreadsheet) to your graphic, update the graphic_config.py file in your graphic's folder with the ID of your spreadsheet:

COPY_GOOGLE_DOC_KEY = '0AlXMOHKxzQVRdHZuX1UycXplRlBfLVB0UVNldHJYZmc'

Run this command to pull down the latest copy of the spreadsheet:

fab update_copy:NAME_OF_GRAPHIC

To pull down all spreadsheets in the dailygraphics repository, run:

fab update_copy

The deploy process will always pull down the latest spreadsheet and render the contents to your page.

Note: Your graphic will not automatically update every time your spreadsheet updates. It will only update when you deploy (or redeploy) it. For projects that seldom change, this is usually fine. Consider another solution if you need dynamic updates.

(Note: this section describes usage of NPR's assets rig. This is optional and you don't need to use it in order to use dailygraphics.)

Large media assets (images, videos, audio) are synced with an Amazon S3 bucket configured in app_config.ASSETS_S3_BUCKET in a folder with the name of the project. This allows everyone who works on the project to access these assets without storing them in the graphics repository, giving us faster clone times and the ability to open source our work.

Syncing these assets requires running a couple different commands at the right times. When you create new assets or make changes to current assets that need to get uploaded to the server, run fab assets.sync. This will do a few things:

• If there is an asset on S3 that does not exist on your local filesystem it will be downloaded.
• If there is an asset on that exists on your local filesystem but not on S3, you will be prompted to either upload (type "u") OR delete (type "d") your local copy.
• You can also upload all local files (type "la") or delete all local files (type "da"). Type "c" to cancel if you aren't sure what to do.
• If both you and the server have an asset and they are the same, it will be skipped.
• If both you and the server have an asset and they are different, you will be prompted to take either the remote version (type "r") or the local version (type "l").
• You can also take all remote versions (type "ra") or all local versions (type "la"). Type "c" to cancel if you aren't sure what to do.

Unfortunantely, there is no automatic way to know when a file has been intentionally deleted from the server or your local directory. When you want to simultaneously remove a file from the server and your local environment (i.e. it is not needed in the project any longer), run fab assets.rm:"www/assets/file_name_here.jpg"