deapi 5.2.0__tar.gz

deapi-5.2.0/.github/workflows/build.yaml

@@ -0,0 +1,69 @@
+name: build
+
+on:
+  push:
+  pull_request:
+    branches: main
+
+env:
+  MPLBACKEND: agg
+
+jobs:
+  build-with-pip:
+    name: ${{ matrix.os }}-py${{ matrix.python-version }}${{ matrix.LABEL }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12"]
+        include:
+          - os: ubuntu-latest
+            python-version: 3.10
+
+            DEPENDENCIES: protobuf==5.26.0
+            LABEL: -oldest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies and package
+        shell: bash
+        run: |
+          pip install -U -e .'[tests]'
+
+      - name: Install oldest supported versions
+        if: contains(matrix.LABEL, 'oldest')
+        run: |
+          pip install ${{ matrix.DEPENDENCIES }}
+
+      - name: Display Python, pip and package versions
+        run: |
+          python -V
+          pip -V
+          pip list
+
+      - name: Run docstring tests
+        continue-on-error: true
+        run: |
+          pytest --doctest-modules --doctest-continue-on-failure --ignore-glob=deapi/tests deapi
+
+      - name: Run tests
+        run: |
+          pytest --cov=. --cov-report=xml
+
+      - name: Generate line coverage
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        run: |
+          coverage report --show-missing
+
+      - name: Upload coverage to Codecov
+        if: ${{ always() }}
+        uses: codecov/codecov-action@v4
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

deapi-5.2.0/.github/workflows/documentation.yaml

@@ -0,0 +1,38 @@
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        shell: bash
+        run: |
+          pip install -U -e .'[doc]'
+
+      - name: Sphinx build
+        run: |
+          python deapi/simulated_server/initialize_server.py 13241 &
+          sleep 5 &&
+          sphinx-build doc _build &&
+          kill %1
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true

deapi-5.2.0/.github/workflows/publish.yaml

@@ -0,0 +1,33 @@
+name: Upload to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    workflow: "*"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+
+    - name: Build package
+      run: |
+        python -m build
+
+    - name: Publish package distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

deapi-5.2.0/.github/workflows/test-publish.yaml

@@ -0,0 +1,33 @@
+name: Test Upload Python Package
+
+on:
+  workflow_dispatch:
+    workflow: "*"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+
+    - name: Build package
+      run: |
+        python -m build
+
+    - name: Publish package distribution to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository_url: https://test.pypi.org/legacy/

deapi-5.2.0/.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/psf/black
+    # Version can be updated by running "pre-commit autoupdate"
+    rev: 24.10.0
+    hooks:
+      - id: black
+ci:
+  # Don't run automatically on PRs, instead add the comment
+  # "pre-commit.ci autofix" on a pull request to manually trigger auto-fixing
+  autofix_prs: false

deapi-5.2.0/CHANGES.rst

@@ -0,0 +1,18 @@
+.. _changelog:
+
+Changelog
+*********
+
+This document describes the changes in the DEAPI library.
+
+
+Unreleased
+==========
+- Initial release
+- Renamed `Client` functions from CamelCase to snake_case (Legacy functions are still available)
+- Added buffer_protocol module for handling different buffer protocol files
+- Added a data_types module for handling different data types
+- Added a python based DEServer for testing purposes
+- Update the Testing to allow for a real DEServer to be used for testing (#7)
+- Add support for `@pytest.mark.server` decorator for tests that require a full DEServer to be running (#7)
+- Add a commandline interface for the pydeserver. (#8) Running `pydeserver --port 13241` will start the server on port 13241

deapi-5.2.0/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.1
+Name: deapi
+Version: 5.2.0
+Summary: API for DE Server
+Author: Direct Electron
+Project-URL: Bug Reports, https://github.com/hyperspy/hyperspy/issues
+Project-URL: Documentation, https://hyperspy.org/hyperspy-doc/current/index.html
+Project-URL: Conda-forge, https://anaconda.org/conda-forge/hyperspy
+Project-URL: Homepage, https://hyperspy.org
+Project-URL: Support, https://gitter.im/hyperspy/hyperspy
+Project-URL: Source, https://github.com/hyperspy/hyperspy
+Keywords: EELS,STEM,TEM,hyperspy,microscopy,Cryo EM,4D STEM
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.8
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: protobuf
+Requires-Dist: pillow
+Requires-Dist: matplotlib
+Requires-Dist: scipy
+Requires-Dist: scikit-image
+Requires-Dist: sympy
+Provides-Extra: tests
+Requires-Dist: pytest-instafail; extra == "tests"
+Requires-Dist: pytest-mpl; extra == "tests"
+Requires-Dist: pytest-rerunfailures; extra == "tests"
+Requires-Dist: pytest-xdist; extra == "tests"
+Requires-Dist: pytest>=3.6; extra == "tests"
+Requires-Dist: setuptools_scm; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pytest-xprocess; extra == "tests"
+Requires-Dist: libertem; extra == "tests"
+Requires-Dist: hyperspy; extra == "tests"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: pydata_sphinx_theme; extra == "doc"
+Requires-Dist: sphinx-gallery; extra == "doc"

deapi-5.2.0/README.md

@@ -0,0 +1,35 @@
+Warning!
+========
+
+This API is still under development and is subject to changes.  It is provided for future reference and development. 
+
+
+
+
+
+DE API - Python
+===============
+
+The DE API provides python bindings for basic operations for controlling the DEServer. This API isn't functional without 
+a working copy of DEServer and a Direct Electron Detector.
+
+
+Installation
+------------
+
+The python api can be installed using either `pip` or `anaconda`. 
+
+
+Installing using pip
+
+```bash
+$ pip install deapi
+```
+
+Installing using conda
+
+```bash
+$ conda install -c conda-forge deapi
+```
+
+Usage and documentation is hosted here. 

deapi-5.2.0/deapi/__init__.py

@@ -0,0 +1,33 @@
+from deapi.client import Client
+from deapi.version import version as __version__
+
+from deapi.data_types import (
+    FrameType,
+    PixelFormat,
+    DataType,
+    MovieBufferStatus,
+    MovieBufferInfo,
+    VirtualMask,
+    ContrastStretchType,
+    Attributes,
+    Histogram,
+    PropertySpec,
+    PropertyCollection,
+)
+
+
+__all__ = [
+    "Client",
+    "__version__",
+    "FrameType",
+    "PixelFormat",
+    "DataType",
+    "MovieBufferStatus",
+    "MovieBufferInfo",
+    "VirtualMask",
+    "ContrastStretchType",
+    "Attributes",
+    "Histogram",
+    "PropertySpec",
+    "PropertyCollection",
+]

deapi-5.2.0/deapi/buffer_protocols/__init__.py

@@ -0,0 +1,29 @@
+# Choose the right protocol buffer version based on the python version
+
+import sys
+
+pyVersion = sys.version.split("(")[0][0:4].split(".")
+
+
+if int(pyVersion[0]) < 3:
+    from cStringIO import (
+        StringIO,
+    )  # use string io to speed up, refer to http://www.skymind.com/~ocrow/python_string/
+    import deapi.buffer_protocols.pb_2_3_0 as pb
+else:
+    from io import (
+        StringIO,
+    )  # use string io to speed up, refer to http://www.skymind.com/~ocrow/python_string/
+
+    long = int  # python 3 no longer has int
+    if int(pyVersion[1]) >= 10:
+        # import pb_3_19_3 as pb
+        import deapi.buffer_protocols.pb_3_23_3 as pb
+    elif int(pyVersion[1]) >= 8:
+        import deapi.buffer_protocols.pb_3_11_4 as pb
+    else:
+        import deapi.buffer_protocols.pb_3_6_1 as pb
+
+__all__ = [
+    "pb",
+]