https://github.com/mokira3d48/mfs
Django Midnight File System (MFS) is a Django application programmed to manage easily the server files created and uploaded with the permissions and download authorizations.
https://github.com/mokira3d48/mfs
django django-rest-framework filesystem permission-requests python
Last synced: about 2 months ago
JSON representation
Django Midnight File System (MFS) is a Django application programmed to manage easily the server files created and uploaded with the permissions and download authorizations.
- Host: GitHub
- URL: https://github.com/mokira3d48/mfs
- Owner: mokira3d48
- License: mit
- Created: 2022-12-20T12:00:17.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-27T23:15:23.000Z (about 1 year ago)
- Last Synced: 2025-02-09T16:14:47.210Z (3 months ago)
- Topics: django, django-rest-framework, filesystem, permission-requests, python
- Language: Python
- Homepage:
- Size: 99.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Django Midnight File System
Django Midnight File System (MFS) is a Django application programmed to manage easily the server files
created and uploaded with the permissions and download authorizations.
## Installation et configuration
### Install python3
```sh
sudo apt install python3;\
sudo apt install python3-pip
```
You have to make sure of the version of python that is installed. The version of python
used is `python 3.8.10`.
### Install venv
You can install a python virtualenv program in two different ways.
```sh
sudo apt install python3-venv
```
OR
```sh
sudo pip3 install virtualenv
```
### Create virtual environment
In your project root, if you have not already done so, run one of the following commands to create
a virtual environment.
```sh
python3 -m venv env
```
OR
```sh
virtualenv env -p python3
```
### Lauch environment
```sh
source env/bin/activate
```
### Dependences installation
You must install the following dependences :
```sh
pip install django==3.2.6;\
pip install django-filter==21.1;\
pip install djangorestframework==3.13.1;\
pip install Markdown==3.3.6
```
## Integration
1. Copy `mfs` folder and past it into your root project.
2. Write the following code source in `settings.py` of your Django project.
```python
# MFS settings :
FSDIR = os.path.join(BASE_DIR, "fsdir"); # Definition of root directory of server files.
FSURL = "/file/"; # Definition of global URL for file management.
```
3. In `urls.py` file, write the following code:
```python
# ...
from django.conf import settings
from django.conf.urls.static import static
# ...
# After urlpatterns definition ...
urlpatterns += static(settings.FSURL, document_root=settings.FSDIR);
```
4. Execute the following django commands to make migration of the database File model :
```sh
./manage.py makemigrations;\
./manage.py migrate
```
All is done !
## Usage
We will see some examples of use cases in a Django project. Given an application named `galery`.
1. Example 1:
You can create model of image file in `galery` like following code :
```python
from django.utils.translation import gettext_lazy as _
from django.db import models
from mfs.models import File
class Image(File):
"""
Image file database model definition
"""
DEFAULT_DIR_NAME = "Pictures"; # define the root folder name of our images
DEFAULT_FILE_EXT = "png"; # define the global extension
class Meta:
verbose_name = _("Image");
def __str__(self):
"""
Function to return a representation of this model into string.
"""
return self.name; # this attribut is already defined on File superclass
```
Now we will try to create an image uploading function in the `views.py` file :
```python
from django.shortcuts import render
from mfs.core import get_file_uploaded
from .models import Image
def image_uploader(request):
"""
Function of image file uploading
"""
mfs_img = get_file_uploaded(request.FILES.get('file'), Image);
mfs_img.save();
print(mfs_img);
return f"{mfs_img.name} at {mfs_img.filepath} is uploaded successfully!";
```