Merge pull request #4 from ajcr/toml-packaging

Toml packaging
ajcr · Nov 2, 2023 · e4e6a09 · e4e6a09
2 parents 53df532 + 3a29db0
commit e4e6a09
Show file tree

Hide file tree

Showing 19 changed files with 52 additions and 60 deletions.
diff --git a/.github/workflows/python-package.yaml b/.github/workflows/python-package.yaml
@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.11"]
+        python-version: ["3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v3
@@ -29,9 +29,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install -r dev_requirements.txt
-        python -m pip install -r requirements.txt
-        python -m pip install .
+        python -m pip install .[dev]
     - name: Check with ruff
       run: ruff check .
     - name: Check types

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+include grammar.lark
diff --git a/README.md b/README.md
@@ -25,10 +25,6 @@ By default, the computation assumes that draws are made without replacement. Thi
 
 Let's look at some examples.
 
-<p align="center">
-  <img src="https://raw.githubusercontent.com/ajcr/urn/main/assets/rbg_draw_1.png" alt="constraints using AND"/>
-</p>
-
 Suppose we want to draw _without replacement_ from an urn containing coloured marbles. We want to see the probability that we see _at least_ 2 red and _at most_ 5 blue:
 ```
 urn> probability draw from red = 5, blue = 7, green = 3 where red >= 2 and blue <= 5;
@@ -121,10 +117,6 @@ urn> probability draw 2..13 with replacement
 ```
 
 Finally, we can use `OR` to specify any number of alternative constraints on our draw.
-<p align="center">
-  <img src="https://raw.githubusercontent.com/ajcr/urn/main/assets/rbg_draw_2.png" alt="constraints using OR"/>
-</p>
-
 ```
 urn> probability draw 1..10 from red=5, blue=7, green=3
 ...  where red >= 2 and blue <= 3

diff --git a/dev_requirements.txt b/dev_requirements.txt
diff --git a/urn/grammar.lark → grammar.lark b/urn/grammar.lark → grammar.lark
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,45 @@
+[build-system]
+requires      = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "urn-calculator"
+version = "0.0.1"
+description = "Multivariate hypergeometric command line calculator."
+readme = "README.md"
+authors = [{ name = "Alex Riley" }]
+license = { file = "LICENSE" }
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Topic :: Scientific/Engineering :: Mathematics",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Topic :: Utilities",
+    "Typing :: Typed",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+keywords = ["calculator", "probability", "count", "draw", "random", "sample", "hypergeometric"]
+dependencies = [
+    "lark >= 1.1.5",
+    "sympy >= 1.12",
+    "tabulate >= 0.9.0",
+    "uniplot >= 0.10.0",
+]
+requires-python = ">=3.10"
+
+[project.optional-dependencies]
+dev = ["pytest", "ruff"]
+
+[project.urls]
+Homepage = "https://github.com/ajcr/urn"
+
+[project.scripts]
+urn = "urn.cli:main"
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "."
+]
diff --git a/requirements.txt b/requirements.txt
diff --git a/setup.py b/setup.py
diff --git a/urn/__init__.py → src/urn/__init__.py b/urn/__init__.py → src/urn/__init__.py
diff --git a/urn/cli.py → src/urn/cli.py b/urn/cli.py → src/urn/cli.py
@@ -5,7 +5,7 @@
 
 from urn import __version__
 
-DESCRIPTION = "Draw odds calculator."
+DESCRIPTION = "Multivariate hypergeometric calculator."
 
 
 def parse_args() -> argparse.Namespace:
@@ -30,7 +30,7 @@ def main() -> None:
     from urn.shell import run_shell
     from urn.evaluation import process_query
 
-    command_parser = lark.Lark.open("grammar.lark", rel_to=__file__)
+    command_parser = lark.Lark.open("grammar.lark", rel_to=__package__)
 
     if args.command or args.filename:
 

diff --git a/urn/computation.py → src/urn/computation.py b/urn/computation.py → src/urn/computation.py
diff --git a/urn/constants.py → src/urn/constants.py b/urn/constants.py → src/urn/constants.py
diff --git a/urn/constraint.py → src/urn/constraint.py b/urn/constraint.py → src/urn/constraint.py
diff --git a/urn/evaluation.py → src/urn/evaluation.py b/urn/evaluation.py → src/urn/evaluation.py
diff --git a/urn/output.py → src/urn/output.py b/urn/output.py → src/urn/output.py
diff --git a/urn/parsing.py → src/urn/parsing.py b/urn/parsing.py → src/urn/parsing.py
diff --git a/urn/shell.py → src/urn/shell.py b/urn/shell.py → src/urn/shell.py
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/test_parsing.py b/tests/test_parsing.py
@@ -8,9 +8,8 @@
 
 
 @pytest.fixture(scope="session")
-def parser(request):
-    rel_to = request.config.rootdir.join("urn").join("urn")
-    return lark.Lark.open("grammar.lark", rel_to=str(rel_to))
+def parser():
+    return lark.Lark.open("grammar.lark")
 
 
 @pytest.mark.parametrize(