Commits

Tom Aratyn  committed ddb5807

Added license and readme.

  • Participants
  • Parent commits 6277bf6

Comments (0)

Files changed (2)

+The MIT License (MIT)
+
+Copyright (c) 2013 Tom Aratyn <tom@aratyn.name>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+# Bitbucket Issue Release Note Converter
+
+Converting closed issues release notes is a pain. This script uses the [Bitbucket API](https://confluence.atlassian.com/display/BITBUCKET/Using+the+Bitbucket+REST+APIs) to generate a markdown file of all the closed issues for a given milestone.
+
+It prints to standard out so you can just redirect to a file and then add more info  in your favourite editor. 
+
+## Usage
+
+`release-note-genetor.py` takes three default arguments: bitbucket username, repository slug, and milestone.
+ 
+`python release-note-generator.py -h` will show help.
+
+Basic Usage is as follows:
+
+    $ python release-note-generator.py themystic bitbucket-release-notes-generator 0.0.1
+    - [1](https://bitbucket.org/themystic/bitbucket-release-notes-generator/issue/1) issue title displays here 
+    - [2](https://bitbucket.org/themystic/bitbucket-release-notes-generator/issue/2) issue title displays here 
+    - [3](https://bitbucket.org/themystic/bitbucket-release-notes-generator/issue/3) issue title displays here 
+
+
+## License
+
+This script is licensed under the MIT license. See the LICENSE file for details.