Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

added license, updated readme

  • Loading branch information...
commit 9f3d4cac3edd73006c44ab6fb4364abe9d638c24 1 parent 67b5fe4
@dwillis dwillis authored
Showing with 32 additions and 2 deletions.
  1. +13 −0 LICENSE
  2. +19 −2 README.md
View
13 LICENSE
@@ -0,0 +1,13 @@
+Copyright (c) 2012 The New York Times Company
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this library except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
View
21 README.md
@@ -1,7 +1,7 @@
NYT Campfin
==================
-A very basic Python client for the New York Times [Campaign Finance API](http://developer.nytimes.com/docs/campaign_finance_api). You'll need an API key, which should be set as an environment variable to run the tests. The client returns JSON only, not full Python objects.
+A very basic Python client for the New York Times [Campaign Finance API](http://developer.nytimes.com/docs/campaign_finance_api). You'll need an API key, which should be set as an environment variable to run the tests. The client returns JSON only, not full Python objects, and attempts to implement each response in The Times' API.
Install
-------
@@ -15,7 +15,7 @@ Or download and run
Requirements
------------
-Nytcampfin uses the [Kenneth Reitz's Requests library](https://github.com/kennethreitz/requests) for retrieving API endpoints and [Roman Haritonov's requests-cache library](https://github.com/reclosedev/requests-cache) for local caching. The cache is preconfigured to use a local sqlite database and set to expire after 5 minutes.
+NYT Campfin uses the [Kenneth Reitz's Requests library](https://github.com/kennethreitz/requests) for retrieving API endpoints and [Roman Haritonov's requests-cache library](https://github.com/reclosedev/requests-cache) for local caching. The cache is preconfigured to use a local sqlite database and set to expire after 5 minutes.
Tests
-----
@@ -46,5 +46,22 @@ Usage
>>> cand = finance.candidates.get('H4NY11138')
>>> cand['name']
u'CLARKE, YVETTE D'
+
+See the tests for plenty more examples.
+
+== Note on Patches/Pull Requests
+
+ * Fork the project.
+ * Make your feature addition or bug fix.
+ * Add tests for it.
+ * Send a pull request. Bonus points for topic branches.
+
+== Authors
+
+ Derek Willis, dwillis@nytimes.com
+
+== Copyright
+
+Copyright (c) 2012 The New York Times Company. See LICENSE for details.
Please sign in to comment.
Something went wrong with that request. Please try again.