Welcome to django-tus’s documentation!

Contents:

django-tus

https://badge.fury.io/py/django-tus.png https://travis-ci.org/alican/django-tus.png?branch=master

Django app implementing server side of tus protocol to powering resumable file uploads for django projects.

Documentation

The full documentation is at https://django-tus.readthedocs.org.

Quickstart

Install django-tus:

pip install django-tus

Add ‘django_tus’ to your INSTALLED_APPS setting.:

INSTALLED_APPS = (
...
'django_tus',

)

Add following urls to your urls.py.:

url(r'^upload/$', TusUpload.as_view(), name='tus_upload'),
url(r'^upload/(?P<resource_id>[0-9a-z-]+)$', TusUpload.as_view(), name='tus_upload_chunks'),

Todo

  • More Tus-Extensions

Running Tests

Activate your virtual env, then install the testing requirements with pip install -r requirements_test.txt.

Run the tests with pytest.

You can even generate a coverage report with pytest –cov=django_tus –cov-report=html.

You can run tox to test against multiple Python and Django versions.

MIT License

Copyright (c) 2016, Alican Toprak

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Installation

At the command line:

$ easy_install django-tus

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv django-tus
$ pip install django-tus

Usage

To use django-tus in a project:

import django_tus

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/alican/django-tus/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

django-tus could always use more documentation, whether as part of the official django-tus docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/alican/django-tus/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up django-tus for local development.

  1. Fork the django-tus repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/django-tus.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv django-tus
$ cd django-tus/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 django_tus tests
$ python setup.py test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/alican/django-tus/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_django_tus

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1.0 (2016-08-06)

  • First release on PyPI.