2023-04-04 18:17:44 +08:00
|
|
|
===============
|
|
|
|
|
Mia! Accounting
|
|
|
|
|
===============
|
2023-01-29 22:28:27 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
===========
|
|
|
|
|
|
2023-04-06 02:31:03 +08:00
|
|
|
*Mia! Accounting* is an accounting module for Flask_ applications.
|
2023-04-11 21:33:51 +08:00
|
|
|
It is designed both for mobile and desktop environments. It
|
|
|
|
|
implements `double-entry bookkeeping`_. It generates the following
|
2023-04-06 02:31:03 +08:00
|
|
|
accounting reports:
|
2023-01-29 22:28:27 +08:00
|
|
|
|
2023-04-06 02:31:03 +08:00
|
|
|
* Trial balance
|
|
|
|
|
* Income statement
|
|
|
|
|
* Balance sheet
|
2023-01-29 22:28:27 +08:00
|
|
|
|
2023-04-06 02:31:03 +08:00
|
|
|
In addition, *Mia! Accounting* tracks offsets for unpaid payables and
|
|
|
|
|
receivables.
|
|
|
|
|
|
|
|
|
|
|
2023-04-11 21:33:51 +08:00
|
|
|
Live Demonstration and Test Site
|
|
|
|
|
================================
|
|
|
|
|
|
|
|
|
|
There is a `live demonstration`_ for *Mia! Accounting*. It runs the
|
|
|
|
|
same code as the `test site`_ in the `source distribution`_. It is
|
|
|
|
|
the simplest website that works with *Mia! Accounting*. It is also
|
|
|
|
|
used in the automatic tests.
|
|
|
|
|
|
|
|
|
|
If you do not have a running Flask application or do not know how to
|
|
|
|
|
start one, you may start with the test site.
|
|
|
|
|
|
|
|
|
|
|
2023-04-06 02:31:03 +08:00
|
|
|
Installation
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
Install *Mia! Accounting* with ``pip``:
|
2023-01-29 22:28:27 +08:00
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
2023-04-05 09:57:34 +08:00
|
|
|
pip install mia-accounting
|
|
|
|
|
|
2023-04-11 21:33:51 +08:00
|
|
|
You may also download from the `PyPI project page`_ or the
|
2023-04-06 02:31:03 +08:00
|
|
|
`release page`_ on the `Git repository`_.
|
|
|
|
|
|
|
|
|
|
|
2023-04-23 18:16:05 +08:00
|
|
|
Documentation
|
2023-04-06 02:31:03 +08:00
|
|
|
=============
|
|
|
|
|
|
2023-04-23 18:16:05 +08:00
|
|
|
Refer to the `documentation on Read the Docs`_.
|
2023-04-06 02:31:03 +08:00
|
|
|
|
|
|
|
|
|
2023-04-23 18:16:05 +08:00
|
|
|
Change Log
|
|
|
|
|
==========
|
2023-04-06 02:31:03 +08:00
|
|
|
|
2023-04-23 18:16:05 +08:00
|
|
|
Refer to the `change log`_.
|
2023-04-05 14:25:33 +08:00
|
|
|
|
|
|
|
|
|
2023-01-29 22:28:27 +08:00
|
|
|
Copyright
|
|
|
|
|
=========
|
|
|
|
|
|
2024-03-03 07:38:32 +08:00
|
|
|
Copyright (c) 2023-2024 imacat.
|
2023-01-29 22:28:27 +08:00
|
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
|
you may not use this file except in compliance with the License.
|
|
|
|
|
You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Authors
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
| imacat
|
|
|
|
|
| imacat@mail.imacat.idv.tw
|
|
|
|
|
| 2023/1/27
|
|
|
|
|
|
2023-04-06 02:31:03 +08:00
|
|
|
|
2023-01-29 22:28:27 +08:00
|
|
|
.. _Flask: https://flask.palletsprojects.com
|
2023-04-06 02:31:03 +08:00
|
|
|
.. _double-entry bookkeeping: https://en.wikipedia.org/wiki/Double-entry_bookkeeping
|
2023-04-11 21:33:51 +08:00
|
|
|
.. _live demonstration: https://accounting.imacat.idv.tw
|
2023-04-06 09:51:50 +08:00
|
|
|
.. _test site: https://github.com/imacat/mia-accounting/tree/main/tests/test_site
|
|
|
|
|
.. _source distribution: https://pypi.org/project/mia-accounting/#files
|
2023-04-06 08:31:19 +08:00
|
|
|
.. _PyPI project page: https://pypi.org/project/mia-accounting
|
|
|
|
|
.. _release page: https://github.com/imacat/mia-accounting/releases
|
|
|
|
|
.. _Git repository: https://github.com/imacat/mia-accounting
|
2023-04-06 02:31:03 +08:00
|
|
|
.. _documentation on Read the Docs: https://mia-accounting.readthedocs.io
|
2023-04-23 18:16:05 +08:00
|
|
|
.. _change log: https://mia-accounting.readthedocs.io/en/latest/changelog.html
|
