Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/testing_and_coverage_upload.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ jobs:
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python 3.8
- name: Set up Python 3.9
uses: actions/setup-python@v5
with:
python-version: 3.8
python-version: 3.9
- name: Install Poetry Action
uses: snok/install-poetry@v1.3.4
#----------------------------------------------
Expand Down
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,25 @@
<!-- Codecov Coverage Badge -->
[![codecov](https://codecov.io/gh/Lars147/pykitty/graph/badge.svg?token=TOY40XZ1QU)](https://codecov.io/gh/Lars147/pykitty)

<!-- Sonar Cloud Quality Badge -->
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Lars147_pykitty&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Lars147_pykitty)

# PyKitty

This Python SDK allows you to interact with [KittySplit](https://kittysplit.de/) to manage expenses in a group. You can fetch a list of users, select a user and add expenses.

## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Get Users](#get-users)
- [Select User](#select-user)
- [Add Expense](#add-expense)
- [Get Expenses](#get-expenses)
- [Get Single Expense Details](#get-single-expense-details)
- [Delete Expense](#delete-expense)
- [License](#license)
- [Next Steps (TODO)](#next-steps-todo)

## Installation

To install the package, use the following command:
Expand All @@ -21,6 +37,7 @@ Create your first expense with the following code (replace `<kitty_URL>` and `<y

```python
from pykitty import KittySplitAPI

api = KittySplitAPI("<kitty_URL>")
api.select_user("<your_username>")
api.add_expense(
Expand Down Expand Up @@ -101,6 +118,15 @@ api.get_expense("8233711") # expense_id can be found in URL
api.delete_expense("8233711") # expense_id can be found in URL
```

## Command Line Interface (CLI)

### Get Users

To install the CLI, you can use pip:

```bash
pip install kittysplit-cli

## License

This project is licensed under the MIT License.
Expand Down
Loading
Loading