Browse Source

WIP prepare packing

Tim Büchner 1 year ago
parent
commit
476b9a8be3
5 changed files with 111 additions and 1 deletions
  1. 6 1
      .gitignore
  2. 21 0
      License.txt
  3. 67 0
      setup.cfg
  4. 17 0
      setup.py
  5. 0 0
      src/ebpm/__init__.py

+ 6 - 1
.gitignore

@@ -39,4 +39,9 @@ __pycache__/
 .Spotlight-V100
 .Trashes
 ehthumbs.db
-Thumbs.db
+Thumbs.db
+
+
+# VSCode #
+##########
+.vscode

+ 21 - 0
License.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Yuxuan Xie, Tim Büchner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

+ 67 - 0
setup.cfg

@@ -0,0 +1,67 @@
+# This file is used to configure your project.
+# Read more about the various options under:
+# https://setuptools.pypa.io/en/latest/userguide/declarative_config.html
+# https://setuptools.pypa.io/en/latest/references/keywords.html
+
+[metadata]
+name = ebpm 
+description = Eye Blink Prototype Matching in EAR time series
+license = MIT
+license_files = LICENSE.txt
+long_description = file: README.md
+long_description_content_type = text/markdown; charset=UTF-8; variant=GFM
+
+platforms = any
+
+[options]
+zip_safe = False
+packages = find_namespace:
+include_package_data = True
+package_dir =
+    =src
+
+# Require a min/specific Python version (comma-separated conditions)
+python_requires = >=3.9
+install_requires =
+    numpy>=1.23,
+    pandas>=2.2
+    scipy>=1.12
+    stumpy>=1.12
+    matplotlib>=3.5,<4
+
+[options.packages.find]
+where = src
+exclude =
+    tests
+
+testing =
+    setuptools
+    pytest
+    pytest-cov
+
+[tool:pytest]
+addopts =
+    --cov ebpm --cov-report term-missing
+    --verbose
+norecursedirs =
+    dist
+    build
+    .tox
+testpaths = tests
+
+[devpi:upload]
+no_vcs = 1
+formats = bdist_wheel
+
+[flake8]
+# Some sane defaults for the code style checker flake8
+max_line_length = 160
+extend_ignore = E203, W503
+# ^  Black-compatible
+#    E203 and W503 have edge cases handled by black
+exclude =
+    .tox
+    build
+    dist
+    .eggs
+    docs/conf.py

+ 17 - 0
setup.py

@@ -0,0 +1,17 @@
+"""
+    Setup file for electromyogram.
+    Use setup.cfg to configure your project.
+"""
+from setuptools import setup
+
+if __name__ == "__main__":
+    try:
+        setup(use_scm_version={"version_scheme": "no-guess-dev"})
+    except:  # noqa
+        print(
+            "\n\nAn error occurred while building the project, "
+            "please ensure you have the most updated version of setuptools, "
+            "setuptools_scm and wheel with:\n"
+            "   pip install -U setuptools setuptools_scm wheel\n\n"
+        )
+        raise

+ 0 - 0
src/ebpm/__init__.py