Skip to main content

Django pyfilesystem integration

Project description

PyPI Github CI Codecov Supported Python versions License

A Django module which extends pyfilesystem2 with several methods to make it convenient for web use. Specifically, it extends pyfilesystem2 with two methods:

fs.get_url(filename, timeout=0)

This will return a externally-usable URL to the resource. If timeout>0, the URL may stop working after that period (in seconds). Details are implementation-dependent. On Amazon S3, this is a secure URL, which is only available for that period. For a static filesystem, the URLs are unsecure and permanent.

fs.expire(filename, seconds, days, expires=True)

This allows us to create temporary objects. Our use-case was that we wanted to generate visualizations to users which were .png images. The lifetime of those images was a single web request, so we set them to expire after a few minutes. Another use case was memoization.

Note that expired files are not automatically removed. To remove them, call expire_objects(). In our system, we had a cron job do this for a while. Celery, manual removals, etc. are all options.

To configure a django-pyfs to use static files, set a parameter in Django settings:

DJFS = {'type' : 'osfs',
        'directory_root' : 'djpyfs/static/djpyfs',
        'url_root' : '/static/djpyfs'}

Here, directory_root is where the files go. url_root is the URL base of where your web server is configured to serve them from.

To use files on S3, you need boto installed. Then,

DJFS = {'type' : 's3fs',
        'bucket' : 'my-bucket',
        'prefix' : '/pyfs/' }

bucket is your S3 bucket. prefix is optional, and gives a base within that bucket.

To get your filesystem, call:

def get_filesystem(namespace)

Each module should pass a unique namespace. These will typically correspond to subdirectories within the filesystem.

The django-pyfs interface is designed as a generic (non-Django specific) extension to pyfilesystem2. However, the specific implementation is very Django-specific.

Good next steps would be to:

  • Allow Django storages to act as a back-end for pyfilesystem

  • Allow django-pyfs to act as a back-end for Django storages

  • Support more types of pyfilesystems (esp. in-memory would be nice)

State: This code is tested and has worked well in a range of settings, and is currently deployed on edx.org.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-pyfs-3.1.0.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

django_pyfs-3.1.0-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file django-pyfs-3.1.0.tar.gz.

File metadata

  • Download URL: django-pyfs-3.1.0.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for django-pyfs-3.1.0.tar.gz
Algorithm Hash digest
SHA256 9878e20d237132fc38f10296c0f233a47c3f02dceeabd03380a01fa139ed67a4
MD5 25d30f04a86cc7ff17d90e87352b18d6
BLAKE2b-256 8664b64888bd0401eb10f375d5f099cddc8025dfbd081433ae0e639902d5953e

See more details on using hashes here.

File details

Details for the file django_pyfs-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: django_pyfs-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for django_pyfs-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f31a69df01974b3ba9831b2c375fe9c167fe53773e39afd6315f1f085b7b9165
MD5 4377d2901460908bef748de84ff91ad1
BLAKE2b-256 cffb9693105ab7c155aea47975af24c0c9d78021ee1a0419707f7ae655b4bc3d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page