Skip to content

Commit 88d7a6e

Browse files
pombredannepombredanne
committed
Initial commit.
1 parent ebc5d2a commit 88d7a6e

File tree

13,195 files changed

+1634558
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

13,195 files changed

+1634558
-0
lines changed

‎.travis.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
language: python
2+
3+
python:
4+
- "2.7"
5+
6+
install:
7+
- source configure
8+
9+
script:
10+
- py.test -vs src tests/commoncode \
11+
tests/extractcode tests/textcode tests/typecode tests/cluecode \
12+
tests/licensedcode/test_detect.py tests/licensedcode/test_index.py \
13+
tests/licensedcode/test_legal.py tests/licensedcode/test_models.py
14+

‎CHANGELOG.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
Changelog
3+
=========
4+
5+
1.0.0 (2015-06-30)
6+
------------------
7+
8+
* Initial release.
9+
10+
* support for scanning licenses and copyrights
11+
* simple command line with html, htaml-app and JSON formats output

‎CONTRIBUTING.rst

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
============
2+
Contributing
3+
============
4+
5+
Contributions are welcome and appreciated!
6+
Every little bit helps, and credit will always be given.
7+
8+
When contributing to ScanCode (such as code, bugs, documentation, etc.) you agree to the
9+
Developer Certificate of Origin http://developercertificate.org/ and the ScanCode license (see the NOTICE file)
10+
11+
Feature requests and feedback
12+
=============================
13+
14+
To send feedback file an issue at https://github.com/scancode/scancode-toolkit/issues
15+
16+
If you are proposing a feature:
17+
18+
* Explain how it would work.
19+
* Keep the scope simple possible to make it easier to implement.
20+
* Remember that your contributions are welcomed to implement this feature!
21+
22+
23+
Bug reports
24+
===========
25+
26+
When reporting a bug at https://github.com/nexb/scancode-toolkit/issues please include:
27+
28+
* Your operating system name, version and architecture (32 or 64 bits).
29+
* Your Python version.
30+
* Your ScanCode version.
31+
* Any additional details about your local setup that might be helpful to diagnose this bug.
32+
* Detailed steps to reproduce the bug, such as the commands you ran and a link to the code you are scanning.
33+
* The errors messages or failure trace if any.
34+
* 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
35+
36+
37+
Documentation improvements
38+
==========================
39+
40+
Documentation can come in the form of wiki pages, docstrings, blog posts, articles, etc.
41+
Even a minor typo fix is welcomed.
42+
43+
44+
Development
45+
===========
46+
47+
To set up ScanCode for local development:
48+
49+
1. Fork the scancode-toolkit on GitHub https://github.com/nexb/scancode-toolkit/fork
50+
51+
2. Clone your fork locally::
52+
53+
git clone [email protected]:your_name_here/scancode-toolkit.git
54+
55+
3. Create a branch for local development::
56+
57+
git checkout -b name-of-your-bugfix-or-feature
58+
59+
4. Configure your local environment for development, run the configure script.
60+
61+
The configure script creates an isolated Python `virtual environment` in your checkout directory, the Python `pip`
62+
tool, and installs the thirdparty libraries (from the `thirdparty/ directory`), setup the paths, etc.
63+
See https://virtualenv.pypa.io/en/latest/ for more. Run this command ::
64+
65+
source configure
66+
67+
On Windows use instead::
68+
69+
configure
70+
71+
When you create a new terminal/shell to work on ScanCode, either rerun the configure script or
72+
`source bin/activate` (or just run bin\actiavte on Windows)
73+
74+
75+
5. Now you can make your code changes in your local clone.
76+
Please create new unit tests for your code.
77+
78+
6. When you are done with your changes, run all the tests.
79+
Use this command::
80+
81+
py.test
82+
83+
Or use the -n6 option to run on 6 threads in parallel and run tests faster::
84+
85+
py.test -n6
86+
87+
7. Commit your changes and push your branch to your GitHub fork::
88+
89+
git add .
90+
git commit -m "Your detailed description of your changes."
91+
git push origin name-of-your-bugfix-or-feature
92+
93+
8. Submit a pull request through the GitHub website for this branch.
94+
95+
96+
Pull Request Guidelines
97+
-----------------------
98+
99+
If you need a code review or feedback while you are developing the code just
100+
create a pull request. You can add new commits to your branch as needed.
101+
102+
For merging, your request would need to:
103+
104+
1. Include unit tests that are passing (run ``py.test``).
105+
2. Update documentation as needed for new API, functionality etc.
106+
3. Add a note to ``CHANGELOG.rst`` about the changes.
107+
4. Add your name to ``AUTHORS.rst``.
108+
109+
110+
Test tips
111+
---------
112+
113+
To run a subset of test functions containing test_myfeature in their name use::
114+
115+
py.test -k test_myfeature
116+
117+
To run the tests from a single test file::
118+
119+
py.test tests/commoncode/test_fileutils.py
120+
121+
To run tests in parallel on 8 processes::
122+
123+
py.test -n 8
124+

