Managing resources in a Python project

by

You may want to use pkg_resources library that comes with setuptools.

For example, I’ve made up a quick little package "proj" to illustrate the resource organization scheme I’d use:

proj/setup.py
proj/proj/__init__.py
proj/proj/code.py
proj/proj/resources/__init__.py
proj/proj/resources/images/__init__.py
proj/proj/resources/images/pic1.png
proj/proj/resources/images/pic2.png

Notice how I keep all resources in a separate subpackage.

"code.py" shows how pkg_resources is used to refer to the resource objects:

from pkg_resources import resource_string, resource_listdir

# Itemize data files under proj/resources/images:
print resource_listdir('proj.resources.images', '')
# Get the data file bytes:
print resource_string('proj.resources.images', 'pic2.png').encode('base64')

If you run it, you get:

['__init__.py', '__init__.pyc', 'pic1.png', 'pic2.png']
iVBORw0KGgoAAAANSUhE ...

If you need to treat a resource as a fileobject, use resource_stream().

The code accessing the resources may be anywhere within the subpackage structure of your project, it just needs to refer to subpackage containing the images by full name: proj.resources.images, in this case.

Here’s "setup.py":

#!/usr/bin/env python

from setuptools import setup, find_packages

setup(name="proj",
      packages=find_packages(),
      package_data={'': ['*.png']})

Caveat:
To test things “locally”, that is w/o installing the package first, you’ll have to invoke your test scripts from directory that has setup.py. If you’re in the same directory as code.py, Python won’t know about proj package. So things like proj.resources won’t resolve.

More Related Contents:

  1. How to include package data with setuptools/distutils?
  2. Differences between distribute, distutils, setuptools and distutils2?
  3. How can I make setuptools install a package that’s not on PyPI?
  4. pip ignores dependency_links in setup.py
  5. How may I override the compiler (GCC) flags that setup.py uses by default?
  6. Execute a Python script post install using distutils / setuptools
  7. How can I add post-install scripts to easy_install / setuptools / distutils?
  8. Is it possible to express a platform-specific dependency in setup.py without building platform-specific versions of my egg?
  9. Is it possible to require PyQt from setuptools setup.py?
  10. python setuptools install_requires is ignored when overriding cmdclass
  11. Why use pip over easy_install?
  12. Python setup.py develop vs install
  13. Including non-Python files with setup.py
  14. How to tell distutils to use gcc?
  15. Reference requirements.txt for the install_requires kwarg in setuptools setup.py file
  16. How can I get the version defined in setup.py (setuptools) in my package?
  17. What is the official “preferred” way to install pip and virtualenv systemwide?
  18. ValueError: Unknown MS Compiler version 1900
  19. How to write setup.py to include a Git repository as a dependency
  20. Symbol not found: __PyCodecInfo_GetIncrementalDecoder
  21. Don’t touch my shebang
  22. Why is pip installing an old version of my package?
  23. Is it possible to exclude data file sources and intermediary files from bdist?
  24. distutils: How to pass a user defined parameter to setup.py?
  25. Using Cython To Link Python To A Shared Library
  26. How to include and install local dependencies in setup.py in Python?
  27. How to build a Python C Extension so I can import it from a module
  28. How to pass flag to gcc in Python setup.py script?
  29. How to get `setup.cfg` metadata at the command line (Python)
  30. What is the difference between `extras_require()` and `install_requires()` in setup.py?

Leave a Comment