Skip to content

Commit 0d5d40b

Browse files
pombredannepombredanne
authored
Merge pull request #74 from nexB/latest-skeleton
Adopt latest skeleton
2 parents 5eab0dc + b11a5ed commit 0d5d40b

Some content is hidden

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

50 files changed

+6092
-327
lines changed

‎.github/workflows/docs-ci.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: CI Documentation
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-20.04
8+
9+
strategy:
10+
max-parallel: 4
11+
matrix:
12+
python-version: [3.9]
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v2
17+
18+
- name: Set up Python ${{ matrix.python-version }}
19+
uses: actions/setup-python@v2
20+
with:
21+
python-version: ${{ matrix.python-version }}
22+
23+
- name: Give permission to run scripts
24+
run: chmod +x ./docs/scripts/doc8_style_check.sh
25+
26+
- name: Install Dependencies
27+
run: pip install -e .[docs]
28+
29+
- name: Check Sphinx Documentation build minimally
30+
working-directory: ./docs
31+
run: sphinx-build -E -W source build
32+
33+
- name: Check for documentation style errors
34+
working-directory: ./docs
35+
run: ./scripts/doc8_style_check.sh
36+
37+

‎.github/workflows/pypi-release.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Release library as a PyPI wheel and sdist on GH release creation
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
jobs:
8+
build-and-publish-to-pypi:
9+
name: Build and publish library to PyPI
10+
runs-on: ubuntu-20.04
11+
steps:
12+
- uses: actions/checkout@master
13+
- name: Set up Python
14+
uses: actions/setup-python@v1
15+
with:
16+
python-version: 3.9
17+
- name: Install pypa/build
18+
run: python -m pip install build --user
19+
- name: Build a binary wheel and a source tarball
20+
run: python -m build --sdist --wheel --outdir dist/
21+
.
22+
- name: Publish distribution to PyPI
23+
if: startsWith(github.ref, 'refs/tags')
24+
uses: pypa/gh-action-pypi-publish@master
25+
with:
26+
password: ${{ secrets.PYPI_API_TOKEN }}
27+

‎.gitignore

+56-119
Original file line numberDiff line numberDiff line change
@@ -1,136 +1,73 @@
1-
# Byte-compiled / optimized / DLL files
2-
__pycache__/
1+
# Python compiled files
32
*.py[cod]
4-
*$py.class
53

