Skip to content

Commit

Permalink
Initial commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
pombredanne committed Jul 1, 2015
1 parent ebc5d2a commit 88d7a6e
Show file tree
Hide file tree
Showing 13,195 changed files with 1,634,558 additions and 0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
14 changes: 14 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
language: python

python:
- "2.7"

install:
- source configure

script:
- py.test -vs src tests/commoncode \
tests/extractcode tests/textcode tests/typecode tests/cluecode \
tests/licensedcode/test_detect.py tests/licensedcode/test_index.py \
tests/licensedcode/test_legal.py tests/licensedcode/test_models.py

11 changes: 11 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

Changelog
=========

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
124 changes: 124 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
============
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)

Feature requests and feedback
=============================

To send feedback file an issue at https://github.com/scancode/scancode-toolkit/issues

If you are proposing a feature:

* Explain how it would work.
* Keep the scope simple possible to make it easier to implement.
* Remember that your contributions are welcomed to implement this feature!


Bug reports
===========

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.
* 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


Documentation improvements
==========================

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

2. Clone your fork locally::

git clone git@github.com:your_name_here/scancode-toolkit.git

3. Create a branch 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. Run this command ::

source configure
On Windows use instead::

configure

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)


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

py.test

Or use the -n6 option to run on 6 threads in parallel and run tests faster::

py.test -n6

7. Commit your changes and push your branch to your GitHub fork::

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

8. Submit a pull request through the GitHub website for this branch.


Pull Request Guidelines
-----------------------

If you need a code review or feedback while you are developing the code just
create a pull request. You can add new commits to your branch as needed.

For merging, your request would need to:

1. Include unit tests that are passing (run ``py.test``).
2. Update documentation as needed for new API, functionality etc.
3. Add a note to ``CHANGELOG.rst`` about the changes.
4. Add your name to ``AUTHORS.rst``.


Test tips
---------

To run a subset of test functions containing test_myfeature in their name use::

py.test -k test_myfeature

To run the tests from a single test file::

py.test tests/commoncode/test_fileutils.py

To run tests in parallel on 8 processes::

py.test -n 8

15 changes: 15 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
graft src
graft tests

include AUTHORS.rst
include CHANGELOG.rst
include README.rst
include CONTRIBUTING.rst
include apache-2.0.LICENSE
include cc0-1.0.LICENSE
include NOTICE
include scancode.ABOUT

include tox.ini .travis.yml appveyor.yml

global-exclude *.py[co] __pycache__
54 changes: 54 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
Software license
================

Copyright (c) 2015 nexB Inc. and others. All rights reserved.
http://nexb.com and https://github.com/nexB/scancode-toolkit/
The ScanCode software is licensed under the Apache License version 2.0.
Data generated with ScanCode require an acknowledgment.
ScanCode is a trademark of nexB Inc.

You may not use this software except in compliance with the License.
You may obtain a copy of the License at: http://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.

When you publish or redistribute any data created with ScanCode or any ScanCode
derivative work, you must accompany this data with the following acknowledgment:

Generated with ScanCode and provided on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. No content created from
ScanCode should be considered or used as legal advice. Consult an Attorney
for any legal advice.
ScanCode is a free software code scanning tool from nexB Inc. and others.
Visit https://github.com/nexB/scancode-toolkit/ for support and download.


Third-party software licenses
=============================

ScanCode embeds third-party free and open source software packages under various
licenses including copyleft licenses. Some of the third-party software packages
are delivered as pre-built binaries. The origin and license of these packages is
documented by .ABOUT files.

The corresponding source code for pre-compiled third-party software is available
for immediate download from the same release page where you obtained ScanCode at:
https://github.com/nexB/scancode-toolkit/
or https://github.com/nexB/scancode-thirdparty-src/

You may also contact us to request the source code by email at info@nexb.com or
by postal mail at:
nexB Inc., ScanCode open source code request
735 Industrial Road, Suite #101, 94070 San Carlos, CA, USA
Please indicate in your communication the ScanCode version for which you are
requesting source code.


License for ScanCode datasets
=============================

ScanCode includes datasets (e.g. for license detection) that are dedicated
to the Public Domain using the Creative Commons CC0 1.0 Universal (CC0 1.0)
Public Domain Dedication: http://creativecommons.org/publicdomain/zero/1.0/
Loading

0 comments on commit 88d7a6e

Please sign in to comment.