‎MANIFEST.in

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
graft src
2+
graft tests
3+
4+
include AUTHORS.rst
5+
include CHANGELOG.rst
6+
include README.rst
7+
include CONTRIBUTING.rst
8+
include apache-2.0.LICENSE
9+
include cc0-1.0.LICENSE
10+
include NOTICE
11+
include scancode.ABOUT
12+
13+
include tox.ini .travis.yml appveyor.yml
14+
15+
global-exclude *.py[co] __pycache__

‎NOTICE

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
Software license
2+
================
3+
4+
Copyright (c) 2015 nexB Inc. and others. All rights reserved.
5+
http://nexb.com and https://github.com/nexB/scancode-toolkit/
6+
The ScanCode software is licensed under the Apache License version 2.0.
7+
Data generated with ScanCode require an acknowledgment.
8+
ScanCode is a trademark of nexB Inc.
9+
10+
You may not use this software except in compliance with the License.
11+
You may obtain a copy of the License at: http://apache.org/licenses/LICENSE-2.0
12+
Unless required by applicable law or agreed to in writing, software distributed
13+
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
14+
CONDITIONS OF ANY KIND, either express or implied. See the License for the
15+
specific language governing permissions and limitations under the License.
16+
17+
When you publish or redistribute any data created with ScanCode or any ScanCode
18+
derivative work, you must accompany this data with the following acknowledgment:
19+
20+
Generated with ScanCode and provided on an "AS IS" BASIS, WITHOUT WARRANTIES
21+
OR CONDITIONS OF ANY KIND, either express or implied. No content created from
22+
ScanCode should be considered or used as legal advice. Consult an Attorney
23+
for any legal advice.
24+
ScanCode is a free software code scanning tool from nexB Inc. and others.
25+
Visit https://github.com/nexB/scancode-toolkit/ for support and download.
26+
27+
28+
Third-party software licenses
29+
=============================
30+
31+
ScanCode embeds third-party free and open source software packages under various
32+
licenses including copyleft licenses. Some of the third-party software packages
33+
are delivered as pre-built binaries. The origin and license of these packages is
34+
documented by .ABOUT files.
35+
36+
The corresponding source code for pre-compiled third-party software is available
37+
for immediate download from the same release page where you obtained ScanCode at:
38+
https://github.com/nexB/scancode-toolkit/
39+
or https://github.com/nexB/scancode-thirdparty-src/
40+
41+
You may also contact us to request the source code by email at [email protected] or
42+
by postal mail at:
43+
nexB Inc., ScanCode open source code request
44+
735 Industrial Road, Suite #101, 94070 San Carlos, CA, USA
45+
Please indicate in your communication the ScanCode version for which you are
46+
requesting source code.
47+
48+
49+
License for ScanCode datasets
50+
=============================
51+
52+
ScanCode includes datasets (e.g. for license detection) that are dedicated
53+
to the Public Domain using the Creative Commons CC0 1.0 Universal (CC0 1.0)
54+
Public Domain Dedication: http://creativecommons.org/publicdomain/zero/1.0/

0 commit comments

Comments
 (0)