Skip to content

Commit

Permalink
Improve the include/exclude pyproject fields
Browse files Browse the repository at this point in the history
  • Loading branch information
ekiefl committed Jul 22, 2024
1 parent d07d53e commit 8d0b1b1
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/getting_started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 0 additions & 6 deletions docs/getting_started/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ dependencies:
- python==3.8.10
- pip
- pip:
- poetry
- poetry>=1.8.3
30 changes: 19 additions & 11 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 <kiefl.evan@gmail.com>"]
maintainers = ["Evan Kiefl <kiefl.evan@gmail.com>"]
Expand All @@ -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"

Expand Down

0 comments on commit 8d0b1b1

Please sign in to comment.