An example project demonstrating various ways to access data files in Python package
Project description
This project shows how to package data files within a Python distribution, and has some example code for reading the data files. To build this distribution, create a venv with setuptools, wheel, and pep517 installed, then execute the latter as a module:
python -m pep517.build .The distributions (an sdist .tar.gz and a bdist .whl) will be written to ./dist/ subdirectory. To test it out, install the distribution and run the console script resources-example.
Here’s a compatibility summary of the five approaches demonstrated:
Module |
Description |
In stdlib? |
Works on Py2? |
Works on Py3? |
Works in zipfile? |
|---|---|---|---|---|---|
example1.py |
os.path.join |
yes |
yes |
yes |
no |
example2.py |
pkgutil |
yes |
yes |
yes |
yes |
example3.py |
pkg_resources |
no |
yes |
yes |
yes |
example4.py |
importlib.resources |
yes |
no |
yes (3.7+) |
yes |
example5.py |
importlib_resources |
no |
yes |
yes |
yes |
If you are interested in creating an executable zip from source, you can use stdlib zipapp utility (Python 3.5+):
python3 -m zipapp --compress /path/to/resources-example --main="myapp:main" --output=myapp.zipAnd now you can run the zip directly with the interpreter (any Python version):
python myapp.zipRelease history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for resources_example-0.2-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8171bbd50ffbb694f5e86d198fd556f8fd66c2a2537cd46e9406105119949418 |
|
| MD5 | 5bd1e3af5ec1aedacf8b43e33ba60424 |
|
| BLAKE2b-256 | eb6f3414bcf5bb8fbe1c9c5b27e91cec9cc43199b8b503f0d987918e1f1a7c9d |
