Include SDK, move to src layout (#21)

* include sdk and move to src

* don't download sdk on CI

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add sdk files

* update pre-commit

* update build

* skip full read on cibuildwheel

* add linux

* remove download script

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.github/workflows/deploy.yml

@@ -33,7 +33,6 @@ jobs:
       - name: Download Samples
         run: |
           python scripts/download_samples.py
-          python scripts/download_sdk.py
         env:
           DROPBOX_TOKEN: ${{ secrets.DROPBOX_TOKEN }}
 

.github/workflows/test.yml

@@ -34,7 +34,6 @@ jobs:
           python -m pip install --upgrade pip
           pip install dropbox
           python scripts/download_samples.py
-          python scripts/download_sdk.py
         env:
           DROPBOX_TOKEN: ${{ secrets.DROPBOX_TOKEN }}
 

.gitignore

@@ -14,8 +14,8 @@ develop-eggs/
 dist/
 downloads/
 eggs/
-.eggs/
 lib/
+.eggs/
 lib64/
 parts/
 sdist/
@@ -104,13 +104,15 @@ ENV/
 # IDE settings
 .vscode/
 
-nd2/_nd2file.c
-nd2/_nd2file_legacy.c
-nd2/_version.py
-sdk
-sdk_legacy/*
 tests/data
 wheelhouse
-nd2/_sdk/picture.c
-nd2/_sdk/v9.c
-nd2/_sdk/latest.c
+src/nd2/_nd2file.c
+src/nd2/_nd2file_legacy.c
+src/nd2/_version.py
+src/nd2/_sdk/picture.c
+src/nd2/_sdk/v9.c
+src/nd2/_sdk/latest.c
+
+# allow these
+!src/sdk/**/*.so
+!src/sdk/**/*.a

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+exclude: src/sdk
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.0.1
@@ -6,7 +7,7 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v1.18.0
+    rev: v1.19.0
     hooks:
       - id: setup-cfg-fmt
   - repo: https://github.com/PyCQA/flake8
@@ -20,11 +21,11 @@ repos:
       - id: autoflake
         args: ["--in-place", "--remove-all-unused-imports"]
   - repo: https://github.com/PyCQA/isort
-    rev: 5.9.3
+    rev: 5.10.0
     hooks:
       - id: isort
   - repo: https://github.com/psf/black
-    rev: 21.9b0
+    rev: 21.10b0
     hooks:
       - id: black
   - repo: https://github.com/asottile/pyupgrade

LICENSE

@@ -1,10 +1,10 @@
-ND2 SDK shared libraries are included in the built (wheel) distributions by
-permission of Laboratory Imaging, Inc.
+ND2 SDK libraries are distributed by permission of Mirek Svoboda,
+Laboratory Imaging, Inc.  (see LICENSE file in sdk folder)
 https://www.lim.cz/
 https://www.nd2sdk.com
 
 
-BSD License
+The remainder of the code is distributed under the following BSD License
 
 Copyright (c) 2021, Talley Lambert
 All rights reserved.

MANIFEST.in

@@ -1,10 +1,8 @@
-include nd2/py.typed
-recursive-include nd2 *.pyi
+include src/nd2/py.typed
+recursive-include src/nd2 *.pyi
 
-graft sdk/latest/*/lib
-graft sdk/v9/*/lib
-graft sdk/latest/*/include
-graft sdk/v9/*/include
+graft src/sdk/*/lib
+graft src/sdk/*/include
 
 exclude .pre-commit-config.yaml .coveragerc
 recursive-exclude tests *

Makefile

@@ -9,14 +9,15 @@ build:
 clean:
 	rm -rf build dist wheelhouse
 	rm -rf htmlcov .coverage .hypothesis
-	rm -f nd2/*.so
-	rm -f nd2/_*.c
-	rm -f nd2/_sdk/*.so
-	rm -f nd2/_sdk/*.c
+	rm -f src/nd2/*.so
+	rm -f src/nd2/_*.c
+	rm -f src/nd2/_sdk/*.so
+	rm -f src/nd2/_sdk/*.c
+	rm -f src/nd2/_sdk/*.cpp
 
 clobber:
 	make clean
-	rm -rf sdk .mypy_cache
+	rm -rf .mypy_cache
 
 rebuild:
 	make clean