https://github.com/redstonewizard08/ckandex

An indexer and API for CKAN, written in Rust.
https://github.com/redstonewizard08/ckandex

Last synced: 6 months ago
JSON representation

An indexer and API for CKAN, written in Rust.

• Host: GitHub
• URL: https://github.com/redstonewizard08/ckandex
• Owner: RedstoneWizard08
• License: mit
• Created: 2023-03-03T06:27:21.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-05T17:49:06.000Z (over 1 year ago)
• Last Synced: 2025-06-13T13:17:48.304Z (7 months ago)
• Language: Rust
• Homepage: https://crates.io/crates/ckandex
• Size: 131 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CKANDex

[![crates.io](https://img.shields.io/crates/v/ckandex?style=flat-square)](https://crates.io/crates/ckandex)

A rust-powered [NetKAN](https://github.com/KSP-CKAN/NetKAN) resolver and indexer library, for both KSP 1 and KSP 2.

## About

This library was created for the [Wormhole](https://github.com/RedstoneWizard08/Wormhole) project, as we needed a way to query and list mods in CKAN's [NetKAN](https://github.com/KSP-CKAN/NetKAN) database. However, there wasn't an easy API to do this, as the NetKAN database is essentially a ton of JSON and YAML files crammed into a bunch of folders, so we had to develop our own solution.

## Features

-   Blazingly fast (I know) query and filter system.

-   Low overhead.

-   Memory-efficient (somewhat).

-   Well caching.

-   Always up to date.

-   Easy-to-use API.

-   Made with Tokio and Serde.

-   Easy to integrate into existing codebases.

## Example

For some examples, check out the [examples/](examples/) folder in this repo.

## Contributing

This library is still WIP! Please don't be afraid to make feature requests, pull requests, and anything else. If you have any questions, or you have found any bugs, please create an issue! I'll be happy to help as soon as I can.