From 8d0b1b1c6eeaf65fa39d8e33c5a630de40f23664 Mon Sep 17 00:00:00 2001 From: Evan Kiefl Date: Sun, 21 Jul 2024 17:58:45 -0700 Subject: [PATCH] Improve the include/exclude pyproject fields --- docs/getting_started/install.md | 2 +- docs/getting_started/interface.md | 6 ------ environment.yml | 2 +- pyproject.toml | 30 +++++++++++++++++++----------- 4 files changed, 21 insertions(+), 19 deletions(-) diff --git a/docs/getting_started/install.md b/docs/getting_started/install.md index 06327553..30abed1b 100644 --- a/docs/getting_started/install.md +++ b/docs/getting_started/install.md @@ -92,7 +92,7 @@ If you created your environment with conda, you've already installed poetry. Otherwise, install with ```bash -pip install poetry +pip install "poetry>=1.8.3" ``` Verify your installation: diff --git a/docs/getting_started/interface.md b/docs/getting_started/interface.md index 23457662..be26eb6c 100644 --- a/docs/getting_started/interface.md +++ b/docs/getting_started/interface.md @@ -8,12 +8,6 @@ The interface (GUI) can be accessed from the command line: run-pooltool ``` -Or, if you're on Windows (FIXME is this true?): - -```bash -run-pooltool.bat -``` - This will produce the following window: ![interface](../_assets/interface.jpg) diff --git a/environment.yml b/environment.yml index b5e5ade4..a75ba3e5 100644 --- a/environment.yml +++ b/environment.yml @@ -6,4 +6,4 @@ dependencies: - python==3.8.10 - pip - pip: - - poetry + - poetry>=1.8.3 diff --git a/pyproject.toml b/pyproject.toml index 19b0f89d..123194bf 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,6 +3,7 @@ name = "pooltool" version = "0.3.3+dev" description = "A sandbox billiards game that emphasizes realistic physics." repository = "https://github.com/ekiefl/pooltool" +homepage = "https://pooltool.readthedocs.io/en/latest/" documentation = "https://pooltool.readthedocs.io/en/latest/" authors = ["Evan Kiefl "] maintainers = ["Evan Kiefl "] @@ -17,25 +18,32 @@ classifiers = [ packages = [{include = "pooltool"}] +# Include globs override exclude globs below. include = [ + # Logo variants + "pooltool/logo/logo_pt.png", + "pooltool/logo/logo_pt_smaller.png", + "pooltool/logo/logo.png", + # Image assets for HUD and menu + "pooltool/models/hud/*.png", + "pooltool/models/menu/*.png", ] exclude = [ + # All test files "pooltool/**/test_*", - "pooltool/logo/**/*.blend*", - "pooltool/logo/**/*.svg", - "pooltool/logo/**/*.exr", - "pooltool/logo/logo_v*p*.png", + # All intermediate modeling formats (Blender, SVG, etc.) + "pooltool/**/*.blend*", + "pooltool/**/*.svg", + "pooltool/**/*.exr", + "pooltool/**/*.pptx", + "pooltool/**/*.png", # Some PNGs in `include` override this exclusion + "pooltool/**/*.jpg", + "pooltool/**/*.jpeg", + # To save package size, models with physical based rendering (PBR) are excluded "pooltool/models/**/*_pbr.glb", - "pooltool/models/**/*.blend*", - "pooltool/models/**/*.pptx", - "pooltool/models/**/*.svg", - "pooltool/models/**/*.png", - "pooltool/models/**/*.jpg", - "pooltool/models/**/*.jpeg", ] -# TODO (fix and make sure .bat works on windows) [tool.poetry.scripts] run-pooltool = "main:run"