Skip to main content

Django pyfilesystem integration

Project description

A Django module which extends pyfilesystem with several methods to make it convenient for web use. Specifically, it extends pyfilesystem 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 pyfilesystem. However, the specific implementation is very Django-specific.

Good next steps would be to:

  • Upgrade to use PyFilesystem2 when it supports S3

  • 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. However, it doesn’t have test cases and similar, so can’t be considered truly production-ready. The expiration functionality, in particular, we are not using right now.

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

Uploaded Source

Built Distributions

django_pyfs-1.0.6-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

django_pyfs-1.0.6-py2-none-any.whl (11.4 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: django-pyfs-1.0.6.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-pyfs-1.0.6.tar.gz
Algorithm Hash digest
SHA256 712b78e1fa44b34f5b54893a6bff9165347fb27e2fe70af4771727bc44e43520
MD5 8895f8c8667db72d098cb11d500ce09d
BLAKE2b-256 6fc22d973bac6037aca292c3adffebe400de8a8ba764966056c8526276922e12

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_pyfs-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b97621342356a28ff224c6d1fd6f20608781de3bed8ff08f1b85d095db8d4217
MD5 9094a779ae67deedeb85ff869ba3abe0
BLAKE2b-256 779aa11b586f11670704fe85f5e06f8e1b5bae949f7f5a55993fe2efe6805c9e

See more details on using hashes here.

File details

Details for the file django_pyfs-1.0.6-py2-none-any.whl.

File metadata

File hashes

Hashes for django_pyfs-1.0.6-py2-none-any.whl
Algorithm Hash digest
SHA256 2fd30d821a42d4bf7af60f2057fcda56c7f8d0d8612761c6cd73d666af5b710f
MD5 43dc8154958d133d18c3d99dce19ce29
BLAKE2b-256 3422a958d60f7ce2028ac99cb5af254c3f9eb312327c2556cae6eb84dff2f686

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