@tresor.one/import

    2.17.1 • Public • Published

    Parqet-Import - The open source import of Parqet

    This is the PDF and CSV Import used on Parqet.com. This software is meant to be reviewed for transparency and security by users of Parqet. Use of this library is granted for private, non-commercial, open-source products.
    For a commercial license for closed-source projects, contact sumit@parqet.com

    Supported Brokers

    All brokers supported by tresor-import are listed in the documentation.

    Installation

    npm install @tresor.one/import

    Usage

    import getActivities from '@tresor.one/import';
    
    async fileHandler() {
      const results = await Promise.all(Array.from(this.$refs.myFiles.files).map(getActivities));
      results.forEach(result => {
        console.log(result);
      });
    }

    The function getActivities returns an objects with the following fields:

    Name Description
    file The file name of the input file.
    activities List of activities which was parsed from the input file. The activity object is broken down here.
    status The status code which contains the information about the reason why no activities was found. For Details see the status table.
    successful The simple way to check if at least one activity was found and the status code is equals zero.

    The status field can contains one of the following values, described here.

    How to calculate the amount

    To understand the amount calculation please read the amount documentation here (in German).

    Contribute

    To contribute:

    1. fork the repo
    2. install and start npm i && npm start
    3. open the logged URL, usually http://localhost:5000, in your browser
    4. Import a PDF. Content is shown in your Javascript console
    5. Write a parser in src/brokers to parse that content - see src/brokers/comdirect.js for inspiration
    6. Add and run all tests npm t
    7. Create a Pull Request

    Licensing

    Usage of this codebase is permitted according to the GNU Affero General Public License v3 (AGPL-3.0).

    HERE'S AN INCOMPLETE SUMMARY. READ THE FULL LICENSE BEFORE USING.

    • You are permitted to:
      • Use this codebase in any way you want including commercially
      • Modify and distribute the codebase in any way you want
    • You MUST:
      • Respect the copyright which is held by the maintainers of this project
      • Disclose all changes you made to the code and also publish any code directly based on this code
      • Give attribution to the original maintainers when using this project (especially when used commercially)
    • You can not
      • Sublicense this codebase
      • Expect any liability, warranty or similar by the original maintainers. However, we want to improve this project as much as possible so feedback is heard!

    See also the following image, taken from TL;DR Legal. apgl3 Overview from TL;DR Legal

    Install

    npm i @tresor.one/import

    DownloadsWeekly Downloads

    96

    Version

    2.17.1

    License

    AGPLv3

    Unpacked Size

    1.43 MB

    Total Files

    4

    Last publish

    Collaborators

    • npmofsumit