Giter VIP home page Giter VIP logo

django-importcsvadmin's Introduction

django-importcsvadmin

Allow the user to import models from a CSV file in the django admin site.

Basic Usage

To enable CSV import for a model, simply subclass ImportCSVModelAdmin, set its importer_class to a ModelForm subclass, and register it as the ModelAdmin for your model.

Each row of CSV data will be loaded into an importer_class form which must have a Meta.fields attribute which matches the data and order of the CSV file.

The entire CSV import operation will be wrapped in an atomic transaction, and will only write to the database if all rows pass validation.

Basic example:

from django.contrib import admin
from django.forms import ModelForm

from importcsvadmin.admin import ImportCSVModelAdmin

from my_app.models import MyModel


class MyAdminImporter(ModelForm):
    class Meta:
        model = MyModel
        fields = ('first_field', 'second_field', 'third_field')


class MyAdminForm(ModelForm):
    class Meta:
        model = MyModel
        fields = ('first_field', 'second_field', 'third_field')


class MyAdmin(ImportCSVModelAdmin):
    importer_class = MyAdminImporter
    form = MyAdminForm


admin.site.register(MyModel, MyAdmin)

django-importcsvadmin's People

Contributors

acatton avatar julianandrews avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

django-importcsvadmin's Issues

Feature: I need the ability to validate everything before saving.

In the situation of redirects, for example, I would like to validate all of the rows before any are saved. This would allow me to make sure there are no circular redirects. I also think it's good usability not to insert any of them before checking that all of them pass validation.

I was thinking that process_row could become validate_row or even clean_row (then we could also consider it as a hook for fixing some of the data).

Somewhat related:

Also, would it be possible to use form non-field errors instead of the messages framework? I know that it might be a big change, but would it be possible to move the import logic to the Form instead of the View? That would have several advantages:

  • We could take the Form in use it outside of the admin in a normal FormView.
  • clean_row could live on the form, and be a part of the normal validation flow
  • The obvious place to the circular redirect check is now clean.

Add installation instructions in the README

Hi,
Maybe one should add pip install git+https://github.com/fusionbox/django-importcsvadmin.git to the README for installation instructions. Because it's not always obvious to everyone how to install. Thanks.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.