File Context provides an easy way to store different documents/attachments
Project description
=============================
Django File Context
=============================
.. image:: https://gitlab.sigmageosistemas.com.br/dev/django-file-context/badges/master/coverage.svg
.. image:: https://gitlab.sigmageosistemas.com.br/dev/django-file-context/badges/master/pipeline.svg
.. image:: https://readthedocs.org/projects/django-file-context/badge/?version=latest
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`:
.. code-block:: python
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:
.. code-block:: python
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
-----
1. 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()
2. That's it.
3. 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!
* Cookiecutter_
* `cookiecutter-djangopackage`_
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
History
-------
0.1.0 (2017-10-25)
++++++++++++++++++
* First release on PyPI.
Django File Context
=============================
.. image:: https://gitlab.sigmageosistemas.com.br/dev/django-file-context/badges/master/coverage.svg
.. image:: https://gitlab.sigmageosistemas.com.br/dev/django-file-context/badges/master/pipeline.svg
.. image:: https://readthedocs.org/projects/django-file-context/badge/?version=latest
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`:
.. code-block:: python
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:
.. code-block:: python
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
-----
1. 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()
2. That's it.
3. 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!
* Cookiecutter_
* `cookiecutter-djangopackage`_
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
History
-------
0.1.0 (2017-10-25)
++++++++++++++++++
* First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-file-context-0.2.1.tar.gz
(10.3 kB
view hashes)
Built Distribution
Close
Hashes for django-file-context-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f3316c8c570906d4d68b5ff350f281f4ee139419ae39d5c6a926d03e78667a7 |
|
MD5 | 9b10e513912a740a66c93608e100863b |
|
BLAKE2b-256 | 4c6a4aaedeeed79f6886598cab375b22121b1e9fa394e886fe0c8a7d3eeca0a2 |
Close
Hashes for django_file_context-0.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 920b60bfecdf8de0975570ad5ae38fae6a5a8be23fae671dc4f9108a9356abd5 |
|
MD5 | e634c8abe72431a280644a4b730bf4c5 |
|
BLAKE2b-256 | 33d8a0fa92acd6279b38beee9add5b9043839b51b39ea4c7a4bc7b4c95307844 |