visibudget 0.1.0
Visual budget management
License: Apache License 2.0

VisiBudget: Visual budget management
====================================

.. image:: https://img.shields.io/pypi/v/visibudget.svg
    :target: https://pypi.python.org/pypi/visibudget

.. image:: https://img.shields.io/pypi/l/visibudget.svg
    :target: https://pypi.python.org/pypi/visibudget

.. image:: https://img.shields.io/pypi/pyversions/visibudget.svg
    :target: https://pypi.python.org/pypi/visibudget

.. image:: https://codecov.io/gh/deriamis/visibudget/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/deriamis/visibudget
    :alt: codecov.io

.. image:: https://img.shields.io/github/contributors/deriamis/visibudget.svg
    :target: https://github.com/deriamis/visibudget/graphs/contributors

.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
    :target: https://saythanks.io/to/deriamis

VisiBudget helps you "see" your budget working over time.

VisiBudget is a new kind of budget management system. It isn't concerned with double-entry accounting (though it does
this behind the scenes), nor does it try to do everything for you. Instead, VisiBudget helps you to visualize the effect
of spending your money on your paycheck so you always know how much money you have and what it can be used for.

If you have ever used another budget management system, you've probably seen that they either get very complicated very
quickly, trying to make everything "easy" for you, or they leave all the hard work up to you. VisiBudget only tries to
help you keep track of the money coming in, what account it goes into, where it goes out later and when, and how much
you have spent and have left over. Your spending is mapped out on a calendar so you can easily see how much you will
have on a given date and how far you've progressed towards your savings goals.

Installation
------------

To install VisiBudget, simply use `pipenv <http://pipenv.org/>`_ (or pip, of course):

.. code-block:: bash

    $ pipenv install visibudget

How to Contribute
-----------------

#. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a `good first issue`_ tag for issues that should be ideal for people who are not very familiar with the codebase yet.
#. Fork `the repository`_ on GitHub to start making your changes to the **master** branch (or branch off of it).
#. Write a test which shows that the bug was fixed or that the feature works as expected.
#. Send a pull request and bug the maintainer until it gets merged and published.

.. _`the repository`: http://github.com/deriamis/visibudget
.. _`good first issue`: https://github.com/deriamis/visibudget/issues?direction=desc&labels=good+first+issue&page=1&sort=updated&state=open

Thanks!
-------

The skeleton for this project borrows heavily from work already done by
`Kenneth Reitz`_. I would have had a much tougher time putting this
together if he hadn't already done a lot of it already. If you `thank me`_
for this project, please also `thank Kenneth`_ as well!

.. _`Kenneth Reitz`: https://www.kennethreitz.org/
.. _`thank me`: https://saythanks.io/to/deriamis
.. _`thank Kenneth`: https://saythanks.io/to/kennethreitz

.. :changelog:

Release History
---------------

0.1.0 (2019-01-04)
------------------

Initial commits, laying out the project structure.