django-import-export


Namedjango-import-export JSON
Version 4.0.6 PyPI version JSON
download
home_pageNone
SummaryDjango application and library for importing and exporting data with included admin integration.
upload_time2024-05-27 09:35:36
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseCopyright (c) Bojan Mihelac and individual contributors. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords django import export
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            ====================
django-import-export
====================

.. |build| image:: https://github.com/django-import-export/django-import-export/actions/workflows/release.yml/badge.svg
    :target: https://github.com/django-import-export/django-import-export/actions/workflows/release.yml
    :alt: Build status on Github

.. |coveralls| image:: https://coveralls.io/repos/github/django-import-export/django-import-export/badge.svg?branch=main
    :target: https://coveralls.io/github/django-import-export/django-import-export?branch=main

.. |pypi| image:: https://img.shields.io/pypi/v/django-import-export.svg
    :target: https://pypi.org/project/django-import-export/
    :alt: Current version on PyPi

.. |docs| image:: http://readthedocs.org/projects/django-import-export/badge/?version=stable
    :target: https://django-import-export.readthedocs.io/en/stable/
    :alt: Documentation

.. |pyver| image:: https://img.shields.io/pypi/pyversions/django-import-export
    :alt: PyPI - Python Version

.. |djangover| image:: https://img.shields.io/pypi/djversions/django-import-export
    :alt: PyPI - Django Version

.. |downloads| image:: https://static.pepy.tech/personalized-badge/django-import-export?period=month&units=international_system&left_color=black&right_color=blue&left_text=Downloads/month
    :target: https://pepy.tech/project/django-import-export

.. |xfollow| image:: https://img.shields.io/twitter/url/https/twitter.com/django_import.svg?style=social&label=Follow%20%40django_import
   :alt: Follow us on X
   :target: https://twitter.com/django_import

.. |discord|  image:: https://img.shields.io/discord/1240294048653119508?style=flat
   :alt: Discord

|build| |coveralls| |pypi| |docs| |pyver| |djangover| |downloads| |xfollow| |discord|

Introduction
============

Straightforward, reliable and comprehensive file import / export for your Django application.

*django-import-export* is an application and library which lets you manage import / export from / to a variety of sources (csv, xlsx, json etc).

Can be run programmatically, or with optional integration with the Django Admin site:

..
  source of this video uploaded to this issue comment:
  https://github.com/django-import-export/django-import-export/pull/1833#issuecomment-2118777440

https://github.com/django-import-export/django-import-export/assets/6249838/ab56d8ba-c307-4bdf-8fa9-225669c72b37

`Screenshots <https://django-import-export.readthedocs.io/en/latest/screenshots.html>`_

Features
========

* Import / export via `Admin UI Integration <https://django-import-export.readthedocs.io/en/latest/admin_integration.html>`_ or `programmatically <https://django-import-export.readthedocs.io/en/latest/getting_started.html#importing-data>`_
* Import to and from a variety of file formats (csv, json, xlsx, pandas, HTML, YAML... and anything else that `tablib <https://github.com/jazzband/tablib>`_ supports)
* `Preview <https://django-import-export.readthedocs.io/en/latest/screenshots.html/>`_ data before importing in Admin UI
* Support for `bulk import <https://django-import-export.readthedocs.io/en/latest/bulk_import.html>`_
* Handles `CRUD (and 'skip') operations during import <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#create-or-update-model-instances>`_
* Flexible handling of `foreign key <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#importing-model-relations>`_ relationships
* `Many-to-many relationship <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#many-to-many-relations>`_ support
* `Validation <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#validation-during-import>`_ of imported data
* Define custom `transformations <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#advanced-data-manipulation-on-export>`_ for exported data
* Import / export the same model instance as `different views <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#customize-resource-options>`_
* Export using `natural keys <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#django-natural-keys>`__ for portability between environments
* `Select items for export <https://django-import-export.readthedocs.io/en/latest/screenshots.html/>`_ via the Admin UI object list
* `Select fields for export <https://django-import-export.readthedocs.io/en/latest/screenshots.html/>`_ via the export form
* `Export single object instances <https://django-import-export.readthedocs.io/en/latest/admin_integration.html#export-from-model-instance-change-form>`_
* Use `django permissions <https://django-import-export.readthedocs.io/en/latest/installation.html#import-export-import-permission-code>`_ to control import / export authorization
* Internationalization support
* Based on `tablib <https://github.com/jazzband/tablib>`__
* Support for MySQL / PostgreSQL / SQLite
* Extensible - `add custom logic to control import / export <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html>`_
* Handle import from various character encodings
* `Celery <https://django-import-export.readthedocs.io/en/latest/celery.html>`_ integration
* Test locally with `Docker <https://django-import-export.readthedocs.io/en/latest/testing.html>`_
* Comprehensive `documentation <https://django-import-export.readthedocs.io/en/latest/index.html>`__
* `Extensible API <https://django-import-export.readthedocs.io/en/latest/api_admin.html>`_
* test coverage :100:
* Supports dark mode :rocket:

