build: adding setup.py and changing to src layout (#3)

* adding setup.py
* adopting src layout
* testing installed package in CI

.github/workflows/CI.yml

@@ -24,7 +24,6 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install flake8 black
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
@@ -35,7 +34,10 @@ jobs:
       run: |
         black --check --diff --verbose .
 
-    - name: Test example
+    - name: Install cabinetry and test example
       run: |
+        pip install .
+        # install extra dependencies the example needs
+        pip install matplotlib uproot
         python util/create_histograms.py
         python example.py

.gitignore

@@ -1,6 +1,16 @@
 __pycache__
 *.pyc
+
+# packaging
+*.egg-info
+dist
+build
+
+# editors
 .vscode
+*.swp
+
+# files produced by running cabinetry
 *.root
 *.png
 *.pdf

setup.py

@@ -0,0 +1,25 @@
+from setuptools import setup, find_packages
+
+
+with open("README.md", "r") as f:
+    long_description = f.read()
+
+setup(
+    name="cabinetry",
+    version="0.0.1",
+    author="cabinetry developers",
+    description="design and steer profile likelihood fits",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    license="BSD 3-Clause",
+    url="https://github.com/alexander-held/cabinetry",
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: BSD License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.6",
+    install_requires=["numpy", "pyyaml"],
+)

cabinetry/__init__.py → src/cabinetry/__init__.py

@@ -2,3 +2,5 @@
 from . import template_builder
 from . import template_postprocessor
 from . import visualize
+
+__version__ = "0.0.1"