Skip to content

Commit 75280d3

Browse files
committed
init src-layout project with configured setuptools
0 parents  commit 75280d3

File tree

6 files changed

+96
-0
lines changed

6 files changed

+96
-0
lines changed

.gitignore

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.tox/
2+
build/
3+
dist/
4+
*.egg-info
5+
__pycache__/
6+
7+
# Unit test / coverage reports
8+
.coverage
9+
.coverage.*
10+
nosetests.xml
11+
coverage.xml
12+
*.cover
13+
.hypothesis/
14+
15+
# editors and IDEs
16+
*.sw[a-z]
17+
*~
18+
.idea
19+
.vscode

LICENSE

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

README.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
scicode-widgets
2+
===============
3+
4+
A collection of ipywidgets for the creation of interactive code demos and educational notebooks with exercises that can be checked and exported.
5+
6+
Installation
7+
------------
8+
9+
.. code-block:: bash
10+
11+
pip install .

pyproject.toml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
[build-system]
2+
# setuptools requirement due to specifiying the version the in pyproject.toml
3+
# https://packaging.python.org/en/latest/guides/single-sourcing-package-version/
4+
requires = [
5+
"setuptools>=61.0.0",
6+
"wheel"
7+
]
8+
build-backend = "setuptools.build_meta"
9+
10+
[project]
11+
name = "scwidgets"
12+
description = "ipywidgets for the creation of interactive code demos and educational notebooks"
13+
readme = "README.rst"
14+
requires-python = ">=3.7"
15+
license = {text = "BSD-3-Clause"}
16+
classifiers = [
17+
"Intended Audience :: Science/Research",
18+
"Operating System :: POSIX",
19+
"License :: OSI Approved :: BSD License",
20+
"Programming Language :: Python",
21+
"Programming Language :: Python :: 4.8",
22+
"Programming Language :: Python :: 4.9",
23+
"Programming Language :: Python :: 4.10",
24+
"Topic :: Scientific/Engineering",
25+
"Topic :: Scientific/Engineering :: Chemistry",
26+
"Topic :: Scientific/Engineering :: Physics",
27+
"Topic :: Software Development :: Libraries :: Python Modules",
28+
]
29+
dependencies = [
30+
"ipywidgets>=8.0.0",
31+
]
32+
dynamic = ["version"]
33+
34+
[tool.setuptools.dynamic]
35+
version = {attr = "scwidgets.__version__"}
36+
readme = {file = ["README.rst"]}

src/scwidgets/__init__.py

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
__version__ = "0.0.0-dev"
2+
__authors__ = "the scicode-widgets developer team"

tests/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)