static assets in python package

[jettjaniak]

@jaidhyani has more context

[jaidhyani]

See: https://setuptools.pypa.io/en/latest/userguide/datafiles.html#package-data

Given dir structure:

project_root_directory
├── setup.py        # and/or setup.cfg, pyproject.toml
└── src
    └── mypkg
        ├── __init__.py
        ├── data1.rst
        ├── data2.rst
        ├── data1.txt
        └── data2.txt

You can add a package_data arg to setup.py:

from setuptools import setup, find_packages
setup(
    # ...,
    packages=find_packages(where="src"),
    package_dir={"": "src"},
    package_data={"mypkg": ["*.txt", "*.rst"]}
)

And then access the static assets at runtime:

from importlib.resources import files
data_text = files('mypkg').joinpath('data1.txt').read_text()

[jaidhyani]

We want all static assets we're generating and want to be part of the project - pickles, csvs, whatever - to go to a standard data dir. How about src/delphi/static/?

[jettjaniak]

also move the files that are elsewhere now and paths in scripts that produce files