~ocurero/python-ccb commit

2 files changed, 51 insertions(+), 0 deletions(-)

A => .github/README.md
M docs/requirements.txt

A => .github/README.md +48 -0

@@ 0,0 1,48 @@ 
+### WARNING, this repository is a read-only mirror!
+*See [sourcehut](https://sr.ht/~ocurero/python-ccb/) for PR and latest news*
+
+Python wrapper for ClearCheckBook
+=================================
+
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![builds.sr.ht status](https://builds.sr.ht/~ocurero/python-ccb/.build.yml.svg)](https://builds.sr.ht/~ocurero/python-ccb/.build.yml?) [![readthedocs](https://readthedocs.org/projects/python-ccb/badge/?version=latest&style=flat)](https://python-ccb.readthedocs.io/)
+
+This package provides a simple python interface for interacting with
+ClearCheckBook
+
+* Open Source: Apache 2.0 license.
+* Website: <https://sr.ht/~ocurero/python-ccb/>
+* Documentation: <https://python-ccb.readthedocs.io/>
+
+Quickstart
+----------
+
+Using **python-ccb** is very simple:
+
+```python
+
+    import ccb
+
+    session = ccb.ClearCheckBook('user', 'passwd')
+    account = ccb.get_account('My Account')
+    new_tran = ccb.Transaction('Something', 50, ccb.WITHDRAW, account=account)
+    session.insert_transaction(new_tran)
+
+```
+
+## What's implemented?
+
+| Feature        | Implemented? |
+| -------------- | ------------ |
+| Accounts       | YES          |
+| Account groups | NO           |
+| Bills          | NO           |
+| Budgets        | NO           |
+| Categories     | YES          |
+| Currencies     | YES          |
+| Object count   | NO           |
+| Premium        | NO           |
+| Transactions   | YES          |
+| Reminders      | NO           |
+| Reports        | NO           |
+
+

M docs/requirements.txt +3 -0

@@ 1,2 1,5 @@ 
+mkdocstrings==0.16.2; python_version >= "3.6" \
+    --hash=sha256:671fba8a6c7a8455562aae0a3fa85979fbcef261daec5b2bac4dd1479acc14df \
+    --hash=sha256:3d8a86c283dfa21818d5b9579aa4e750eea6b5c127b43ad8b00cebbfb7f9634e
 markdown-include==0.6.0 \
     --hash=sha256:6f5d680e36f7780c7f0f61dca53ca581bd50d1b56137ddcd6353efafa0c3e4a2