Skip to content
OpenBlock Hyperlocal news platform

Questions and answers

OpenBlock, explained.

What OpenBlock is, what it is not, how the project is organized, and what it takes to run it for a city.

What it is, and is not

Start here if you are deciding whether OpenBlock fits your project.

What does it do?

OpenBlock is a hyperlocal news platform. It provides a local news database with various kinds of news, each with a location, a date, and any other information you want. You can use it principally in two ways:

  • As a standalone website where users can browse by location, right down to the single block level, by date, or by kind of news.
  • As a service you integrate with other websites through a REST API, custom RSS feeds, or custom widgets you embed in your pages.

Or both.

How is this different from Everyblock.com?

OpenBlock began life as the everyblock.com codebase. The two projects now proceed independently, but amicably. For more history, see the documentation and the EveryBlock archive.

Can I use OpenBlock to manage all my content?

You do not want to do that. OpenBlock is not a content management system. It is good for aggregating and filtering hyperlocal news. Lots of content does not make sense as hyperlocal news.

Project information

Background on release status, the team, and the project record.

Is it stable?

As of August 2011, OpenBlock is in beta. That said, the codebase was quite mature when everyblock.com initially released it, because it had already been used to run everyblock.com in production for some time.

When will there be a stable release?

The final 1.0 release was expected by September 2011. The release notes record how the project moved on to version 1.1.0 in October 2011.

Who are you guys?

OpenBlock is developed by OpenPlans, a 501(c)(3) nonprofit, with funding from the Knight Foundation.

How to use OpenBlock

Practical answers for people setting up and running a site.

How can I set up OpenBlock for my city?

Start with the documentation. If you get stuck, ask for help on the project channels. The team was still actively working on making installation and setup significantly easier.

Can I run OpenBlock outside the United States?

Be warned that several parts of OpenBlock assume US addresses. People were trying to set it up in Canada and Spain, but there are stumbling blocks. Ask for help before committing to a deployment outside the United States.

Where can I download OpenBlock?

Stable packages are on PyPI. Follow the installation instructions. Developers can check out the code from GitHub.

Where do I get news data to use with OpenBlock?

If you are setting up OpenBlock for its API or widget capabilities and want to integrate it with an existing website, you will probably feed in data you already have. If you are setting it up as an aggregator of hyperlocal news, this may be your biggest challenge. Availability of regularly updated local data varies a lot from place to place.

What kind of data formats can I feed in?

Almost anything you can find on the web. OpenBlock has infrastructure for dealing with various data formats: RSS and Atom feeds with or without geographic extensions, CSV files, and screen scraping HTML websites. Data can even be scraped from PDFs. This requires some Python scripting. See the scraper tutorial.

Alternatively, OpenBlock includes a simple REST API that allows pushing news into the system over HTTP.

Where do I get streets, blocks, and other location data for OpenBlock?

In the United States, consider using TIGER Line data from the US Census Bureau. See the geographic data documentation.

Do you have a hosted version that I can use?

No. There are no plans at this time for offering OpenBlock as a hosted service.

Can I include data that does not have a date?

OpenBlock is heavily geared toward displaying information that happened in one particular place at one particular time. In a word, news. If you have data that has a location but no meaningful date, you can create Places and categorize them using PlaceTypes. These will be optionally displayed as markers on some maps. This is not fully documented yet.

Can I include data that does not have a location?

No, that does not really make sense. If it does not have a date and a location, it is not local and it is not news, and it does not make sense for OpenBlock.

Send feedback on this page

The original FAQ invited comments. This static edition keeps the feedback form as a browser side demonstration.

Reference shelf

Official project, standards, and toolchain sources. These links open in a new tab.

Links point to independent project and standards websites outside openblockproject.org.