Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
150 commits
Select commit Hold shift + click to select a range
1562549
Initial commit
steven-esser Sep 22, 2020
85d1780
Add initial skeleton files
steven-esser Sep 22, 2020
aa71e06
Use pytest-xdist by default for threading support
steven-esser Sep 22, 2020
774dc7d
Add additional files
steven-esser Sep 23, 2020
9a56b88
Follow modern python packaging and conf practices
steven-esser Sep 25, 2020
565feee
Add some minimal documentation
steven-esser Sep 25, 2020
5febefb
Fix hanging tag chars in setup.cfg
steven-esser Sep 29, 2020
343ff29
Update README instructions with proper git merge conventions
steven-esser Sep 30, 2020
fa55f68
Add minimal .travis.yml CI config file
steven-esser Oct 16, 2020
3296b9f
Update setuptools_scm declaration
steven-esser Oct 22, 2020
ad02f4e
Merge pull request #1 from nexB/add-initial-skeleton-files
steven-esser Oct 22, 2020
083bd04
Add azure pipeline config files and templates
JonoYang Oct 26, 2020
847564e
Fix path to Scripts directory
JonoYang Oct 27, 2020
0f293cb
Install current project in configure.bat
JonoYang Oct 27, 2020
63f6946
Call pytest from proper location
JonoYang Oct 27, 2020
7fd2506
Use newer VM images on Azure
JonoYang Oct 27, 2020
bceb8f9
Add .gitattributes
JonoYang Oct 29, 2020
e772fe6
Clean template
JonoYang Nov 4, 2020
ae44984
Merge pull request #11 from nexB/add-ci-config
JonoYang Nov 4, 2020
5593c2f
Merge pull request #14 from nexB/develop
JonoYang Nov 5, 2020
629abed
Update .gitignore to ignore Jupyter temp files
AyanSinhaMahapatra Nov 5, 2020
6001c74
Merge pull request #15 from nexB/jupyter-patch
pombredanne Nov 5, 2020
ef210cd
Quick doc update
steven-esser Nov 16, 2020
0b6caf9
Add RTD docs configuration file
AyanSinhaMahapatra Dec 10, 2020
f2c1400
Add basic RTD documentaion #4
AyanSinhaMahapatra Dec 10, 2020
e7d1990
Add RTD requirements file and test scripts
AyanSinhaMahapatra Dec 10, 2020
7d37af0
Add `src` folder to pass CI tests and RTD builds
AyanSinhaMahapatra Dec 16, 2020
b6ef568
Merge pull request #16 from AyanSinhaMahapatra/add-basic-docs
steven-esser Dec 21, 2020
03ffc8a
Ensure we use official full text of Apache 2.0
pombredanne Jan 6, 2021
98d4d69
Merge pull request #18 from nexB/apache-license
steven-esser Jan 6, 2021
5e386d9
Never ever let Git convert line delimiters
pombredanne Jan 14, 2021
2e48dca
Run tests on more OSes and Python versions
pombredanne Jan 14, 2021
b959539
Do not make wheel universal
pombredanne Jan 14, 2021
98641a0
Format and add license
pombredanne Jan 14, 2021
9fa3f31
Format
pombredanne Jan 14, 2021
0b8cd65
Improve documentation
pombredanne Jan 14, 2021
3007691
Format for spaces
pombredanne Jan 14, 2021
b49895c
Add manifest for source distributions
pombredanne Jan 14, 2021
d3e2d28
Add Apache license NOTICE
pombredanne Jan 14, 2021
a2a1901
Merge pull request #19 from nexB/update-boilerplate
steven-esser Jan 19, 2021
f46bc48
Default to 64 bits windows on CI
pombredanne Jan 24, 2021
182532f
Use wheels embedded in virtualenv.pyz
pombredanne Jan 25, 2021
cd4e87b
Do not force an upgrade on virtualenv.pyz embeds
pombredanne Jan 25, 2021
51510cb
Fix .gitattributes
steven-esser Feb 11, 2021
386bb90
Merge pull request #21 from nexB/fix-gitattributes
steven-esser Feb 12, 2021
1c84e9e
Merge pull request #24 from nexB/use-venv-embeds
pombredanne May 7, 2021
d6fe59f
Update markers syntax for pytest
pombredanne May 7, 2021
ca6ab21
Add fallback version for setuptools_scm
pombredanne May 7, 2021
1364bbb
Add note for setuptools_scam fallback version
pombredanne May 11, 2021
be851b0
Use azure-posix.yml for linux and macOS
pombredanne May 11, 2021
4f0aecf
Adopt new configure script derived from ScanCode
pombredanne May 11, 2021
aa04429
Add notes on customization
pombredanne May 11, 2021
56ada8f
Adopt new configure --dev convention
pombredanne May 11, 2021
0dbcdc9
Clarify CHANGELOG to be Rst
pombredanne May 11, 2021
d21aef3
Add skeleton release notes to README.rst
pombredanne May 11, 2021
a75737d
Merge pull request #25 from nexB/new-configure
pombredanne May 12, 2021
3aeb2ec
Update format
pombredanne May 31, 2021
2c412e8
Add Python 3.9 to Travis
pombredanne May 31, 2021
69eec23
Format and remove spurious spaces
pombredanne May 31, 2021
0e09ad9
Bump to more modern version of setuptools_scm
pombredanne May 31, 2021
e339a70
Add space for correct syntax
pombredanne May 31, 2021
9dff54a
Create junction from Scripts to bin
chinyeungli Jun 17, 2021
b735a3f
Merge pull request #26 from nexB/windows-junction
pombredanne Jun 17, 2021
77ce5e4
Check for deps in local thirdparty directory #31
JonoYang Aug 31, 2021
fa13562
Merge pull request #32 from nexB/install-from-thirdparty-dir
JonoYang Aug 31, 2021
1bcaaa5
Enforce use of requirements.txt #34
JonoYang Sep 1, 2021
e9067c8
Add scripts from scancode-toolkit/etc/release/ #33
JonoYang Sep 2, 2021
0e1f56b
Normalize license in load_pkginfo_data #33
JonoYang Sep 2, 2021
288532d
Add --init option to configure #33
JonoYang Sep 2, 2021
a5ae4f3
Update README.rst #33
JonoYang Sep 2, 2021
593e237
Use venv as virtual environment directory name #37
JonoYang Sep 3, 2021
9342bc1
Update configure.bat #33
JonoYang Sep 3, 2021
45e4a2a
Add placeholder requirements.txt files #33
JonoYang Sep 3, 2021
944fbae
Handle multiple options in configure #33
JonoYang Sep 3, 2021
3532b22
Fix path to aboutcode in utils_thirdparty.py #33
JonoYang Sep 4, 2021
9c78ddb
Update release notes in README.rst
JonoYang Sep 4, 2021
ebcfb93
Handle ExpressionParseError #33
JonoYang Sep 4, 2021
6ab9c10
Update README.rst
pombredanne Sep 7, 2021
bfdc6ff
Address review comments #33
JonoYang Sep 7, 2021
8583d7f
Merge pull request #39 from nexB/update-skeleton
JonoYang Sep 8, 2021
71d8dad
Update READMEs
JonoYang Sep 8, 2021
d3b8524
Merge pull request #40 from nexB/add-scripts-readme
JonoYang Sep 8, 2021
d2bafb9
Fixed #41 - Handled encoding issue when generating ABOUT files
chinyeungli Sep 15, 2021
c41196a
Merge pull request #42 from nexB/41_fix_encoding_error
chinyeungli Oct 4, 2021
5671563
Treat text files as text
pombredanne Oct 5, 2021
14f6a2d
Add helper to publish files in GH releases
pombredanne Oct 5, 2021
1a2a144
Add code to use curl if wget is not installed
chinyeungli Oct 6, 2021
7aa7d4c
Do not issue warning if thirdparty dir is missing
pombredanne Oct 8, 2021
51d0c5c
Merge pull request #45 from nexB/open-as-text
pombredanne Oct 11, 2021
b46d84f
Handle as_text correctly in cache
pombredanne Oct 11, 2021
255a898
Handle as_text correctly in cache
pombredanne Oct 11, 2021
7b76f4a
Merge origin/as_text-cache
pombredanne Oct 15, 2021
3a5307c
Merge pull request #47 from nexB/as_text-cache
pombredanne Oct 15, 2021
e5833d1
Add support for Python 3.10
pombredanne Oct 18, 2021
0a0ef12
Adopt black style
pombredanne Oct 29, 2021
31ed446
Drop Ubuntu 16 add Python 3.10
pombredanne Oct 29, 2021
00aaa26
Merge pull request #48 from nexB/update-system
pombredanne Oct 29, 2021
2ce7c7a
Disable Python 3.10 tests on macOS 10.14
pombredanne Oct 29, 2021
1fa3699
Merge pull request #49 from nexB/update-system
pombredanne Oct 29, 2021
2cc2c5a
Add code to remove the symlink before creating
chinyeungli Nov 10, 2021
6b2320a
Improve handling licenses without scancode
pombredanne Nov 26, 2021
6ccff2b
Add support for deb and rpm containers
pombredanne Nov 26, 2021
6962f8b
Support licenses when ScanCode is not installed
pombredanne Nov 26, 2021
2f77f97
Improve wheel build
pombredanne Jan 12, 2022
784e701
Aligne with latest ScanCode TK updates
pombredanne Jan 12, 2022
a7c2efd
Do not ignore setup.py
pombredanne Jan 12, 2022
b1dabd8
Update scripts
pombredanne Jan 12, 2022
4004ebe
Do not use pytest 7.0.0 which is buggy
pombredanne Feb 14, 2022
b15b6b7
Update `configure` to work with space in installation path
chinyeungli Feb 17, 2022
311b0a1
Remove echo statement
chinyeungli Feb 17, 2022
840ccef
Add black codestyle test for skeleton
keshav-space Feb 22, 2022
35af643
Update configure.bat
chinyeungli Feb 23, 2022
70a2d2f
Merge pull request #55 from nexB/configure_for_path_with_spaces_on_wi…
pombredanne Feb 23, 2022
c7084ee
Merge pull request #56 from keshav-space/main
pombredanne Feb 23, 2022
9558c0c
Deprecate windows-2016 images for azure CI
AyanSinhaMahapatra Feb 23, 2022
e19a520
Remove macos 10.14 job from azure-pipelines.yml
JonoYang Mar 1, 2022
cb17d70
Merge pull request #57 from nexB/deprecate-win-2016-ci
JonoYang Mar 1, 2022
7eb4ca8
Merge pull request #58 from nexB/remove-mac-1014
JonoYang Mar 1, 2022
47da14b
Do not use Python 3.6 on Windows 2022 jobs
JonoYang Mar 1, 2022
c4678dc
Merge pull request #59 from nexB/win2022-py36
JonoYang Mar 1, 2022
ad17a42
Deprecate windows-2016 images for azure CI
AyanSinhaMahapatra Feb 23, 2022
cad3164
Remove macos 10.14 job from azure-pipelines.yml
JonoYang Mar 1, 2022
d659e09
Do not use Python 3.6 on Windows 2022 jobs
JonoYang Mar 1, 2022
b408c85
Merge pull request #60 from nexB/update-signoff
pombredanne Mar 4, 2022
c5251f4
Run tests on macOS 11
pombredanne Mar 4, 2022
a118fe7
Align configuration scripts on POSIX and Windows
pombredanne Mar 4, 2022
e810da3
Update README
pombredanne Mar 4, 2022
243f7cb
Refactor and streamline thirdparty utilities
pombredanne Mar 5, 2022
931f610
Cleanup whitespaces
pombredanne Mar 5, 2022
6e43a7a
Add usage instructions to README.rst
JonoYang Mar 9, 2022
ae73ce3
Merge pull request #61 from nexB/update-readme
JonoYang Mar 9, 2022
6238b83
Merge branch 'main' of https://github.com/nexB/skeleton into main
pombredanne Mar 9, 2022
b272e3b
Format code
pombredanne Mar 9, 2022
907e540
Merge pull request #62 from nexB/better-tpp-scripts
pombredanne Mar 9, 2022
1e4d3bc
Reorg setup sections
pombredanne Mar 9, 2022
03d4799
Do not depend on click. Use argparse.
pombredanne Mar 9, 2022
f0d5a29
Correct configure scripts
pombredanne Mar 9, 2022
6ed9983
Remove remnants of configure --init
pombredanne Mar 9, 2022
bf6bbaa
Pytyon 3.6 is not available on Windows 2022
pombredanne Mar 11, 2022
4ab834f
Add long_description_content_type
pombredanne Mar 11, 2022
4ef463f
Run fewer Azure jobs
pombredanne Mar 14, 2022
e921052
Add RTD css templates
AyanSinhaMahapatra Mar 22, 2022
bd2df2a
Add GitHub action for doc build tests
AyanSinhaMahapatra Mar 24, 2022
3e2d801
Fix conf.py to fix doc build
AyanSinhaMahapatra Mar 24, 2022
c76dff4
Merge pull request #63 from nexB/add-rtd-templates
AyanSinhaMahapatra Mar 24, 2022
eb57889
Add docs option in configure
AyanSinhaMahapatra Mar 24, 2022
2841270
Merge pull request #64 from nexB/add-docs-in-configure
AyanSinhaMahapatra Mar 29, 2022
66895b9
Merge remote-tracking branch 'skeleton/main' into add-skeleton
AyanSinhaMahapatra Mar 30, 2022
6a2c253
CLean up docs
AyanSinhaMahapatra Mar 30, 2022
757edd5
Update README.md
AyanSinhaMahapatra Mar 30, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ignore all Git auto CR/LF line endings conversions
* -text
pyproject.toml export-subst
37 changes: 37 additions & 0 deletions .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: CI Documentation