Example use-cases
=================

*django-import-export* is designed to be extensible and can be used to support a variety of operations.
Here are some examples of how it has been used in the wild:

* Configure external cron jobs to run an import or export at set times
* Use `permissions <https://django-import-export.readthedocs.io/en/latest/installation.html#import-export-import-permission-code>`_ to define a subset of users able to import and export project data
* Safely update project reference data by importing from version controlled csv
* Create portable data to transfer between environments using `natural keys <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#django-natural-keys>`_
* Manage user access to an application by importing externally version controlled auth user lists
* Add `hooks <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#advanced-data-manipulation-on-export>`_ to anonymize data on export
* `Modify import / export UI forms <https://django-import-export.readthedocs.io/en/latest/admin_integration.html#customize-admin-import-forms>`_ to add dynamic filtering on import / export.

Getting started
===============

* `Installation <https://django-import-export.readthedocs.io/en/latest/installation.html>`_
* `Getting started <https://django-import-export.readthedocs.io/en/latest/getting_started.html>`__
* `Example application <https://django-import-export.readthedocs.io/en/latest/installation.html#exampleapp>`_

Help and support
================

* `Documentation <https://django-import-export.readthedocs.io/en/latest/>`_
* `FAQ <https://django-import-export.readthedocs.io/en/latest/faq.html>`_
* `Getting help <https://django-import-export.readthedocs.io/en/latest/faq.html#what-s-the-best-way-to-communicate-a-problem-question-or-suggestion>`_
* `Contributing <https://django-import-export.readthedocs.io/en/latest/faq.html#how-can-i-help>`_
* Become a `sponsor <https://github.com/sponsors/django-import-export>`_
* `Raise a security issue <https://github.com/django-import-export/django-import-export/blob/main/SECURITY.md>`_
* Join our `discord <https://discord.gg/aCcec52kY4>`_

Commercial support
==================

Commercial support is provided by `Bellaport Systems Ltd <https://www.bellaport.co.uk>`_

Releases
========

