Welcome to caixabreak’s documentation!¶

Contents:

caixabreak¶

Free software: MIT license
Documentation: https://caixabreak.readthedocs.io.
Work in progress: New features will be available soon

About¶

Extracts data from Caixa Geral de Depositos - Caixa Break management interface.

Install¶

pip install caixabreak

Note: You must request the login credentials on a CGD ATM machine first.

How-to¶

caixabreak --help

Usage: caixabreak [OPTIONS]

  Extracts data from CGD - Caixa Break management interface.

  Optional: Use environment variables instead of command line arguments
  (CGD_USER and CGD_PASS).

Options:
  -u, --username TEXT  Access code for your account (7 digits)
  -p, --password TEXT  Password for your account (5 digits)
  -b, --balance        Show current balance
  -t, --transactions   Show current transactions
  --debug              Enable debug
  --help               Show this message and exit.

Features¶

Show current card balance
Show table of transactions

Credits¶

Disclamer¶

This application is not affiliated with CGD in any way.

Installation¶

Stable release¶

To install caixabreak, run this command in your terminal:

$ pip install caixabreak

This is the preferred method to install caixabreak, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for caixabreak can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/kintoandar/caixabreak

Or download the tarball:

$ curl  -OL https://github.com/kintoandar/caixabreak/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage¶

To use caixabreak in a project:

import caixabreak

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/kintoandar/caixabreak/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

caixabreak could always use more documentation, whether as part of the official caixabreak docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/kintoandar/caixabreak/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up caixabreak for local development.

Fork the caixabreak repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/caixabreak.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv caixabreak
$ cd caixabreak/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 caixabreak tests
$ python setup.py test or py.test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/kintoandar/caixabreak/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_caixabreak