on: [push, pull_request]

jobs:
build:
runs-on: ubuntu-20.04

strategy:
max-parallel: 4
matrix:
python-version: [3.7]

steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}

- name: Give permission to run scripts
run: chmod +x ./docs/scripts/doc8_style_check.sh

- name: Install Dependencies
run: pip install -e .[docs]

- name: Check Sphinx Documentation build minimally
working-directory: ./docs
run: sphinx-build -E -W source build

- name: Check for documentation style errors
working-directory: ./docs
run: ./scripts/doc8_style_check.sh


95 changes: 64 additions & 31 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,40 +1,73 @@
*.pyc
*.db
.installed.cfg
parts
develop-eggs
bin
eggs
downloads
lib
lib64
build
.project
.pydevproject
include
.settings
TAGS
.idea
Include
Lib
.env
Procfile
tmp
.Python
local.cfg
_build
pip-selfcheck.json
pyvenv.cfg
geckodriver.log
.DS_Store
# Python compiled files
*.py[cod]

# virtualenv and other misc bits
.venv/
*.egg-info
/dist
/build
build/
/bin
/lib
/scripts
/Scripts
/Lib
/pip-selfcheck.json
/tmp
/venv
.Python
/include
/Include
/local
*/local/*
/local/
/share/
/tcl/
/.eggs/

# Installer logs
pip-log.txt

# Unit test / coverage reports
.cache
.coverage
.coverage.*
nosetests.xml
htmlcov

# Translations
*.mo

# IDEs
.project
.pydevproject
.idea
org.eclipse.core.resources.prefs
.vscode
.vs

# Sphinx
docs/_build
docs/bin
docs/build
docs/include
docs/Lib
doc/pyvenv.cfg
pyvenv.cfg

# Various junk and temp files
.DS_Store
*~
.*.sw[po]
.build
.ve
*.bak
/.cache/

# pyenv
/.python-version
/man/
/.pytest_cache/
lib64
tcl

# Ignore Jupyter Notebook related temp files
.ipynb_checkpoints/
18 changes: 18 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Where the Sphinx conf.py file is located
sphinx:
configuration: docs/source/conf.py

# Setting the python version and doc build requirements
python:
install:
- method: pip
path: .
extra_requirements:
- docs
14 changes: 0 additions & 14 deletions .travis.yml

This file was deleted.

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

include *.LICENSE
include NOTICE
include *.ABOUT
include *.toml
include *.yml
include *.rst
include setup.*
include configure*
include requirements*
include .git*

global-exclude *.py[co] __pycache__ *.*~

19 changes: 19 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#
# Copyright (c) nexB Inc. and others.
# SPDX-License-Identifier: Apache-2.0
#
# Visit https://aboutcode.org and https://github.com/nexB/ for support and download.
# ScanCode is a trademark of nexB Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.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.
#
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ These are important questions when there are millions of free and open source so

### Documentation Build Status

[![Build Status](https://travis-ci.org/nexB/aboutcode.svg?branch=master)](https://travis-ci.org/nexB/aboutcode)
![Doc Build](https://github.com/nexB/aboutcode/actions/workflows/docs-ci.yml/badge.svg)

### Important Links

Expand All @@ -30,6 +30,11 @@ AboutCode Documentation Group Email Addresses:

If you want to get in touch with the team with issues other than documentation, head to the gitter channel [here](https://gitter.im/aboutcode-org/discuss).

Look at our [wiki](https://github.com/nexB/aboutcode/wiki) for information about our participation
in the GSoC and GSoD programs.

We have a weekly meeting, see more details [here](https://github.com/nexB/aboutcode/wiki/MeetingMinutes).

### Projects

Each AboutCode project has its own repository:
Expand All @@ -39,6 +44,8 @@ Each AboutCode project has its own repository:
- **[Scancode.io](https://github.com/nexB/scancode.io)**: a web-based and
API to run and review scans in rich scripted ScanPipe pipelines.

- **[VulnerableCode](https://github.com/nexB/vulnerablecode)**: an emerging server-side application to collect and track known package vulnerabilities.

- **[Scancode Workbench](https://github.com/nexB/scancode-workbench)**: a desktop application (based on Electron) to review the results of a scan and document your conclusions about the origin and license of software components and packages.

- **[AboutCode Toolkit](https://github.com/nexB/aboutcode-toolkit)**: a set of command line tools to document the provenance of your code and generate attribution notices. AboutCode Toolkit uses small yaml files to document code provenance inside a codebase. The lead maintainer is @chinyeungli
Expand All @@ -54,8 +61,6 @@ API to run and review scans in rich scripted ScanPipe pipelines.
- **[DeltaCode](https://github.com/nexB/deltacode)**: a command line tool to compare scans and determine if and where there are material
differences that affect licensing.

- **[VulnerableCode](https://github.com/nexB/vulnerablecode)**: an emerging server-side application to collect and track known package vulnerabilities.


We also co-started and work closely with other FOSS orgs and projects:

Expand Down
Loading