Project icon

com.io7m.claypot

Build status Maven Central Codecov

The claypot package implements a small API over the excellent JCommander command-line parser that implements defaults and conventions that are used across many io7m packages.

Contents

Features

  • OSGi-ready
  • JPMS-ready
  • High coverage automated test suite
  • ISC license

Releases

The most recently published version of the software is 0.0.8.

Source code and binaries are available from the repository.

Documentation

Documentation for the 0.0.8 release is available for reading online.

Documentation for current and older releases is archived in the repository.

User documentation

No user documentation is currently available.

Maven

The following is a complete list of the project's modules expressed as Maven dependencies: 

<dependency>
  <groupId>com.io7m.claypot</groupId>
  <artifactId>com.io7m.claypot</artifactId>
  <version>0.0.8</version>
</dependency>

<dependency>
  <groupId>com.io7m.claypot</groupId>
  <artifactId>com.io7m.claypot.core</artifactId>
  <version>0.0.8</version>
</dependency>

<dependency>
  <groupId>com.io7m.claypot</groupId>
  <artifactId>com.io7m.claypot.example</artifactId>
  <version>0.0.8</version>
</dependency>

<dependency>
  <groupId>com.io7m.claypot</groupId>
  <artifactId>com.io7m.claypot.tests</artifactId>
  <version>0.0.8</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

2020-07-31 Release: com.io7m.claypot 0.0.5
2020-07-31 Change: Add an exit cause API
2020-07-11 Release: com.io7m.claypot 0.0.4
2020-07-11 Change: Fix usage text to contain program name correctly
2020-07-04 Release: com.io7m.claypot 0.0.3
2020-06-27 Change: Allow applications to publish documentation URIs. (tickets: 2 )
2020-07-04 Change: (Backwards incompatible) Introduce ClaypotType interface
2020-07-04 Change: Introduce commands() method to return map of commands (tickets: 4 )
2020-07-04 Release: com.io7m.claypot 0.0.2
2020-06-27 Change: Add extended help methods. (tickets: 1 )
2020-06-27 Change: Document @ syntax. (tickets: 3 )
2020-06-26 Release: com.io7m.claypot 0.0.1

Sources

This project uses Git to manage source code.

Repository: https://github.com/io7m/claypot

$ git clone https://github.com/io7m/claypot

License

Copyright © 2022 Mark Raynsford <code@io7m.com> https://www.io7m.com

Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted, provided that the
above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

Bug Tracker

The project uses GitHub Issues to track issues.