Skip to content

Commit 1d2be38

Browse files
gwichernkieranparsons
gwichern
authored and
kieranparsons
committed
Create release 1.0.0
1 parent 3903e4c commit 1d2be38

Some content is hidden

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

48 files changed

+3455
-0
lines changed

‎.gitattributes

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Copyright (C) 2024 Mitsubishi Electric Research Laboratories (MERL)
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
*.pth filter=lfs diff=lfs merge=lfs -text

‎.github/workflows/requirements-dev.txt

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Copyright (C) 2024 Mitsubishi Electric Research Laboratories (MERL)
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
pre-commit

‎.github/workflows/static_checks.yaml

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Copyright (C) 2024 Mitsubishi Electric Research Laboratories (MERL)
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
name: Static code checks
6+
7+
on: # yamllint disable-line rule:truthy
8+
pull_request:
9+
push:
10+
branches:
11+
- '**'
12+
tags-ignore:
13+
- '**'
14+
15+
env:
16+
LICENSE: Apache-2.0
17+
FETCH_DEPTH: 1
18+
FULL_HISTORY: 0
19+
SKIP_WORD_PRESENCE_CHECK: 0
20+
21+
jobs:
22+
static-code-check:
23+
if: endsWith(github.event.repository.name, 'private')
24+
25+
name: Run static code checks
26+
runs-on: ubuntu-latest
27+
defaults:
28+
run:
29+
shell: bash -l {0}
30+
31+
steps:
32+
- name: Setup history
33+
if: github.ref == 'refs/heads/oss'
34+
run: |
35+
echo "FETCH_DEPTH=0" >> $GITHUB_ENV
36+
echo "FULL_HISTORY=1" >> $GITHUB_ENV
37+
38+
- name: Setup version
39+
if: github.ref == 'refs/heads/melco'
40+
run: |
41+
echo "SKIP_WORD_PRESENCE_CHECK=1" >> $GITHUB_ENV
42+
43+
- name: Check out code
44+
uses: actions/checkout@v4
45+
with:
46+
fetch-depth: ${{ env.FETCH_DEPTH }} # '0' to check full history
47+
48+
- name: Set up environment
49+
run: git config user.email github-bot@merl.com
50+
51+
- name: Set up python
52+
uses: actions/setup-python@v5
53+
with:
54+
python-version: '3.10'
55+
cache: 'pip'
56+
cache-dependency-path: '.github/workflows/requirements-dev.txt'
57+
58+
- name: Install python packages
59+
run: pip install -r .github/workflows/requirements-dev.txt
60+
61+
- name: Ensure lint and pre-commit steps have been run
62+
uses: pre-commit/action@v3.0.1
63+
64+
- name: Check files
65+
uses: merl-oss-private/merl-file-check-action@v1
66+
with:
67+
license: ${{ env.LICENSE }}
68+
full-history: ${{ env.FULL_HISTORY }} # If true, use fetch-depth 0 above
69+
skip-word-presence-check: ${{ env.SKIP_WORD_PRESENCE_CHECK }}
70+
71+
- name: Check license compatibility
72+
if: github.ref != 'refs/heads/melco'
73+
uses: merl-oss-private/merl_license_compatibility_checker@v1
74+
with:
75+
input-filename: requirements.txt
76+
license: ${{ env.LICENSE }}

‎.gitignore

