drf-file-manager

Name	drf-file-manager JSON
Version	1.0.0 JSON
	download
home_page	https://github.com/suqingdong/drf_file_manager
Summary	File Manager Application for DjangoRestFramework
upload_time	2024-03-29 07:15:39
maintainer	None
docs_url	None
author	suqingdong
requires_python	None
license	MIT License
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # File Manager Application for DjangoRestFramework

## Installation

```bash
python3 -m pip install -U drf_file_manager
```

Windows needs install extra: `python-magic-bin`

```bash
python3 -m pip install python-magic-bin
```

## Usage
1. Add `drf_file_manager` to your `INSTALLED_APPS` setting:

```python
# settings.py
INSTALLED_APPS += [
    'rest_framework',
    'drf_file_manager',
]
```

2. Configuration for `drf_file_manager`:

```python
# settings.py
FILE_UPLOAD_TO = 'data/upload/'
FILE_UPLOAD_MAX_SIZE = '10M'    # [optional]
```

3. Add `drf_file_manager.urls` to your project's urls.py:

```python
# urls.py

urlpatterns += [
    include('api/file/', include('drf_file_manager.urls')),
]
```

## API Endpoints

- `POST /api/file/` - Upload a file
- `GET /api/file/` - List all files
- `GET /api/file/{id}/` - Retrieve a file
- `GET /api/file/{id}/download/` - Download a file (with streaming support)
- `DELETE /api/file/{id}/` - Delete a file
- `POST /api/file/clean/` - Delete all files

#### preview

![](https://suqingdong.github.io/drf_file_manager/src/api-docs.png)


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/suqingdong/drf_file_manager",
    "name": "drf-file-manager",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "suqingdong",
    "author_email": "suqingdong1114@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/0b/70/cbea5189c795194495a4446be33d64393c69e627d4d34f8d06ba6b962296/drf_file_manager-1.0.0.tar.gz",
    "platform": null,
    "description": "# File Manager Application for DjangoRestFramework\n\n## Installation\n\n```bash\npython3 -m pip install -U drf_file_manager\n```\n\nWindows needs install extra: `python-magic-bin`\n\n```bash\npython3 -m pip install python-magic-bin\n```\n\n## Usage\n1. Add `drf_file_manager` to your `INSTALLED_APPS` setting:\n\n```python\n# settings.py\nINSTALLED_APPS += [\n    'rest_framework',\n    'drf_file_manager',\n]\n```\n\n2. Configuration for `drf_file_manager`:\n\n```python\n# settings.py\nFILE_UPLOAD_TO = 'data/upload/'\nFILE_UPLOAD_MAX_SIZE = '10M'    # [optional]\n```\n\n3. Add `drf_file_manager.urls` to your project's urls.py:\n\n```python\n# urls.py\n\nurlpatterns += [\n    include('api/file/', include('drf_file_manager.urls')),\n]\n```\n\n## API Endpoints\n\n- `POST /api/file/` - Upload a file\n- `GET /api/file/` - List all files\n- `GET /api/file/{id}/` - Retrieve a file\n- `GET /api/file/{id}/download/` - Download a file (with streaming support)\n- `DELETE /api/file/{id}/` - Delete a file\n- `POST /api/file/clean/` - Delete all files\n\n#### preview\n\n![](https://suqingdong.github.io/drf_file_manager/src/api-docs.png)\n\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "File Manager Application for DjangoRestFramework",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/suqingdong/drf_file_manager"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "12cb7da56ca7328305e3bce91ad814021cbb50e8aa1bd9fd511d2178c7961957",
                "md5": "13fd3a1aa96031915875dff0db12b883",
                "sha256": "245350cfa6eb8b6235b4433d444bd26b18e4426b7fdbbcb4aa7c71777b382770"
            },
            "downloads": -1,
            "filename": "drf_file_manager-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "13fd3a1aa96031915875dff0db12b883",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7534,
            "upload_time": "2024-03-29T07:15:38",
            "upload_time_iso_8601": "2024-03-29T07:15:38.002284Z",
            "url": "https://files.pythonhosted.org/packages/12/cb/7da56ca7328305e3bce91ad814021cbb50e8aa1bd9fd511d2178c7961957/drf_file_manager-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0b70cbea5189c795194495a4446be33d64393c69e627d4d34f8d06ba6b962296",
                "md5": "c8dd832842c8bf78d477e380f1fbec66",
                "sha256": "4cc5f1bf7a71d219c9975c1a3a074733cf912681eddc195a6d53d0c0c75a0215"
            },
            "downloads": -1,
            "filename": "drf_file_manager-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c8dd832842c8bf78d477e380f1fbec66",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6412,
            "upload_time": "2024-03-29T07:15:39",
            "upload_time_iso_8601": "2024-03-29T07:15:39.956922Z",
            "url": "https://files.pythonhosted.org/packages/0b/70/cbea5189c795194495a4446be33d64393c69e627d4d34f8d06ba6b962296/drf_file_manager-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-29 07:15:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "suqingdong",
    "github_project": "drf_file_manager",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "drf-file-manager"
}