Radikle

Radikle is a Kotlin library that provides an interface for interacting with the radicle-httpd JSON API. The library uses Retrofit for network requests and Jackson for parsing JSON responses into Kotlin data classes.

/raw endpoint handling is still under development.

Features

• Simple interface for interacting with the radicle-httpd JSON API.
• Provides access to the v1 API through the RadicleApi class.
• Uses Retrofit for HTTP requests and Jackson for JSON parsing.
• Unit tests are written for all endpoints, except raw endpoints.

Installation

1. Clone the repository:

git clone https://github.com/yourusername/radikle.git

2. Install dependencies and build the project using Gradle:

./gradlew build

Usage

The main entry point into Radikle is through the RadicleApi class. You pass a base URL to the constructor, and you can access the v1 API via the v1() function.

Example usage:

val api = RadicleApi("https://api.radicle.xyz").v1()

// Get a response from /
val response = v1Api.getRoot()

Testing

Unit tests are written for all API endpoints except the raw endpoints. To run tests, use:

./gradlew test

Contributing

1. Fork the repository.
2. Create a new branch for your changes.
3. Commit your changes.
4. Push to your fork and open a pull request.

Issues

Please use the issues to report bugs, request features, or ask questions.

License

This project is licensed under the MIT License.