diff --git a/CHANGELOG.md b/CHANGELOG.md index 176c040..e457c31 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,5 +8,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ... -## [0.0.1] - 2014-05-31 -### First release \ No newline at end of file +## [0.0.1] - 2021-08-20 +### First release diff --git a/README.md b/README.md index 320e3f9..28994a5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # aurorae +[![PyPi version](https://img.shields.io/pypi/v/aurorae.svg)](https://pypi.python.org/pypi/aurorae) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aurorae)](https://pypi.org/project/aurorae/) [![CI](https://github.com/vintasoftware/aurorae/actions/workflows/actions.yaml/badge.svg)](https://github.com/vintasoftware/aurorae/actions/workflows/actions.yaml) [![Coverage Status](https://coveralls.io/repos/github/vintasoftware/aurorae/badge.svg?branch=main)](https://coveralls.io/github/vintasoftware/aurorae?branch=main) [![Documentation Status](https://readthedocs.org/projects/aurorae/badge/?version=latest)](https://aurorae.readthedocs.io/en/latest/?badge=latest) @@ -28,12 +30,27 @@ The historic and architecture details can be found on the [project's ADRs](https - openpyxl (3.0.7) - pydantic (>1.8.2) +## Installation + +``` +pip install aurorae +``` + ## Usage To run aurorae with test data: ```bash generate_cnab_sample ``` +To run aurorae with your own data use: + +```bash +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](flavio@vinta.com.br) diff --git a/docs/dev/authors.rst b/docs/dev/authors.rst index 43403b4..7d9e079 100644 --- a/docs/dev/authors.rst +++ b/docs/dev/authors.rst @@ -1,2 +1,18 @@ Authors =============== + +Development Lead +---------------- + +aurorae is maintained by `Vinta Software `_. Lead maintainers: + +* Mariane Pastor (Vinta Software) +* Rebeca Sarai (Vinta Software) +* Thiago Paim (Vinta Software) +* Jaênia Sousa (Vinta Software) +* Marcos Felipe <@marcosflp> + +Contributors +------------ + +None yet. Why not be the first? diff --git a/docs/guide/introduction.rst b/docs/guide/introduction.rst index 8bd679a..e63e23c 100644 --- a/docs/guide/introduction.rst +++ b/docs/guide/introduction.rst @@ -35,6 +35,7 @@ CNAB versions The versions of the file are identified through a code with the following composition: VV.R + * VV: Version number * R: Release number @@ -44,7 +45,7 @@ File Structure -------------- The exchange file is composed of a file header record, one or more -Service/Product batches and a file trailer record. +service/product batches and a file trailer record. :: @@ -60,9 +61,10 @@ Service/Product batches and a file trailer record. A single file can contain multiple batches of different Services. Each of the items described above represent one line of the file with the size of 240 bytes. Individuals fields for each line are aligned -according to the type of the field: - Numeric Fields (Num) = Always on -the right and padded with zeros on the left. - Alphanumeric Fields -(Alpha) = Always on the left and filled with blanks on the right. +according to the type of the field: + +* Numeric Fields (Num) = Always on the right and padded with zeros on the left. +* Alphanumeric Fields (Alpha) = Always on the left and filled with blanks on the right. Payment via account credit ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/index.rst b/docs/index.rst index ddac8d9..3c84f7a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to aurorae's documentation! +Welcome to Aurorae's documentation! =================================== .. toctree::