generated from aboutcode-org/skeleton
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #116 from nexB/update-skeleton
Update skeleton
- Loading branch information
Showing
24 changed files
with
1,516 additions
and
716 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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.9] | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Set up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@v4 | ||
| 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 | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ | |
| *.py[cod] | ||
|
|
||
| # virtualenv and other misc bits | ||
| /src/*.egg-info | ||
| *.egg-info | ||
| /dist | ||
| /build | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| Contributor Covenant Code of Conduct | ||
| ==================================== | ||
|
|
||
| Our Pledge | ||
| ---------- | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to making participation in our | ||
| project and our community a harassment-free experience for everyone, | ||
| regardless of age, body size, disability, ethnicity, gender identity and | ||
| expression, level of experience, education, socio-economic status, | ||
| nationality, personal appearance, race, religion, or sexual identity and | ||
| orientation. | ||
|
|
||
| Our Standards | ||
| ------------- | ||
|
|
||
| Examples of behavior that contributes to creating a positive environment | ||
| include: | ||
|
|
||
| - Using welcoming and inclusive language | ||
| - Being respectful of differing viewpoints and experiences | ||
| - Gracefully accepting constructive criticism | ||
| - Focusing on what is best for the community | ||
| - Showing empathy towards other community members | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| - The use of sexualized language or imagery and unwelcome sexual | ||
| attention or advances | ||
| - Trolling, insulting/derogatory comments, and personal or political | ||
| attacks | ||
| - Public or private harassment | ||
| - Publishing others’ private information, such as a physical or | ||
| electronic address, without explicit permission | ||
| - Other conduct which could reasonably be considered inappropriate in a | ||
| professional setting | ||
|
|
||
| Our Responsibilities | ||
| -------------------- | ||
|
|
||
| Project maintainers are responsible for clarifying the standards of | ||
| acceptable behavior and are expected to take appropriate and fair | ||
| corrective action in response to any instances of unacceptable behavior. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, | ||
| or reject comments, commits, code, wiki edits, issues, and other | ||
| contributions that are not aligned to this Code of Conduct, or to ban | ||
| temporarily or permanently any contributor for other behaviors that they | ||
| deem inappropriate, threatening, offensive, or harmful. | ||
|
|
||
| Scope | ||
| ----- | ||
|
|
||
| This Code of Conduct applies both within project spaces and in public | ||
| spaces when an individual is representing the project or its community. | ||
| Examples of representing a project or community include using an | ||
| official project e-mail address, posting via an official social media | ||
| account, or acting as an appointed representative at an online or | ||
| offline event. Representation of a project may be further defined and | ||
| clarified by project maintainers. | ||
|
|
||
| Enforcement | ||
| ----------- | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may | ||
| be reported by contacting the project team at pombredanne@gmail.com | ||
| or on the Gitter chat channel at https://gitter.im/aboutcode-org/discuss . | ||
| All complaints will be reviewed and investigated and will result in a | ||
| response that is deemed necessary and appropriate to the circumstances. | ||
| The project team is obligated to maintain confidentiality with regard to | ||
| the reporter of an incident. Further details of specific enforcement | ||
| policies may be posted separately. | ||
|
|
||
| Project maintainers who do not follow or enforce the Code of Conduct in | ||
| good faith may face temporary or permanent repercussions as determined | ||
| by other members of the project’s leadership. | ||
|
|
||
| Attribution | ||
| ----------- | ||
|
|
||
| This Code of Conduct is adapted from the `Contributor Covenant`_ , | ||
| version 1.4, available at | ||
| https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
|
||
| .. _Contributor Covenant: https://www.contributor-covenant.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # | ||
| # Copyright (c) nexB Inc. and others. All rights reserved. | ||
| # ScanCode is a trademark of nexB Inc. | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # See http://www.apache.org/licenses/LICENSE-2.0 for the license text. | ||
| # See https://github.com/nexB/skeleton for support or download. | ||
| # See https://aboutcode.org for more information about nexB OSS projects. | ||
| # | ||
|
|
||
| # Python version can be specified with `$ PYTHON_EXE=python3.x make conf` | ||
| PYTHON_EXE?=python3 | ||
| VENV=venv | ||
| ACTIVATE?=. ${VENV}/bin/activate; | ||
|
|
||
| dev: | ||
| @echo "-> Configure the development envt." | ||
| ./configure --dev | ||
|
|
||
| isort: | ||
| @echo "-> Apply isort changes to ensure proper imports ordering" | ||
| ${VENV}/bin/isort --sl -l 100 src tests setup.py | ||
|
|
||
| black: | ||
| @echo "-> Apply black code formatter" | ||
| ${VENV}/bin/black -l 100 src tests setup.py | ||
|
|
||
| doc8: | ||
| @echo "-> Run doc8 validation" | ||
| @${ACTIVATE} doc8 --max-line-length 100 --ignore-path docs/_build/ --quiet docs/ | ||
|
|
||
| valid: isort black | ||
|
|
||
| check: | ||
| @echo "-> Run pycodestyle (PEP8) validation" | ||
| @${ACTIVATE} pycodestyle --max-line-length=100 --exclude=.eggs,venv,lib,thirdparty,docs,migrations,settings.py,.cache . | ||
| @echo "-> Run isort imports ordering validation" | ||
| @${ACTIVATE} isort --sl --check-only -l 100 setup.py src tests . | ||
| @echo "-> Run black validation" | ||
| @${ACTIVATE} black --check --check -l 100 src tests setup.py | ||
|
|
||
| clean: | ||
| @echo "-> Clean the Python env" | ||
| ./configure --clean | ||
|
|
||
| test: | ||
| @echo "-> Run the test suite" | ||
| ${VENV}/bin/pytest -vvs | ||
|
|
||
| docs: | ||
| rm -rf docs/_build/ | ||
| @${ACTIVATE} sphinx-build docs/ docs/_build/ | ||
|
|
||
| .PHONY: conf dev check valid black isort clean test docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.