155 | Each
data source corresponds to a 'mancer' in
geomancer/mancers/.
156 |
157 |
1. Create a new class for your data source
158 |
159 | Geomancer implements a base class that establishes a pattern for setting up a new data source.
160 | In a new .py file in geomancer/mancers/, inherit from the BaseMancer class like so:
161 |
162 |
163 | from geomancer.mancers.base import BaseMancer
164 |
165 | class MyGreatMancer(BaseMancer):
166 |
167 | name = 'My Great Mancer'
168 | machine_name = 'my_great_mancer'
169 | base_url = 'http://lotsadata.gov/api'
170 | info_url = 'http://lotsadata.gov'
171 | description = 'This is probably the best mancer ever written'
172 |
173 | def get_metadata(self):
174 | return 'woo'
175 |
176 | def search(self, geo_ids=None, columns=None):
177 | return 'woo'
178 |
179 | def geo_lookup(self, search_term, geo_type=None):
180 | return 'woo'
181 |
182 |
Override the name, machine_name, base_url, info_url, & description properties accordingly.
183 |
184 |
2. Implement class methods for your mancer
185 |
This is the bulk of the work. You will need to implement the get_metadata, search, & geo_lookup methods.
186 |
187 | Detailed information about how the responses from these
188 | methods should be structured as well as two example mancers
189 | can be found in the
190 | Github repository.
191 |
192 |
193 |
3. Register your mancer in the application cofiguration
194 |
The basic configuration options for Geomancer exist in app_config.py. Add the import path to the module where you wrote your mancer and you should start seeing it as an option when you run the app.
195 |
196 |
197 | MANCERS = (
198 | 'geomancer.mancers.census_reporter.CensusReporter',
199 | 'geomancer.mancers.usa_spending.USASpending',
200 | 'geomancer.mancers.my_mancer.MyMancer',
201 | )
202 |
If your data source requires an API key, add the API key to app_config.py:
203 |
204 | MANCER_KEYS = {
205 | 'my_great_mancer' : 'biGl0ngUu1dT4ing',
206 | }
207 |
208 | The key (i.e. my_great_mancer) should match the value you used for the machine_name property of your mancer class.
209 |
210 |
211 |
212 |
213 |
 }})
8 |  }} "Knight Foundation"){kind=logo}
25 |  }} "Associated Press"){kind=logo}
26 |  }})
31 |
32 |  }})
11 |  }})
12 |  }})
13 |  }}){kind=logo}