6-
# C extensions
7-
*.so
8-
9-
# Distribution / packaging
4+
# virtualenv and other misc bits
5+
*.egg-info
6+
/dist
7+
/build
8+
/bin
9+
/lib
10+
/scripts
11+
/Scripts
12+
/Lib
13+
/pip-selfcheck.json
14+
/tmp
15+
/venv
1016
.Python
11-
build/
12-
develop-eggs/
13-
dist/
14-
downloads/
15-
eggs/
16-
.eggs/
17-
lib/
18-
lib64/
19-
parts/
20-
sdist/
21-
var/
22-
wheels/
23-
pip-wheel-metadata/
24-
share/python-wheels/
25-
*.egg-info/
26-
.installed.cfg
27-
*.egg
28-
MANIFEST
29-
30-
# PyInstaller
31-
# Usually these files are written by a python script from a template
32-
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33-
*.manifest
34-
*.spec
17+
/include
18+
/Include
19+
/local
20+
*/local/*
21+
/local/
22+
/share/
23+
/tcl/
24+
/.eggs/
3525

3626
# Installer logs
3727
pip-log.txt
38-
pip-delete-this-directory.txt
3928

4029
# Unit test / coverage reports
41-
htmlcov/
42-
.tox/
43-
.nox/
30+
.cache
4431
.coverage
4532
.coverage.*
46-
.cache
4733
nosetests.xml
48-
coverage.xml
49-
*.cover
50-
*.py,cover
51-
.hypothesis/
52-
.pytest_cache/
53-
cover/
34+
htmlcov
5435

5536
# Translations
5637
*.mo
57-
*.pot
58-
59-
# Django stuff:
60-
*.log
61-
local_settings.py
62-
db.sqlite3
63-
db.sqlite3-journal
64-
65-
# Flask stuff:
66-
instance/
67-
.webassets-cache
6838

69-
# Scrapy stuff:
70-
.scrapy
71-
72-
# Sphinx documentation
73-
docs/_build/
74-
75-
# PyBuilder
76-
target/
77-
78-
# Jupyter Notebook
79-
.ipynb_checkpoints
80-
81-
# IPython
82-
profile_default/
83-
ipython_config.py
39+
# IDEs
40+
.project
41+
.pydevproject
42+
.idea
43+
org.eclipse.core.resources.prefs
44+
.vscode
45+
.vs
46+
47+
# Sphinx
48+
docs/_build
49+
docs/bin
50+
docs/build
51+
docs/include
52+
docs/Lib
53+
doc/pyvenv.cfg
54+
pyvenv.cfg
55+
56+
# Various junk and temp files
57+
.DS_Store
58+
*~
59+
.*.sw[po]
60+
.build
61+
.ve
62+
*.bak
63+
/.cache/
8464

8565
# pyenv
86-
# For a library or package, you might want to ignore these files since the code is
87-
# intended to run in multiple environments; otherwise, check them in:
88-
# .python-version
89-
90-
# pipenv
91-
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92-
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93-
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94-
# install all needed dependencies.
95-
#Pipfile.lock
96-
97-
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
98-
__pypackages__/
99-
100-
# Celery stuff
101-
celerybeat-schedule
102-
celerybeat.pid
103-
104-
# SageMath parsed files
105-
*.sage.py
106-
107-
# Environments
108-
.env
109-
.venv
110-
env/
111-
venv/
112-
ENV/
113-
env.bak/
114-
venv.bak/
115-
tmp
116-
117-
# Spyder project settings
118-
.spyderproject
119-
.spyproject
120-
121-
# Rope project settings
122-
.ropeproject
123-
124-
# mkdocs documentation
125-
/site
126-
127-
# mypy
128-
.mypy_cache/
129-
.dmypy.json
130-
dmypy.json
131-
132-
# Pyre type checker
133-
.pyre/
134-
135-
# pytype static type analyzer
136-
.pytype/
66+
/.python-version
67+
/man/
68+
/.pytest_cache/
69+
lib64
70+
tcl
71+
72+
# Ignore Jupyter Notebook related temp files
73+
.ipynb_checkpoints/

‎CODE_OF_CONDUCT.rst

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
Contributor Covenant Code of Conduct
2+
====================================
3+
4+
Our Pledge
5+
----------
6+
7+
In the interest of fostering an open and welcoming environment, we as
8+
contributors and maintainers pledge to making participation in our
9+
project and our community a harassment-free experience for everyone,
10+
regardless of age, body size, disability, ethnicity, gender identity and
11+
expression, level of experience, education, socio-economic status,
12+
nationality, personal appearance, race, religion, or sexual identity and
13+
orientation.
14+
15+
Our Standards
16+
-------------
17+
18+
Examples of behavior that contributes to creating a positive environment
19+
include:
20+
21+
- Using welcoming and inclusive language
22+
- Being respectful of differing viewpoints and experiences
23+
- Gracefully accepting constructive criticism
24+
- Focusing on what is best for the community
25+
- Showing empathy towards other community members
26+
27+
Examples of unacceptable behavior by participants include:
28+
29+
- The use of sexualized language or imagery and unwelcome sexual
30+
attention or advances
31+
- Trolling, insulting/derogatory comments, and personal or political
32+
attacks
33+
- Public or private harassment
34+
- Publishing others’ private information, such as a physical or
35+
electronic address, without explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
Our Responsibilities
40+
--------------------
41+
42+
Project maintainers are responsible for clarifying the standards of
43+
acceptable behavior and are expected to take appropriate and fair
44+
corrective action in response to any instances of unacceptable behavior.
45+
46+
Project maintainers have the right and responsibility to remove, edit,
47+
or reject comments, commits, code, wiki edits, issues, and other
48+
contributions that are not aligned to this Code of Conduct, or to ban
49+
temporarily or permanently any contributor for other behaviors that they
50+
deem inappropriate, threatening, offensive, or harmful.
51+
52+
Scope
53+
-----
54+
55+
This Code of Conduct applies both within project spaces and in public
56+
spaces when an individual is representing the project or its community.
57+
Examples of representing a project or community include using an
58+
official project e-mail address, posting via an official social media
59+
account, or acting as an appointed representative at an online or
60+
offline event. Representation of a project may be further defined and
61+
clarified by project maintainers.
62+
63+
Enforcement
64+
-----------
65+
66+
Instances of abusive, harassing, or otherwise unacceptable behavior may
67+
be reported by contacting the project team at [email protected]
68+
or on the Gitter chat channel at https://gitter.im/aboutcode-org/discuss .
69+
All complaints will be reviewed and investigated and will result in a
70+
response that is deemed necessary and appropriate to the circumstances.
71+
The project team is obligated to maintain confidentiality with regard to
72+
the reporter of an incident. Further details of specific enforcement
73+
policies may be posted separately.
74+
75+
Project maintainers who do not follow or enforce the Code of Conduct in
76+
good faith may face temporary or permanent repercussions as determined
77+
by other members of the project’s leadership.
78+
79+
Attribution
80+
-----------
81+
82+
This Code of Conduct is adapted from the `Contributor Covenant`_ ,
83+
version 1.4, available at
84+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
85+
86+
.. _Contributor Covenant: https://www.contributor-covenant.org

‎MANIFEST.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ include *.rst
99
include setup.*
1010
include configure*
1111
include requirements*
12-
include .git*
12+
include .giti*
1313

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

‎README.rst

-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@ Fetch some package metadata and get a ``fetchcode.packagedcode_models.Package``
6060
[Package(type='rubygems', namespace=None, name='files', version=None)]
6161

6262

63-
6463
License
6564
--------
6665

0 commit comments

Comments
 (0)