From 3fe546d75714e17ce068b67b75c9842628b55b78 Mon Sep 17 00:00:00 2001 From: Jon Heaton Date: Mon, 7 Apr 2014 14:08:55 +0100 Subject: [PATCH] README update with CLA and new License and version 1 bump --- LICENSE.md | 30 +++++++++++++++++++++++ README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++--- setup.py | 2 +- 3 files changed, 100 insertions(+), 4 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..3796a715 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,30 @@ +BSD License + +For python-instagram software + +Copyright (c) 2014, Facebook, Inc. All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + + * Neither the name Facebook nor the names of its contributors may be used to + endorse or promote products derived from this software without specific + prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/README.md b/README.md index f1a660b8..ee1e9112 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,19 @@ Requires * simplejson -Discussion ------- +Instagram REST and Search APIs +------------------------------ +Our [developer site](http://instagram.com/developer) documents all the Instagram REST and Search APIs. + + +Blog +---------------------------- +The [Developer Blog] features news and important announcements about the Instagram Platform. You will also find tutorials and best practices to help you build great platform integrations. Make sure to subscribe to the RSS feed not to miss out on new posts: [http://developers.instagram.com](http://developers.instagram.com). -Visit [our Google Group](http://groups.google.com/group/instagram-api-developers) to discuss the Instagram API. + +Community +---------------------- +The [Stack Overflow community](http://stackoverflow.com/questions/tagged/instagram/) is a great place to ask API related questions or if you need help with your code. Make sure to tag your questions with the Instagram tag to get fast answers from other fellow developers and members of the Instagram team. Authentication @@ -167,3 +176,60 @@ authentication, subscriptions, and update processing. To try it out: * Open up sample\_app.py, update it with your client\_id and secret, and set redirect URI to 'http://localhost:8515/oauth_callback' * Run the file; it will host a local server on port 8515. * Try visiting http://localhost:8515 in your browser + +Contributing +------------ +In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project. + +Here are some ways *you* can contribute: + +* by using alpha, beta, and prerelease versions +* by reporting bugs +* by suggesting new features +* by writing or editing documentation +* by writing specifications +* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace) +* by refactoring code +* by closing [issues](http://github.com/Instagram/python-instagram/issues) +* by reviewing patches + + +Submitting an Issue +------------------- +We use the [GitHub issue tracker](https://github.com/Instagram/python-instagram/issues) to track bugs and +features. Before submitting a bug report or feature request, check to make sure it hasn't already +been submitted. You can indicate support for an existing issue by voting it up. When submitting a +bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any +details that may be necessary to reproduce the bug, including your version number, and +operating system. Ideally, a bug report should include a pull request with failing specs. + +Instagram has a [bounty program](https://www.facebook.com/whitehat/) for the safe +disclosure of security bugs. In those cases, please go through the process +outlined on that page and do not file a public issue. + + +Submitting a Pull Request +------------------------- +1. Fork the project. +2. Create a topic branch. +3. Implement your feature or bug fix. +4. Run python tests.py . +5. Add a test for your feature or bug fix. +6. Run python tests.py . If your changes are not 100% covered, go back to step 5. +7. Commit and push your changes. +8. Submit a pull request. +9. If you haven't already, complete the Contributor License Agreement ("CLA"). + +Contributor License Agreement ("CLA") +_____________________________________ +In order to accept your pull request, we need you to submit a CLA. You only need +to do this once to work on any of Instagram's or Facebook's open source projects. + +Complete your CLA here: [https://code.facebook.com/cla](https://code.facebook.com/cla) + + +Copyright +--------- +Copyright (c) 2014, Facebook, Inc. All rights reserved. +By contributing to python-instagram, you agree that your contributions will be licensed under its BSD license. +See [LICENSE](https://github.com/Instagram/python-instagram/blob/master/LICENSE.md) for details. diff --git a/setup.py b/setup.py index 6eb85c68..6450fcd1 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup, find_packages setup(name="python-instagram", - version="0.8.0", + version="1.0.0", description="Instagram API client", license="MIT", install_requires=["simplejson","httplib2"],