mkonicek / configrity

Simple, immutable and flexible configuration library for scala.

Configrity README file

Configrity is a configuration library for Scala 2.9 or +. Configuration instances are immutable, thread-safe and allow functional design patterns, such as:

• Getting options to values
• Converting implicitly values via type-classes
• Reader monad

The API is now stable and covered by tests. However, as it is very young, it may contain some bugs.

Example

import org.streum.configrity._

val config = Configuration.load( "server.conf" )

val hostname = config[String]("host")
val port = config[Int]("port")

val updatedConfig = config.set ("port",8080 )
upddatedConfig.save( "local.conf" )	

Features

Implemented

• Automatic values conversions via type classes.
• Loading configurations from any source (File, InputStream, URL, etc.)
• Loading configurations from system properties and environment variables.
• Saving configurations to files.
• Interoperability with java properties.
• Hierarchical configuration blocks.
• Configuration chaining (such as to provide default values).
• Single import: import org.streum.configrity._ imports all you need.
• Access through reader monads
• Values can be lists (v0.7.0)
• Extra value converters: File, Color, URL, URI (v0.7.0)
• include directive is supported, adding compatibility with Akka and Configgy configurations files.
• Loading configurations from classpath/resources (v0.9.0)
• YAML format support (v0.10.0)

Planned

• More export/Import formats: INI, JSON, XML, apache, etc.

Requirements

Configrity depends on Scala 2.9.x. It should be easy to provide compatibility with Scala 2.8 by dropping some minor features. If you are interested, let me know.

While core features do not depend on external libraries, some modules may. In that case, the approriate dependencies will be automatically installed by sbt/maven.

Installation

From SBT

The dependency line is:

"org.streum" %% "configrity-core" % "0.10.0"

Additional modules require addition dependency lines. Check the wiki for more information: https://github.com/paradigmatic/Configrity/wiki/Modules

From Maven, Buildr, Ivy, Grape and Grails

Follow the repository instructions.

From source (master branch)

To install Configrity you just need a working java installation (tested with JDK 1.6, but may work with 1.5) and SBT 0.11+:

$ git clone git://github.com/paradigmatic/Configrity.git
$ cd Configrity
$ sbt
> test
> doc
> package

Documentation

See the wiki: https://github.com/paradigmatic/Configrity/wiki

A scaladoc reference can be found online: http://paradigmatic.github.com/Configrity/

Collaboration

Reporting bugs and asking for features

You can github issues tracker, to report bugs or to ask for new features:

https://github.com/paradigmatic/Configrity/issues

Submitting patches

Patches are gladly accepted from their original author. Along with any patches, please state that the patch is your original work and that you license the work to the Configrity project under the LGPLv3 or a compatible license.

To propose a patch, fork the project and send a pull request via github. Tests are appreciated.

License and ownership

Configrity is a free and open source library released under the permissive GNU LesserGPLv3 license (see LICENSE.txt).

Copyright (C) 2011-2012. Paradigmatic. All rights reserved.