From 8d6beb82d35363f52182c401a00df1e8ffb43fd3 Mon Sep 17 00:00:00 2001 From: pombredanne Date: Mon, 6 Jul 2015 11:46:14 +0200 Subject: [PATCH] Preparation for version 1.1.0 * Bumped version * Updated changelog for 1.1.0 * Adding missing AUTHORS.rst file * Fixed CONTRIBUTING.rst reST markup --- .bumpversion.cfg | 2 +- AUTHORS.rst | 3 ++ CHANGELOG.rst | 12 ++++++++ CONTRIBUTING.rst | 62 ++++++++++++++++++++++++---------------- setup.py | 2 +- src/scancode/__init__.py | 2 +- 6 files changed, 55 insertions(+), 28 deletions(-) create mode 100644 AUTHORS.rst diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 2d8a9781837..ed905f8656f 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.0.0 +current_version = 1.1.0 files = setup.py src/scancode/__init__.py commit = False tag = False diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 00000000000..ecc927b9b32 --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,3 @@ +The following organization or individuals have contributed to ScanCode: + +- nexB Inc. diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 7e34b21ac2f..63959561481 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,16 @@ Changelog ========= +1.1.0 (2015-07-06) +------------------ + +* Minor bug fixes. + + * Enforced exclusivity of --extract option + * Improved command line help. + * Added continuous testing with Travis and Appveyor and fixed tests + + 1.0.0 (2015-06-30) ------------------ @@ -9,3 +19,5 @@ Changelog * support for scanning licenses and copyrights * simple command line with html, htaml-app and JSON formats output + + \ No newline at end of file diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a1f9ad50513..d1b243b0c80 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -5,13 +5,16 @@ Contributing Contributions are welcome and appreciated! Every little bit helps, and credit will always be given. -When contributing to ScanCode (such as code, bugs, documentation, etc.) you agree to the -Developer Certificate of Origin http://developercertificate.org/ and the ScanCode license (see the NOTICE file) +When contributing to ScanCode (such as code, bugs, documentation, etc.) you +agree to the Developer Certificate of Origin http://developercertificate.org/ +and the ScanCode license (see the NOTICE file) + Feature requests and feedback ============================= -To send feedback file an issue at https://github.com/scancode/scancode-toolkit/issues +To send feedback, file an issue at +https://github.com/scancode/scancode-toolkit/issues If you are proposing a feature: @@ -23,22 +26,26 @@ If you are proposing a feature: Bug reports =========== -When reporting a bug at https://github.com/nexb/scancode-toolkit/issues please include: +When reporting a bug at https://github.com/nexb/scancode-toolkit/issues please +include: * Your operating system name, version and architecture (32 or 64 bits). * Your Python version. * Your ScanCode version. -* Any additional details about your local setup that might be helpful to diagnose this bug. -* Detailed steps to reproduce the bug, such as the commands you ran and a link to the code you are scanning. +* Any additional details about your local setup that might be helpful to + diagnose this bug. +* Detailed steps to reproduce the bug, such as the commands you ran and a link + to the code you are scanning. * The errors messages or failure trace if any. -* If helpful, you can add a screenshot as an issue attachment when relevant or some extra file as a link to a Gist https://gist.github.com +* If helpful, you can add a screenshot as an issue attachment when relevant or + some extra file as a link to a Gist https://gist.github.com Documentation improvements ========================== -Documentation can come in the form of wiki pages, docstrings, blog posts, articles, etc. -Even a minor typo fix is welcomed. +Documentation can come in the form of wiki pages, docstrings, blog posts, +articles, etc. Even a minor typo fix is welcomed. Development @@ -46,7 +53,8 @@ Development To set up ScanCode for local development: -1. Fork the scancode-toolkit on GitHub https://github.com/nexb/scancode-toolkit/fork +1. Fork the scancode-toolkit on GitHub at + https://github.com/nexb/scancode-toolkit/fork 2. Clone your fork locally:: @@ -57,30 +65,31 @@ To set up ScanCode for local development: git checkout -b name-of-your-bugfix-or-feature 4. Configure your local environment for development, run the configure script. + The configure script creates an isolated Python `virtual environment` in + your checkout directory, the Python `pip` tool, and installs the thirdparty + libraries (from the `thirdparty/ directory`), setup the paths, etc. + See https://virtualenv.pypa.io/en/latest/ for more details. - The configure script creates an isolated Python `virtual environment` in your checkout directory, the Python `pip` - tool, and installs the thirdparty libraries (from the `thirdparty/ directory`), setup the paths, etc. - See https://virtualenv.pypa.io/en/latest/ for more. Run this command :: + Run this command to configure ScanCode:: source configure - - On Windows use instead:: - configure + On Windows use instead:: - When you create a new terminal/shell to work on ScanCode, either rerun the configure script or - `source bin/activate` (or just run bin\actiavte on Windows) + configure + When you create a new terminal/shell to work on ScanCode, either rerun the + configure script or `source bin/activate` (or run `bin\\activate` on Windows) -5. Now you can make your code changes in your local clone. - Please create new unit tests for your code. +5. Now you can make your code changes in your local clone. + Please create new unit tests for your code. -6. When you are done with your changes, run all the tests. - Use this command:: +6. When you are done with your changes, run all the tests. + Use this command:: - py.test + py.test - Or use the -n6 option to run on 6 threads in parallel and run tests faster:: + Or use the -n6 option to run on 6 threads in parallel and run tests faster:: py.test -n6 @@ -118,7 +127,10 @@ To run the tests from a single test file:: py.test tests/commoncode/test_fileutils.py -To run tests in parallel on 8 processes:: +To run tests in parallel on eight processors:: py.test -n 8 +To run tests verbosely, displaying all print statements to terminal:: + + py.test -vvs diff --git a/setup.py b/setup.py index 39f2840ad87..66e4b7511ce 100644 --- a/setup.py +++ b/setup.py @@ -29,7 +29,7 @@ def read(*names, **kwargs): setup( name='scancode-toolkit', - version='1.0.0', + version='1.1.0', license='Apache-2.0 with ScanCode acknowledgment and CC0-1.0 and others', description='ScanCode is a tool to scan code for license, copyright and other interesting facts.', long_description=long_description, diff --git a/src/scancode/__init__.py b/src/scancode/__init__.py index db23aca481e..4a28823437d 100644 --- a/src/scancode/__init__.py +++ b/src/scancode/__init__.py @@ -22,4 +22,4 @@ # ScanCode is a free software code scanning tool from nexB Inc. and others. # Visit https://github.com/nexB/scancode-toolkit/ for support and download. -__version__ = '1.0.0' +__version__ = '1.1.0'