Skip to main content

aurorae

PyPi version PyPI - Python Version CI Coverage Status Documentation Status License: MIT

aurorae is a tool to generate fixed-width CNAB240 files to perform bulk payments.

aurorae does...

  • Generates CNAB240 files for bulk payments
  • Allows easy extension of different types of input files

aurorae does not...

  • Address charge or as Brazilian banks call "cobrança"
  • Address payments by PIX, we only support payments through bank information

But, pull requests are welcomed.

How It Works

aurorae uses Python type hinting for data validation and generation of fixed-width CNAB 240 files. The library receives as inputs an spreadsheet that must be a match of the Pydantic model Spreadsheet, a general handler parses the initial data to an intermediary representation used by the CNAB240 module to generate files. Different types of inputs are supported by library through the creation of new providers, check the spreadsheet provider for an example.

The historic and architecture details can be found on the project's ADRs.

Requirements

  • Python (>3)
  • openpyxl (3.0.7)
  • pydantic (>1.8.2)

Installation

pip install aurorae

Usage

To run aurorae with test data:

generate_cnab_sample

To run aurorae with your own data use:

generate_cnab_sample ~/source_spreadsheet.xlsx

Documentation

https://aurorae.readthedocs.io

Security

We take aurorae's security and our users' trust seriously, therefore we do not save any information (from payments or not) sent by users. If you believe you have found a security issue, please responsibly disclose by contacting: flavio@vinta.com.br

Releases

See CHANGELOG.md.

Credits

This project is maintained by open-source contributors and Vinta Software.

Commercial Support

Vinta Software is always looking for exciting work, so if you need any commercial support, feel free to get in touch: contact@vinta.com.br

Metadata

Release files for aurorae 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aurorae 0.0.2
File Size Uploaded Provenance
aurorae-0.0.2.tar.gz 41.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for aurorae 0.0.2
File Interpreter ABI Platform
aurorae-0.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 84.4 kB

Release files / aurorae-0.0.2.tar.gz

Download URL aurorae-0.0.2.tar.gz
Size 41.3 kB
Tags Source
SHA-256 checksum
How to use checksums
7e38c67ebf6dd56268de462e8f51c6f1630256a8bf95a2ebd89bafe472647db9
BLAKE2b-256 checksum
How to use checksums
ea2cfd7a7ecf9018e359f4e821b7390be1e7c9dff20080c132df79aabf26b677
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.7 CPython/3.7.9 Linux/5.11.0-27-generic

Release files / aurorae-0.0.2-py3-none-any.whl

Download URL aurorae-0.0.2-py3-none-any.whl
Size 43.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
416c8ca6827726b5aa1e61018874244ce40f3a0629572f588f852adfa255bc33
BLAKE2b-256 checksum
How to use checksums
f004242a69872c0d80af3cc7ee577d232c66247e9cb23e93d5fadf97b458ab64
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.7 CPython/3.7.9 Linux/5.11.0-27-generic

Security for aurorae 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page