https://github.com/iwillig/khaldun
https://github.com/iwillig/khaldun
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/iwillig/khaldun
- Owner: iwillig
- Created: 2025-05-01T10:25:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-05T13:38:24.000Z (about 1 year ago)
- Last Synced: 2025-07-23T19:46:25.185Z (about 1 year ago)
- Language: Python
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Khaldun
Khaldun is a tool that helps software engineers manage documentation
systems about their software projects.
Khaldun is named after the famous Arab scholar [Ibn
Khaldun](https://en.wikipedia.org/wiki/Ibn_Khaldun).
## Architecture
This tool is written in Python and HTMX.
1. [pandoc](https://pandoc.org/) - Documentation tool
1. [flask](https://flask.palletsprojects.com/en/stable/) - HTTP Server
1. [click](https://click.palletsprojects.com/en/stable/) - Command line parsing
1. [SQLite3](https://www.sqlite.org/) - Our primary storage
1. [HTMX](https://htmx.org/) - A tool for building hypermedia interfaces
1. [pico.css](https://picocss.com/) - A small and simple CSS library for our
1. [Anthropic](https://github.com/anthropics/anthropic-sdk-python)
1. [pytest](https://docs.pytest.org/en/stable/)
## Install
We use [pipenv](https://pipenv.pypa.io/en/latest/) to manage our
Python dependencies.
```shell
$ pipenv install
```
```shell
$ brew install khaldun
```
## Usage
```shell
khaldun scan
```
```shell
khaldun serve
```
```shell
khaldun query
```