+168
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
# Copyright (C) 2024 Mitsubishi Electric Research Laboratories (MERL)
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
# Byte-compiled / optimized / DLL files
6+
__pycache__/
7+
*.py[cod]
8+
*$py.class
9+
10+
# C extensions
11+
*.so
12+
13+
# Distribution / packaging
14+
.Python
15+
build/
16+
develop-eggs/
17+
dist/
18+
downloads/
19+
eggs/
20+
.eggs/
21+
lib/
22+
lib64/
23+
parts/
24+
sdist/
25+
var/
26+
wheels/
27+
share/python-wheels/
28+
*.egg-info/
29+
.installed.cfg
30+
*.egg
31+
MANIFEST
32+
33+
# PyInstaller
34+
# Usually these files are written by a python script from a template
35+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
36+
*.manifest
37+
*.spec
38+
39+
# Installer logs
40+
pip-log.txt
41+
pip-delete-this-directory.txt
42+
43+
# Unit test / coverage reports
44+
htmlcov/
45+
.tox/
46+
.nox/
47+
.coverage
48+
.coverage.*
49+
.cache
50+
nosetests.xml
51+
coverage.xml
52+
*.cover
53+
*.py,cover
54+
.hypothesis/
55+
.pytest_cache/
56+
cover/
57+
58+
# Translations
59+
*.mo
60+
*.pot
61+
62+
# Django stuff:
63+
*.log
64+
local_settings.py
65+
db.sqlite3
66+
db.sqlite3-journal
67+
68+
# Flask stuff:
69+
instance/
70+
.webassets-cache
71+
72+
# Scrapy stuff:
73+
.scrapy
74+
75+
# Sphinx documentation
76+
docs/_build/
77+
78+
# PyBuilder
79+
.pybuilder/
80+
target/
81+
82+
# Jupyter Notebook
83+
.ipynb_checkpoints
84+
85+
# IPython
86+
profile_default/
87+
ipython_config.py
88+
89+
# pyenv
90+
# For a library or package, you might want to ignore these files since the code is
91+
# intended to run in multiple environments; otherwise, check them in:
92+
# .python-version
93+
94+
# pipenv
95+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
96+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
97+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
98+
# install all needed dependencies.
99+
#Pipfile.lock
100+
101+
# poetry
102+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
103+
# This is especially recommended for binary packages to ensure reproducibility, and is more
104+
# commonly ignored for libraries.
105+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
106+
#poetry.lock
107+
108+
# pdm
109+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
110+
#pdm.lock
111+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
112+
# in version control.
113+
# https://pdm.fming.dev/#use-with-ide
114+
.pdm.toml
115+
116+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
117+
__pypackages__/
118+
119+
# Celery stuff
120+
celerybeat-schedule
121+
celerybeat.pid
122+
123+
# SageMath parsed files
124+
*.sage.py
125+
126+
# Environments
127+
.env
128+
.venv
129+
env/
130+
venv/
131+
ENV/
132+
env.bak/
133+
venv.bak/
134+
135+
# Spyder project settings
136+
.spyderproject
137+
.spyproject
138+
139+
# Rope project settings
140+
.ropeproject
141+
142+
# mkdocs documentation
143+
/site
144+
145+
# mypy
146+
.mypy_cache/
147+
.dmypy.json
148+
dmypy.json
149+
150+
# Pyre type checker
151+
.pyre/
152+
153+
# pytype static type analyzer
154+
.pytype/
155+
156+
# Cython debug symbols
157+
cython_debug/
158+
159+
# PyCharm
160+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
161+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
162+
# and can be added to the global gitignore or merged into this file. For a more nuclear
163+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
164+
#.idea/
165+
166+
# Experiment
167+
*.ckpt
168+
*.wav

‎.pre-commit-config.yaml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Copyright (C) 2024 Mitsubishi Electric Research Laboratories (MERL)
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
#
5+
# Pre-commit configuration. See https://pre-commit.com
6+
7+
default_language_version:
8+
python: python3
9+
10+
repos:
11+
- repo: https://github.com/pre-commit/pre-commit-hooks
12+
rev: v4.4.0
13+
hooks:
14+
- id: end-of-file-fixer
15+
- id: trailing-whitespace
16+
- id: check-yaml
17+
- id: check-added-large-files
18+
args: ['--maxkb=5000']
19+
20+
- repo: https://gitlab.com/bmares/check-json5
21+
rev: v1.0.0
22+
hooks:
23+
- id: check-json5
24+
25+
- repo: https://github.com/homebysix/pre-commit-macadmin
26+
rev: v1.12.3
27+
hooks:
28+
- id: check-git-config-email
29+
args: ['--domains', 'merl.com']
30+
31+
- repo: https://github.com/psf/black
32+
rev: 22.12.0
33+
hooks:
34+
- id: black
35+
args:
36+
- --line-length=120
37+
38+
- repo: https://github.com/pycqa/isort
39+
rev: 5.12.0
40+
hooks:
41+
- id: isort
42+
args: ["--profile", "black", "--filter-files", "--line-length", "120", "--skip-gitignore"]
43+
44+
# Uncomment to use pyupgrade (https://github.com/asottile/pyupgrade) to automatically upgrade syntax for newer python
45+
# - repo: https://github.com/asottile/pyupgrade
46+
# rev: v3.3.1
47+
# hooks:
48+
# - id: pyupgrade
49+
50+
# To stop flake8 error from causing a failure, use --exit-zero. By default, pre-commit will not show the warnings,
51+
# so use verbose: true to see them.
52+
- repo: https://github.com/pycqa/flake8
53+
rev: 5.0.4
54+
hooks:
55+
- id: flake8
56+
# Black compatibility, Eradicate options
57+
args: ["--max-line-length=120", "--extend-ignore=E203",
58+
"--eradicate-whitelist-extend", "eradicate:\\s*no",
59+
"--exit-zero"]
60+
verbose: true
61+
additional_dependencies: [
62+
# https://github.com/myint/eradicate, https://github.com/wemake-services/flake8-eradicate
63+
"flake8-eradicate"
64+
]

‎.reuse/dep5

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2+
3+
Files: *.png
4+
Copyright: 2024 Mitsubishi Electric Research Laboratories (MERL)
5+
License: Apache-2.0
6+
7+
Files: *.pth
8+
Copyright: 2024 Mitsubishi Electric Research Laboratories (MERL)
9+
License: Apache-2.0

‎CONTRIBUTING.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!--
2+
Copyright (C) 2024 Mitsubishi Electric Research Laboratories (MERL)
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
-->
6+
# Contributing
7+
8+
Sorry, but we do not currently accept contributions in the form of pull requests to this repository.
9+
However, you are welcome to post issues (bug reports, feature requests, questions, etc).

0 commit comments

Comments
 (0)