Skip to content

Commit bf34891

Browse files
jasongroutjasongrout
committed
Initial cookiecutter generation.
From https://github.com/jupyter-widgets/widget-ts-cookiecutter, commit 2720f2b1ce1daafab29dfac5982380618a1a6877 with parameters: author_name []: Project Jupyter Contributors author_email []: [email protected] github_project_name []: midicontrols github_organization_name []: jupyter-widgets python_package_name [midicontrols]: ipymidicontrols npm_package_name [midicontrols]: @jupyter-widgets/midicontrols npm_package_version [0.1.0]: project_short_description [A Custom Jupyter Widget Library]: A Jupyter widget for interfacing with MIDI controllers.
0 parents  commit bf34891

Some content is hidden

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

49 files changed

+2452
-0
lines changed

‎.coveragerc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[run]
2+
omit = ipymidicontrols/tests/*

‎.gitignore

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
env/
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
*.egg-info/
24+
.installed.cfg
25+
*.egg
26+
27+
# PyInstaller
28+
# Usually these files are written by a python script from a template
29+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
30+
*.manifest
31+
*.spec
32+
33+
# Installer logs
34+
pip-log.txt
35+
pip-delete-this-directory.txt
36+
37+
# Unit test / coverage reports
38+
htmlcov/
39+
.tox/
40+
.coverage
41+
.coverage.*
42+
.cache
43+
nosetests.xml
44+
coverage.xml
45+
*,cover
46+
.hypothesis/
47+
48+
# Translations
49+
*.mo
50+
*.pot
51+
52+
# Django stuff:
53+
*.log
54+
local_settings.py
55+
56+
# Flask instance folder
57+
instance/
58+
59+
# Scrapy stuff:
60+
.scrapy
61+
62+
# Sphinx documentation
63+
docs/_build/
64+
docs/source/_static/embed-bundle.js
65+
docs/source/_static/embed-bundle.js.map
66+
67+
# PyBuilder
68+
target/
69+
70+
# IPython Notebook
71+
.ipynb_checkpoints
72+
73+
# pyenv
74+
.python-version
75+
76+
# celery beat schedule file
77+
celerybeat-schedule
78+
79+
# dotenv
80+
.env
81+
82+
# virtualenv
83+
venv/
84+
ENV/
85+
86+
# Spyder project settings
87+
.spyderproject
88+
89+
# Rope project settings
90+
.ropeproject
91+
92+
# =========================
93+
# Operating System Files
94+
# =========================
95+
96+
# OSX
97+
# =========================
98+
99+
.DS_Store
100+
.AppleDouble
101+
.LSOverride
102+
103+
# Thumbnails
104+
._*
105+
106+
# Files that might appear in the root of a volume
107+
.DocumentRevisions-V100
108+
.fseventsd
109+
.Spotlight-V100
110+
.TemporaryItems
111+
.Trashes
112+
.VolumeIcon.icns
113+
114+
# Directories potentially created on remote AFP share
115+
.AppleDB
116+
.AppleDesktop
117+
Network Trash Folder
118+
Temporary Items
119+
.apdisk
120+
121+
# Windows
122+
# =========================
123+
124+
# Windows image file caches
125+
Thumbs.db
126+
ehthumbs.db
127+
128+
# Folder config file
129+
Desktop.ini
130+
131+
# Recycle Bin used on file shares
132+
$RECYCLE.BIN/
133+
134+
# Windows Installer files
135+
*.cab
136+
*.msi
137+
*.msm
138+
*.msp
139+
140+
# Windows shortcuts
141+
*.lnk
142+
143+
144+
# NPM
145+
# ----
146+
147+
**/node_modules/
148+
ipymidicontrols/nbextension/static/index.*
149+
ipymidicontrols/labextension/*.tgz
150+
151+
# Coverage data
152+
# -------------
153+
**/coverage/
154+
155+
# Packed lab extensions
156+
ipymidicontrols/labextension

