README.md

import me

Python tool for importing and validating data from xlsx/xls/csv files.

Example

from import_me import BaseXLSXParser, Column
from import_me.processors import StringProcessor, IntegerProcessor

>>> class XLSXParser(BaseXLSXParser):
...     columns = [
...         Column('first_name', index=0, header='First Name', processor=StringProcessor()),
...         Column('last_name', index=1, header='Last Name', processor=StringProcessor()),
...         Column('age', index=2, header='Age', processor=IntegerProcessor()),
...     ]

>>> parser = XLSXParser(file_path=xlsx_filepath)
>>> parser()
>>> print(parser.has_errors)  # False
>>> print(parser.cleaned_data)
[
    {
        'first_name': 'Ivan',
        'last_name': 'Ivanov',
        'age': 25,
        'row_index': 1,
    },
    {
        'first_name': 'Petr',
        'last_name': 'Petrov',
        'age': 33,
        'row_index': 2,
    },
]

Installation

pip install import_me

Contributing

We would love you to contribute to our project. It's simple:

• Create an issue with bug you found or proposal you have. Wait for approve from maintainer.
• Create a pull request. Make sure all checks are green.
• Fix review comments if any.
• Be awesome.

Here are useful tips:

• You can run all checks and tests with make check. Please do it before TravisCI does.
• We use BestDoctor python styleguide.
• We respect Django CoC. Make soft, not bullshit.