Skip to main content

Django pyfilesystem integration

Project description

django-pyfs

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-2.1.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: django-pyfs-2.1.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.1 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.5.6

File hashes

Hashes for django-pyfs-2.1.tar.gz
Algorithm Hash digest
SHA256 dc8cadd6b5a48eb7e74be2d8e133209906b9ed54db9af03dc89a38324a0c7a1d
MD5 f3e14c0e7f628f5736a975451af61db8
BLAKE2b-256 fa0f8911a8aa7aab3d6017a2ecbee5e2f10bd310643c353a39fc8cd2a025e32c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: django_pyfs-2.1-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.1 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.5.6

File hashes

Hashes for django_pyfs-2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dfec54a4f43a7037e3a10890544fb928343a2a697eb9b9a4cef6b2c6f0d16dfa
MD5 831049c025eba9adb28f7c2543938e8e
BLAKE2b-256 b09e7cc7c67ed27ede81419e88a28078d6a52d824bb179211a17e2d5fb7e75ca

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