{"id":25400746,"url":"https://github.com/delitamakanda/banky","last_synced_at":"2026-02-15T16:07:07.628Z","repository":{"id":41950397,"uuid":"68143496","full_name":"delitamakanda/banky","owner":"delitamakanda","description":"budget api django and djangorestframework","archived":false,"fork":false,"pushed_at":"2025-12-10T09:25:49.000Z","size":22256,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-12-10T12:34:46.411Z","etag":null,"topics":["api-rest","budget","django","django-rest-framework","python313","token-based-authentication"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/delitamakanda.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-09-13T20:09:08.000Z","updated_at":"2025-12-10T09:25:50.000Z","dependencies_parsed_at":"2024-07-07T20:32:43.900Z","dependency_job_id":"57ea380d-566b-4586-b278-a41e7d33b717","html_url":"https://github.com/delitamakanda/banky","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/delitamakanda/banky","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delitamakanda%2Fbanky","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delitamakanda%2Fbanky/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delitamakanda%2Fbanky/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delitamakanda%2Fbanky/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/delitamakanda","download_url":"https://codeload.github.com/delitamakanda/banky/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delitamakanda%2Fbanky/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29483465,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-15T15:33:17.885Z","status":"ssl_error","status_checked_at":"2026-02-15T15:32:53.698Z","response_time":118,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","budget","django","django-rest-framework","python313","token-based-authentication"],"created_at":"2025-02-16T00:29:35.265Z","updated_at":"2026-02-15T16:07:07.623Z","avatar_url":"https://github.com/delitamakanda.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Banky – Budget App\n[![Django CI](https://github.com/delitamakanda/banky/actions/workflows/django.yml/badge.svg?branch=master\u0026event=push)](https://github.com/delitamakanda/banky/actions/workflows/django.yml)\n\nBanky is a Django-powered budgeting and current-account API designed to help teams prototype financial workflows such as deposits, withdrawals, and balance limits. The project exposes a REST API backed by [Django REST Framework](https://www.django-rest-framework.org/) and includes auto-generated documentation via [drf-spectacular](https://drf-spectacular.readthedocs.io/).\n\n## Table of contents\n- [Features](#features)\n- [Project structure](#project-structure)\n- [Requirements](#requirements)\n- [Quick start](#quick-start)\n  - [1. Clone and configure the project](#1-clone-and-configure-the-project)\n  - [2. Apply database migrations](#2-apply-database-migrations)\n  - [3. Create an admin user](#3-create-an-admin-user)\n  - [4. Launch the development server](#4-launch-the-development-server)\n- [Running the tests](#running-the-tests)\n- [API documentation](#api-documentation)\n- [Management commands](#management-commands)\n- [Static assets](#static-assets)\n\n## Features\n- Account lifecycle operations with strict limits on deposits, withdrawals, and aggregated balances.\n- Server-side validation for invalid amounts, exceeded limits, and insufficient funds.\n- Token, session, and basic authentication out of the box via Django REST Framework.\n- Interactive API documentation powered by drf-spectacular (Swagger UI and ReDoc).\n- Production-friendly defaults including WhiteNoise for static files, CORS headers, and security-focused settings sourced from environment variables.\n\n## Project structure\n```text\nbanky/\n├── api/                  # REST API application (models, views, serializers, errors, custom commands)\n├── config/               # Django settings, URL routing, and WSGI entrypoint\n├── docs/                 # Design references and research notes\n├── static/ \u0026 templates/  # Front-end assets served by Django\n├── tests/                # Django test cases for the account domain\n├── manage.py             # Django management utility\n└── swagger_.png          # Screenshot of the generated Swagger UI\n```\n\n## Requirements\n- Python 3.13 (see `runtime.txt`)\n- `pip` 23.0+\n- SQLite (bundled with Python) or another Django-supported database\n\nAll configuration values (e.g., `SECRET_KEY`, `DEBUG`, and `ALLOWED_HOSTS`) are loaded through [`python-decouple`](https://github.com/henriquebastos/python-decouple). Create a `.env` file at the project root or export the variables in your shell before running the application.\n\n## Quick start\n\n### 1. Clone and configure the project\n```bash\n# Clone the repository\n$ git clone https://github.com/delitamakanda/banky.git\n$ cd banky\n\n# (Optional) create and activate a virtual environment\n$ python3 -m venv .venv\n$ source .venv/bin/activate\n\n# Install dependencies\n(.venv) $ python -m pip install --upgrade pip\n(.venv) $ pip install -r requirements.txt\n```\n\n### 2. Apply database migrations\n```bash\n(.venv) $ python manage.py migrate\n```\n\n### 3. Create an admin user\nYou can create a superuser manually:\n```bash\n(.venv) $ python manage.py createsuperuser\n```\n\nAlternatively, run the bundled helper which generates credentials when none exist:\n```bash\n(.venv) $ python manage.py makesuperuser\n```\n\n### 4. Launch the development server\n```bash\n(.venv) $ python manage.py runserver\n```\nThe site will be available at `http://127.0.0.1:8000/`.\n\n## Running the tests\nUse Django's test runner to execute the suite located in the `tests/` package:\n```bash\n(.venv) $ python manage.py test\n```\n\n## API documentation\nOnce the server is running you can explore the API contract through the automatically generated UIs:\n- Swagger UI: [`/swagger/`](http://127.0.0.1:8000/swagger/)\n- ReDoc: [`/redoc/`](http://127.0.0.1:8000/redoc/)\n- Raw OpenAPI schema: [`/swagger/schema/`](http://127.0.0.1:8000/swagger/schema/)\n\nA preview of the Swagger documentation is included below.\n\n![Swagger Banky API](swagger_.png)\n\n## Management commands\nIn addition to the default Django commands, the project ships with:\n- `makesuperuser` – creates a superuser with a random password when none exist.\n\nList the available commands with `python manage.py help`.\n\n## Static assets\nStatic files are collected into `staticfiles/` via [WhiteNoise](http://whitenoise.evans.io/). To rebuild assets for deployment run:\n```bash\n(.venv) $ python manage.py collectstatic\n```\nThis command is typically executed automatically by hosting providers such as Heroku or Render when deploying the application.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdelitamakanda%2Fbanky","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdelitamakanda%2Fbanky","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdelitamakanda%2Fbanky/lists"}