projects / tools.git / blame
search:
summary | shortlog | log | commit | commitdiff | tree
plain | HEAD | blame
edits
[tools.git] / index.md
Alex Sadleir 1 #GovHack Toolkit
Maxious 2 Welcome to the GovHack toolkit. This page provides all the information you need to prepare hackfest entries.
Alex Sadleir 3 These tools can be used to make entries like mobile apps, web apps and data visualisations/infographics.
4
5 The text of this toolkit is open for reuse under a Creative Commons Attribution licence and improvements are encouraged via Git http://github.com/maxious/govhack-tools or via email patches to govhack@lambdacomplex.org
Maxious 6
Maxious 7 # How to register and submit your entry
Alex Sadleir 8 ## Registering your team
9 Coming Soon: how to use the website "Hacker Space" to register and find teams.
Maxious 10
Alex Sadleir 11 ## Preparing your submission
Maxious 12
Maxious 13 You should record a 3 minute speech and mix images/text to accompany.
Maxious 14 http://www.screenr.com/ and other screencasting tools allow you to demo apps.
Maxious 15 To mix together clips, you can use youtube video editor http://www.youtube.com/editor or local software like http://www.videolan.org/vlmc/ or http://www.lwks.com/
Maxious 16
Maxious 17 You also need to submit your "source material". For an application this may be source code, for another work it might be your notes or prototypes.
Maxious 18 The key thing here is that your source material demonstrates to the judges that some of the end result was your own work and that it is possible for another person to replicate that work.
Maxious 19
20
21 # General References {#general-data-hacking-and-programming-references}
Maxious 22
Maxious 23
Maxious 24 ## The basics of being a data scientist
25
maxious 26 * Have a hypothesis - even if you're making a tool/api that helps people with their questions too, remember what the objective of that is.
Maxious 27 * Find the people and tools you need to prove/show/find. This rest of this page will help with the latter.
Maxious 28 * Analyse and present results - were they what you expected? Do they help explain to others what you have found out?
29 Can present as a interactive data visualisation or a web/mobile application or just a infographic/motion graphics video that tells a story.
Maxious 30
Alex Sadleir 31 [![](img/How-to-participate-in-GovHack_html_m6a65720f-300x199.gif "Data Journalism Diagram")](img/How-to-participate-in-GovHack_html_m6a65720f.gif)</dt>
Maxious 32 Illustration from Data Journalism Handbook, CC BY-SA 3.0</dd>
33
maxious 34 The best high level reference is the 'Understanding Data' and 'Delivering Data' chapters of the Data Journalism Handbook which is available online for free at
Maxious 35 [datajournalismhandbook.org](http://datajournalismhandbook.org/)
36
37 You can learn the technical skills from scratch in Visualize This: The FlowingData Guide to Design, Visualization, and Statistics by Nathan Yau or for more advanced
38 practical advice check out Data Analysis with Open Source Tools by Philipp K. Janert
39 For further reading in this space
40 [http://flowingdata.com/2012/04/27/data-and-visualization-blogs-worth-following/](http://flowingdata.com/2012/04/27/data-and-visualization-blogs-worth-following/)
41
42
43 **Statistics**
Alex Sadleir 44
45 A great guide to statistics is
46 [Think Stats](http://greenteapress.com/thinkstats/html/index.html)
Maxious 47
48 **Programming**
49
50 Programming is valuable skill for manipulating and displaying data.
Alex Sadleir 51 Basic tutorials for a variety of languages are available for free online or you can learn interactively with websites like [Codecademy for JavaScript](http://www.codecademy.com/#!/exercises/0), [Learn Python](http://www.learnpython.org/) or [Try Ruby](http://tryruby.org/)
Maxious 52
Alex Sadleir 53 For web applications and visualisations, you'll need a basic understanding of JavaScript in order to configure pre made libraries like jQuery. A good source for Javascript information is the [Mozilla Development Network Javascript Page](https://developer.mozilla.org/en/JavaScript)
Maxious 54
55 **Accessibility/User Experience**
56
Alex Sadleir 57 Following accessibility guidelines not only make a application accessible but make it a better experience for all users! Even if not making an app, good to consider these things to do and not do when designing for humans: [http://www.w3.org/TR/WCAG/](http://www.w3.org/TR/WCAG/)
Maxious 58
59
60
Alex Sadleir 61 # Developer Tools For Your Computer {#developer-tools-for-your-computer}
62 No matter what kind of application you have for the data, there are many tools you can use to better collaborate and manage your project.
Maxious 63
maxious 64 ### Source Control
Alex Sadleir 65 Using a version control system like Git or Subversion allows you to keep many different versions of what you have been working on so you can collaborate with others or simply back up your files so you don't lose them!
Maxious 66
Alex Sadleir 67 [![](img/Screenshot-at-2012-04-29-172132-300x235.png "Git Screenshot")](http://progit.org/book/)
Maxious 68
Maxious 69 [tutorials on git](http://progit.org/book/) and
70 [GUIs to help you](http://code.google.com/p/tortoisegit/)
Maxious 71
Maxious 72 [manual for Subversion](http://svnbook.red-bean.com/)
73 and a [similar GUI for Subversion](http://tortoisesvn.net/)
Maxious 74
75
Alex Sadleir 76 ### Task Tracking
Maxious 77
78 Issue/task trackers allow you to outline the tasks required for your project and assign them to people to do.
79
80 [Trello](https://trello.com/) and [Workflowy](https://workflowy.com/) are free, lightweight project management tools suitable for a rapid project!
81
Maxious 82 ## Hosted Developer Tools {#hosted-developer-tools}
83
Alex Sadleir 84 Can get many tools (source control, issue tracking) combined into one service cloud hosted so there's no setup required.
Maxious 85
86 ### Github
Alex Sadleir 87 Git obviously but svn/hg interfaces are also available. Provide their own GUI for Windows/OSX or use a variety of Git capable tools
88
89 ### Sourceforge
90
91 Subversion, Git, Mercurial, Bazaar, CVS, issue tracker, wiki, release file downloads. Unlimited free use for open source projects.
92
93 You can create your own Sourceforge project at [http://sourceforge.net/](http://sourceforge.net/)
94
95 ### Google Code Project Hosting
96
97 Git, Mercurial, and Subversion code. Issue tracker, wiki, release file downloads. Unlimited free use for open source projects.
98
99 You can host your Google Code project and get access to developer tools, APIs and documentation at [http://code.google.com/](http://code.google.com/)
100
101
Alex Sadleir 102 # Applications of data hacking
103
104 ## API Development {#api-development}
Maxious 105
106
maxious 107 So an API isn't just an XML file ![;)](http://www.govhack.org/wp-includes/images/smilies/icon_wink.gif)
108
109 A good web based data API:
110
111 * Is logically organised
112 * Can filter returned data
113 * Can return results in different open formats (CSV/JSON etc.)
114 * Is efficient and responsive by using caching and databases appropriately
115 * Handles errors gracefully
116 * Monitors and controls access (to show benefit realised of API and prevent abuse)
117 * Provides appropriate documentation with examples
118
119 Some people like sensis [http://](http://developers.sensis.com.au/)[developers.sensis.com.<wbr>au</wbr>](http://developers.sensis.com.au/)[/](http://developers.sensis.com.au/) use a provider like[http://](http://mashery.com/)[mashery.com](http://mashery.com/)[/](http://mashery.com/) or [https](https://apigee.com/)[://](https://apigee.com/)[apigee.com](https://apigee.com/) or [http://](http://apiaxle.com/)[apiaxle.com](http://apiaxle.com/)[/](http://apiaxle.com/) or [http://www.3scale.net/](http://www.3scale.net/) which handles making a good API for them.
120
Maxious 121 Atlassian have a great page on what makes a good API https://developer.atlassian.com/display/REST/Atlassian+REST+API+Design+Guidelines+version+1)
122
Maxious 123 HowTo.gov has a bunch of api resources about choosing SOAP vs. REST etc. http://www.howto.gov/mobile/apis-in-government
Alex Sadleir 124
Maxious 125 API documentation is important too! Traditionally for SOAP APIs, you use WSDL but for REST try [Swagger](http://swagger.wordnik.com/) or [iodocs](https://github.com/mashery/iodocs)
126 Many web app frameworks can generate the documentation for you. For example Symfony for PHP http://symfony.com/ https://github.com/FriendsOfSymfony/FOSRestBundle http://williamdurand.fr/2012/08/02/rest-apis-with-symfony2-the-right-way/ https://github.com/nelmio/NelmioApiDocBundle
maxious 127 Or for Ruby on Rails there is is https://github.com/elc/rapi_doc https://github.com/Pajk/apipie-rails
Maxious 128
129 better apis https://github.com/liip/LiipHelloBundle
Alex Sadleir 130
Maxious 131 http://amberonrails.com/building-stripes-api/
Alex Sadleir 132
Alex Sadleir 133 example WeatherTree weather API
Maxious 134
135
Alex Sadleir 136 ## Infographics and Data Visualisation {#data-visualisation}
Alex Sadleir 137
138 Infographics try to contextualise charts and graphs to tell a story. Data vis builds on this to find new ways to design insight.
139
140 Most of the categories to follow have visualisation tools specific to their purpose.
141
maxious 142 You can find some data visualisation tools below:
143
Maxious 144 [Essential Colletion](http://www.visualisingdata.com/index.php/2011/07/part-6-the-essential-collection-of-visualisation-resources/)
145 [Drawing By Numbers Tools and Resources](http://drawingbynumbers.org/toolsandresources)
146 - http://selection.datavisualization.ch/ data viz tools catalog
147 Also check out [http://thejit.org](http://thejit.org/) &amp; [http://www.senchalabs.org/<wbr>philogl/</wbr>](http://www.senchalabs.org/philogl/) (contributed by Matt Adcock)
148
149 A good infographic should use visual art concepts and [good color schemes](http://www.r-bloggers.com/the-paul-tol-21-color-salute/)
150 For more information on the theory of data visualisation check out the (Stanford