Skip to content

Commit

Permalink
Merge pull request #23 from pombredanne/develop
Browse files Browse the repository at this point in the history
Preparation for version 1.1.0
  • Loading branch information
pombredanne committed Jul 6, 2015
2 parents 168175b + 8d6beb8 commit 4d69f65
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 28 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
The following organization or individuals have contributed to ScanCode:

- nexB Inc.
12 changes: 12 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,22 @@
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)
------------------

* Initial release.

* support for scanning licenses and copyrights
* simple command line with html, htaml-app and JSON formats output


62 changes: 37 additions & 25 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -23,30 +26,35 @@ 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
===========

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::

Expand All @@ -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

Expand Down Expand Up @@ -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
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion src/scancode/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'

0 comments on commit 4d69f65

Please sign in to comment.