* `Release notes <https://django-import-export.readthedocs.io/en/latest/release_notes.html>`_
* `Changelog <https://django-import-export.readthedocs.io/en/latest/changelog.html>`_


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "django-import-export",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Matthew Hegarty <djangoimportexport@gmail.com>",
    "keywords": "django, import, export",
    "author": null,
    "author_email": "Bojan Mihela\u010d <djangoimportexport@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/11/b5/5b4878b08526d96e74a76f05d431973e5ca2cb42d68686a84aaa517a74ce/django_import_export-4.0.6.tar.gz",
    "platform": "OS Independent",
    "description": "====================\ndjango-import-export\n====================\n\n.. |build| image:: https://github.com/django-import-export/django-import-export/actions/workflows/release.yml/badge.svg\n    :target: https://github.com/django-import-export/django-import-export/actions/workflows/release.yml\n    :alt: Build status on Github\n\n.. |coveralls| image:: https://coveralls.io/repos/github/django-import-export/django-import-export/badge.svg?branch=main\n    :target: https://coveralls.io/github/django-import-export/django-import-export?branch=main\n\n.. |pypi| image:: https://img.shields.io/pypi/v/django-import-export.svg\n    :target: https://pypi.org/project/django-import-export/\n    :alt: Current version on PyPi\n\n.. |docs| image:: http://readthedocs.org/projects/django-import-export/badge/?version=stable\n    :target: https://django-import-export.readthedocs.io/en/stable/\n    :alt: Documentation\n\n.. |pyver| image:: https://img.shields.io/pypi/pyversions/django-import-export\n    :alt: PyPI - Python Version\n\n.. |djangover| image:: https://img.shields.io/pypi/djversions/django-import-export\n    :alt: PyPI - Django Version\n\n.. |downloads| image:: https://static.pepy.tech/personalized-badge/django-import-export?period=month&units=international_system&left_color=black&right_color=blue&left_text=Downloads/month\n    :target: https://pepy.tech/project/django-import-export\n\n.. |xfollow| image:: https://img.shields.io/twitter/url/https/twitter.com/django_import.svg?style=social&label=Follow%20%40django_import\n   :alt: Follow us on X\n   :target: https://twitter.com/django_import\n\n.. |discord|  image:: https://img.shields.io/discord/1240294048653119508?style=flat\n   :alt: Discord\n\n|build| |coveralls| |pypi| |docs| |pyver| |djangover| |downloads| |xfollow| |discord|\n\nIntroduction\n============\n\nStraightforward, reliable and comprehensive file import / export for your Django application.\n\n*django-import-export* is an application and library which lets you manage import / export from / to a variety of sources (csv, xlsx, json etc).\n\nCan be run programmatically, or with optional integration with the Django Admin site:\n\n..\n  source of this video uploaded to this issue comment:\n  https://github.com/django-import-export/django-import-export/pull/1833#issuecomment-2118777440\n\nhttps://github.com/django-import-export/django-import-export/assets/6249838/ab56d8ba-c307-4bdf-8fa9-225669c72b37\n\n`Screenshots <https://django-import-export.readthedocs.io/en/latest/screenshots.html>`_\n\nFeatures\n========\n\n* Import / export via `Admin UI Integration <https://django-import-export.readthedocs.io/en/latest/admin_integration.html>`_ or `programmatically <https://django-import-export.readthedocs.io/en/latest/getting_started.html#importing-data>`_\n* Import to and from a variety of file formats (csv, json, xlsx, pandas, HTML, YAML... and anything else that `tablib <https://github.com/jazzband/tablib>`_ supports)\n* `Preview <https://django-import-export.readthedocs.io/en/latest/screenshots.html/>`_ data before importing in Admin UI\n* Support for `bulk import <https://django-import-export.readthedocs.io/en/latest/bulk_import.html>`_\n* Handles `CRUD (and 'skip') operations during import <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#create-or-update-model-instances>`_\n* Flexible handling of `foreign key <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#importing-model-relations>`_ relationships\n* `Many-to-many relationship <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#many-to-many-relations>`_ support\n* `Validation <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#validation-during-import>`_ of imported data\n* Define custom `transformations <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#advanced-data-manipulation-on-export>`_ for exported data\n* Import / export the same model instance as `different views <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#customize-resource-options>`_\n* Export using `natural keys <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#django-natural-keys>`__ for portability between environments\n* `Select items for export <https://django-import-export.readthedocs.io/en/latest/screenshots.html/>`_ via the Admin UI object list\n* `Select fields for export <https://django-import-export.readthedocs.io/en/latest/screenshots.html/>`_ via the export form\n* `Export single object instances <https://django-import-export.readthedocs.io/en/latest/admin_integration.html#export-from-model-instance-change-form>`_\n* Use `django permissions <https://django-import-export.readthedocs.io/en/latest/installation.html#import-export-import-permission-code>`_ to control import / export authorization\n* Internationalization support\n* Based on `tablib <https://github.com/jazzband/tablib>`__\n* Support for MySQL / PostgreSQL / SQLite\n* Extensible - `add custom logic to control import / export <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html>`_\n* Handle import from various character encodings\n* `Celery <https://django-import-export.readthedocs.io/en/latest/celery.html>`_ integration\n* Test locally with `Docker <https://django-import-export.readthedocs.io/en/latest/testing.html>`_\n* Comprehensive `documentation <https://django-import-export.readthedocs.io/en/latest/index.html>`__\n* `Extensible API <https://django-import-export.readthedocs.io/en/latest/api_admin.html>`_\n* test coverage :100:\n* Supports dark mode :rocket:\n\nExample use-cases\n=================\n\n*django-import-export* is designed to be extensible and can be used to support a variety of operations.\nHere are some examples of how it has been used in the wild:\n\n* Configure external cron jobs to run an import or export at set times\n* Use `permissions <https://django-import-export.readthedocs.io/en/latest/installation.html#import-export-import-permission-code>`_ to define a subset of users able to import and export project data\n* Safely update project reference data by importing from version controlled csv\n* Create portable data to transfer between environments using `natural keys <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#django-natural-keys>`_\n* Manage user access to an application by importing externally version controlled auth user lists\n* Add `hooks <https://django-import-export.readthedocs.io/en/latest/advanced_usage.html#advanced-data-manipulation-on-export>`_ to anonymize data on export\n* `Modify import / export UI forms <https://django-import-export.readthedocs.io/en/latest/admin_integration.html#customize-admin-import-forms>`_ to add dynamic filtering on import / export.\n\nGetting started\n===============\n\n* `Installation <https://django-import-export.readthedocs.io/en/latest/installation.html>`_\n* `Getting started <https://django-import-export.readthedocs.io/en/latest/getting_started.html>`__\n* `Example application <https://django-import-export.readthedocs.io/en/latest/installation.html#exampleapp>`_\n\nHelp and support\n================\n\n* `Documentation <https://django-import-export.readthedocs.io/en/latest/>`_\n* `FAQ <https://django-import-export.readthedocs.io/en/latest/faq.html>`_\n* `Getting help <https://django-import-export.readthedocs.io/en/latest/faq.html#what-s-the-best-way-to-communicate-a-problem-question-or-suggestion>`_\n* `Contributing <https://django-import-export.readthedocs.io/en/latest/faq.html#how-can-i-help>`_\n* Become a `sponsor <https://github.com/sponsors/django-import-export>`_\n* `Raise a security issue <https://github.com/django-import-export/django-import-export/blob/main/SECURITY.md>`_\n* Join our `discord <https://discord.gg/aCcec52kY4>`_\n\nCommercial support\n==================\n\nCommercial support is provided by `Bellaport Systems Ltd <https://www.bellaport.co.uk>`_\n\nReleases\n========\n\n* `Release notes <https://django-import-export.readthedocs.io/en/latest/release_notes.html>`_\n* `Changelog <https://django-import-export.readthedocs.io/en/latest/changelog.html>`_\n\n",
    "bugtrack_url": null,
    "license": "Copyright (c) Bojan Mihelac and individual contributors. All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "Django application and library for importing and exporting data with included admin integration.",
    "version": "4.0.6",
    "project_urls": {
        "Changelog": "https://github.com/django-import-export/django-import-export/blob/main/docs/changelog.rst",
        "Documentation": "https://django-import-export.readthedocs.io/en/stable/",
        "Repository": "https://github.com/django-import-export/django-import-export"
    },
    "split_keywords": [
        "django",
        " import",
        " export"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7f1c443d9212f43cc40dd73faffa37e8d7a754badf9b0db787300ed2cf739e87",
                "md5": "30b432f02613fe6ed5e7ad36d76a05a3",
                "sha256": "7b170abd992c071fa221fa6bf1822abfee1518720d07cedeba4702bbac5f119d"
            },
            "downloads": -1,
            "filename": "django_import_export-4.0.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "30b432f02613fe6ed5e7ad36d76a05a3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 133568,
            "upload_time": "2024-05-27T09:35:33",
            "upload_time_iso_8601": "2024-05-27T09:35:33.799217Z",
            "url": "https://files.pythonhosted.org/packages/7f/1c/443d9212f43cc40dd73faffa37e8d7a754badf9b0db787300ed2cf739e87/django_import_export-4.0.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "11b55b4878b08526d96e74a76f05d431973e5ca2cb42d68686a84aaa517a74ce",
                "md5": "e3c3a41857c9009e7664bca6ef082ad6",
                "sha256": "098ab4943edb93d6333aa8f6c97fb6a527d1d70a57f6a014f615c6f5ff5dd559"
            },
            "downloads": -1,
            "filename": "django_import_export-4.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "e3c3a41857c9009e7664bca6ef082ad6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 2350245,
            "upload_time": "2024-05-27T09:35:36",
            "upload_time_iso_8601": "2024-05-27T09:35:36.497022Z",
            "url": "https://files.pythonhosted.org/packages/11/b5/5b4878b08526d96e74a76f05d431973e5ca2cb42d68686a84aaa517a74ce/django_import_export-4.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-27 09:35:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "django-import-export",
    "github_project": "django-import-export",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "django-import-export"
}
        
Elapsed time: 0.33793s