-
Notifications
You must be signed in to change notification settings - Fork 18
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 #74 from nexB/latest-skeleton
Adopt latest skeleton
- Loading branch information
Showing
50 changed files
with
6,092 additions
and
327 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@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 | ||
|
|
||
|
|
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,27 @@ | ||
| name: Release library as a PyPI wheel and sdist on GH release creation | ||
|
|
||
| on: | ||
| release: | ||
| types: [created] | ||
|
|
||
| jobs: | ||
| build-and-publish-to-pypi: | ||
| name: Build and publish library to PyPI | ||
| runs-on: ubuntu-20.04 | ||
| steps: | ||
| - uses: actions/checkout@master | ||
| - name: Set up Python | ||
| uses: actions/setup-python@v1 | ||
| with: | ||
| python-version: 3.9 | ||
| - name: Install pypa/build | ||
| run: python -m pip install build --user | ||
| - name: Build a binary wheel and a source tarball | ||
| run: python -m build --sdist --wheel --outdir dist/ | ||
| . | ||
| - name: Publish distribution to PyPI | ||
| if: startsWith(github.ref, 'refs/tags') | ||
| uses: pypa/gh-action-pypi-publish@master | ||
| with: | ||
| password: ${{ secrets.PYPI_API_TOKEN }} | ||
|
|
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 |
|---|---|---|
| @@ -1,136 +1,73 @@ | ||
| # Byte-compiled / optimized / DLL files | ||
| __pycache__/ | ||
| # Python compiled files | ||
| *.py[cod] | ||
| *$py.class | ||
|
|
||
| # C extensions | ||
| *.so | ||
|
|
||
| # Distribution / packaging | ||
| # virtualenv and other misc bits | ||
| *.egg-info | ||
| /dist | ||
| /build | ||
| /bin | ||
| /lib | ||
| /scripts | ||
| /Scripts | ||
| /Lib | ||
| /pip-selfcheck.json | ||
| /tmp | ||
| /venv | ||
| .Python | ||
| build/ | ||
| develop-eggs/ | ||
| dist/ | ||
| downloads/ | ||
| eggs/ | ||
| .eggs/ | ||
| lib/ | ||
| lib64/ | ||
| parts/ | ||
| sdist/ | ||
| var/ | ||
| wheels/ | ||
| pip-wheel-metadata/ | ||
| share/python-wheels/ | ||
| *.egg-info/ | ||
| .installed.cfg | ||
| *.egg | ||
| MANIFEST | ||
|
|
||
| # PyInstaller | ||
| # Usually these files are written by a python script from a template | ||
| # before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
| *.manifest | ||
| *.spec | ||
| /include | ||
| /Include | ||
| /local | ||
| */local/* | ||
| /local/ | ||
| /share/ | ||
| /tcl/ | ||
| /.eggs/ | ||
|
|
||
| # Installer logs | ||
| pip-log.txt | ||
| pip-delete-this-directory.txt | ||
|
|
||
| # Unit test / coverage reports | ||
| htmlcov/ | ||
| .tox/ | ||
| .nox/ | ||
| .cache | ||
| .coverage | ||
| .coverage.* | ||
| .cache | ||
| nosetests.xml | ||
| coverage.xml | ||
| *.cover | ||
| *.py,cover | ||
| .hypothesis/ | ||
| .pytest_cache/ | ||
| cover/ | ||
| htmlcov | ||
|
|
||
| # Translations | ||
| *.mo | ||
| *.pot | ||
|
|
||
| # Django stuff: | ||
| *.log | ||
| local_settings.py | ||
| db.sqlite3 | ||
| db.sqlite3-journal | ||
|
|
||
| # Flask stuff: | ||
| instance/ | ||
| .webassets-cache | ||
|
|
||
| # Scrapy stuff: | ||
| .scrapy | ||
|
|
||
| # Sphinx documentation | ||
| docs/_build/ | ||
|
|
||
| # PyBuilder | ||
| target/ | ||
|
|
||
| # Jupyter Notebook | ||
| .ipynb_checkpoints | ||
|
|
||
| # IPython | ||
| profile_default/ | ||
| ipython_config.py | ||
| # 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 | ||
| # For a library or package, you might want to ignore these files since the code is | ||
| # intended to run in multiple environments; otherwise, check them in: | ||
| # .python-version | ||
|
|
||
| # pipenv | ||
| # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. | ||
| # However, in case of collaboration, if having platform-specific dependencies or dependencies | ||
| # having no cross-platform support, pipenv may install dependencies that don't work, or not | ||
| # install all needed dependencies. | ||
| #Pipfile.lock | ||
|
|
||
| # PEP 582; used by e.g. github.com/David-OConnor/pyflow | ||
| __pypackages__/ | ||
|
|
||
| # Celery stuff | ||
| celerybeat-schedule | ||
| celerybeat.pid | ||
|
|
||
| # SageMath parsed files | ||
| *.sage.py | ||
|
|
||
| # Environments | ||
| .env | ||
| .venv | ||
| env/ | ||
| venv/ | ||
| ENV/ | ||
| env.bak/ | ||
| venv.bak/ | ||
| tmp | ||
|
|
||
| # Spyder project settings | ||
| .spyderproject | ||
| .spyproject | ||
|
|
||
| # Rope project settings | ||
| .ropeproject | ||
|
|
||
| # mkdocs documentation | ||
| /site | ||
|
|
||
| # mypy | ||
| .mypy_cache/ | ||
| .dmypy.json | ||
| dmypy.json | ||
|
|
||
| # Pyre type checker | ||
| .pyre/ | ||
|
|
||
| # pytype static type analyzer | ||
| .pytype/ | ||
| /.python-version | ||
| /man/ | ||
| /.pytest_cache/ | ||
| lib64 | ||
| tcl | ||
|
|
||
| # Ignore Jupyter Notebook related temp files | ||
| .ipynb_checkpoints/ |
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 [email protected] | ||
| 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
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.