From 136fa2fb59143d25eb5729ef56989297c4f7bf60 Mon Sep 17 00:00:00 2001 From: Forest Gregg Date: Wed, 31 May 2017 16:52:17 -0500 Subject: [PATCH] Update README.rst --- README.rst | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index f931fbd..e2f7ea2 100644 --- a/README.rst +++ b/README.rst @@ -8,11 +8,24 @@ A simple wrapper for the United States Census Bureau's API. Provides access to ACS, SF1, and SF3 data sets. +Install +======= + +:: + + pip install census + +You may also want to install a complementary library, _`us `_, which help you figure out the +_`FIPS `_ codes for many geographies. We use it in the examples below. + +:: + + pip install us Usage ===== -First, get yourself a `Census API key `_. +First, get yourself a `Census API key `_. :: @@ -60,13 +73,13 @@ Geographies =========== The API supports a wide range of geographic regions. The specification of these -can be quite complicated so a number of convenience methods are provided. Refer to the `Census API documentation `_ +can be quite complicated so a number of convenience methods are provided. Refer to the `Census API documentation `_ for more geographies beyond the convenience methods. *Not all geographies are supported in all years. Calling a convenience method with a year that is not supported will raise census.UnsupportedYearException.* -`Geographic relationship files `_ are provided on the Census developer site as a tool to help users compare the geographies from the 1990, 2000 and 2010 Censuses. From these files, data users may determine how geographies from one Census relate to those from the prior Census. +`Geographic relationship files `_ are provided on the Census developer site as a tool to help users compare the geographies from the 1990, 2000 and 2010 Censuses. From these files, data users may determine how geographies from one Census relate to those from the prior Census. ACS5 Geographies ----------------