Welcome to Django File Context’s documentation!¶
Contents:
Django File Context¶
File Context provides an easy way to store different documents/attachments
Documentation¶
The full documentation is at https://django-file-context.readthedocs.io.
Quickstart¶
Install Django File Context:
pip install django-file-context
Add it to your INSTALLED_APPS:
INSTALLED_APPS = (
...
'file_context.apps.FileContextConfig',
...
)
You need to add this to your INSTALLED_APPS, because we have our own models.
Add Django File Context’s URL patterns:
from file_context import urls as file_context_urls
urlpatterns = [
...
url(r'^', include(file_context_urls)),
...
]
This is optional. Actually, you can include your own URLs.
Features¶
- Generic File model so you can store different kinds of files, images,
etc, using a single model; * Attach/Detach the file model to other models * Cool descriptor, so you don’t have to keep mangling GenericForeignKeys inside your models.
Usage¶
- First of all, define your first model
- :: python
from file_context.managers import Files
class MyModel(models.Model):
name = models.CharField(max_length=128)
files = Files()
- That’s it.
- You can use the Files API to attach files to MyModel instances, using:
:: python
uploaded_file = File.objects.get(pk=1) a = MyModel.objects.create(name=’foo’) a.files.attach(uploaded_file) a.files.detach(uploaded_file) a.files.clear()
Running Tests¶
Does the code actually work?
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
Credits¶
Tools used in rendering this package:
- Huge props to django-taggit that inspired me to do the descritor
idea!
Installation¶
At the command line:
$ easy_install django-file-context
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv django-file-context
$ pip install django-file-context
Usage¶
To use Django File Context in a project, add it to your INSTALLED_APPS:
INSTALLED_APPS = (
...
'file_context.apps.FileContextConfig',
...
)
Add Django File Context’s URL patterns:
from file_context import urls as file_context_urls
urlpatterns = [
...
url(r'^', include(file_context_urls)),
...
]
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/george-silva/django-file-context/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 File Context could always use more documentation, whether as part of the official Django File Context 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/george-silva/django-file-context/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-file-context for local development.
Fork the django-file-context repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/django-file-context.git
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-file-context $ cd django-file-context/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 file_context tests $ python setup.py test $ tox
To get flake8 and tox, just pip install them into your virtualenv.
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
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- 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.
- The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/george-silva/django-file-context/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
Development Lead¶
- George Silva <george@sigmageosistemas.com.br>
Contributors¶
None yet. Why not be the first?