‎.npmignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.DS_Store
2+
node_modules/
3+
tests/
4+
.jshintrc
5+
# Ignore any build output from python:
6+
dist/*.tar.gz
7+
dist/*.wheel

‎.travis.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
language: python
2+
python:
3+
- 3.6
4+
- 3.5
5+
- 3.4
6+
sudo: false
7+
addons:
8+
apt_packages:
9+
- pandoc
10+
env:
11+
matrix:
12+
- GROUP=python
13+
matrix:
14+
include:
15+
- python: 3.5
16+
env: GROUP=js
17+
include:
18+
- python: 3.6
19+
env: GROUP=docs
20+
cache:
21+
pip: true
22+
directories:
23+
- node_modules # NPM packages
24+
- $HOME/.npm
25+
before_install:
26+
- pip install -U pip setuptools
27+
- nvm install 8
28+
- |
29+
if [[ $GROUP == python ]]; then
30+
pip install codecov
31+
elif [[ $GROUP == js ]]; then
32+
npm install -g codecov
33+
fi
34+
install:
35+
- |
36+
if [[ $GROUP == python ]]; then
37+
pip install --upgrade ".[test]" -v
38+
elif [[ $GROUP == js ]]; then
39+
pip install --upgrade -e ".[test]" -v
40+
elif [[ $GROUP == docs ]]; then
41+
pip install --upgrade ".[test, examples, docs]" -v
42+
fi
43+
before_script:
44+
# Set up a virtual screen for Firefox browser testing:
45+
- |
46+
if [[ $GROUP == js ]]; then
47+
export CHROME_BIN=chromium-browser
48+
export DISPLAY=:99.0
49+
sh -e /etc/init.d/xvfb start
50+
fi
51+
git config --global user.email [email protected]
52+
git config --global user.name "Travis CI"
53+
script:
54+
- |
55+
if [[ $GROUP == python ]]; then
56+
EXIT_STATUS=0
57+
pushd $(mktemp -d)
58+
py.test -l --cov-report xml:$TRAVIS_BUILD_DIR/coverage.xml --cov=ipymidicontrols --pyargs ipymidicontrols || EXIT_STATUS=$?
59+
popd
60+
(exit $EXIT_STATUS)
61+
elif [[ $GROUP == js ]]; then
62+
npm test
63+
elif [[ $GROUP == docs ]]; then
64+
EXIT_STATUS=0
65+
cd docs
66+
make html || EXIT_STATUS=$?
67+
make linkcheck || EXIT_STATUS=$?
68+
cd ..
69+
python -m pytest_check_links --links-ext=.md -o testpaths=. -o addopts= || EXIT_STATUS=$?
70+
(exit $EXIT_STATUS)
71+
fi
72+
after_success:
73+
- codecov

‎LICENSE.txt

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Copyright (c) 2018 Project Jupyter Contributors
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without
5+
modification, are permitted provided that the following conditions are met:
6+
7+
1. Redistributions of source code must retain the above copyright notice, this
8+
list of conditions and the following disclaimer.
9+
10+
2. Redistributions in binary form must reproduce the above copyright notice,
11+
this list of conditions and the following disclaimer in the documentation
12+
and/or other materials provided with the distribution.
13+
14+
3. Neither the name of the copyright holder nor the names of its
15+
contributors may be used to endorse or promote products derived from
16+
this software without specific prior written permission.
17+
18+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎MANIFEST.in

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
include LICENSE.txt
2+
include README.md
3+
4+
include setupbase.py
5+
include pytest.ini
6+
include .coverage.rc
7+
8+
include package.json
9+
include webpack.config.js
10+
include ipymidicontrols/labextension/*.tgz
11+
12+
# Documentation
13+
graft docs
14+
exclude docs/\#*
15+
prune docs/build
16+
prune docs/gh-pages
17+
prune docs/dist
18+
19+
# Examples
20+
graft examples
21+
22+
# Tests
23+
graft tests
24+
prune tests/build
25+
26+
# Javascript files
27+
graft ipymidicontrols/nbextension
28+
graft src
29+
prune **/node_modules
30+
prune coverage
31+
prune lib
32+
33+
# Patterns to exclude from any directory
34+
global-exclude *~
35+
global-exclude *.pyc
36+
global-exclude *.pyo
37+
global-exclude .git
38+
global-exclude .ipynb_checkpoints

‎README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
2+
# midicontrols
3+
4+
[![Build Status](https://travis-ci.org/jupyter-widgets/midicontrols.svg?branch=master)](https://travis-ci.org/jupyter-widgets/ipymidicontrols)
5+
[![codecov](https://codecov.io/gh/jupyter-widgets/midicontrols/branch/master/graph/badge.svg)](https://codecov.io/gh/jupyter-widgets/midicontrols)
6+
7+
8+
A Jupyter widget for interfacing with MIDI controllers.
9+
10+
## Installation
11+
12+
You can install using `pip`:
13+
14+
```bash
15+
pip install ipymidicontrols
16+
```
17+
18+
Or if you use jupyterlab:
19+
20+
```bash
21+
pip install ipymidicontrols
22+
jupyter labextension install @jupyter-widgets/jupyterlab-manager
23+
```
24+
25+
If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
26+
the nbextension:
27+
```bash
28+
jupyter nbextension enable --py [--sys-prefix|--user|--system] ipymidicontrols
29+
```

0 commit comments

Comments
 (0)