Skip to content

Latest commit

 

History

History
127 lines (92 loc) · 2.44 KB

README.md

File metadata and controls

127 lines (92 loc) · 2.44 KB

##ConfParser.jl

Build Status Licence MIT

ConfParser is a package for parsing, modifying, and writing to configuration files. ConfParser can handle configuration files utilizing multiple syntaxes to include INI, HTTP, and simple.

###Synopsis

####parse_conf! Reads, parses, and stores configuration file parameters in a dictionary.

####retrieve Returns a parsed configuration file parameter.

####commit! Writes new configuration file elements into the configuration parameter dictionary.

####erase! Removes an entry from the configuration parameter dictionary.

####save! Generates and saves configuration dictionary parameters in specified configuration syntax.

###Examples

####INI Files

header=leheader

; this is a comment
[database]
user=dbuser
password=abc123
host=localhost

; this is another comment
[foobarness]
foo=bar,foo
foobar=barfoo
using ConfParser

conf = ConfParse("confs/config.ini")
parse_conf!(conf)

# get and store config parameters
user     = retrieve(conf, "database", "user")
password = retrieve(conf, "database", "password")
host     = retrieve(conf, "database", "host")

# replace config paramater
commit!(conf, "database", "user", "newuser")

# erase a config block
erase!(conf, "foobarness")

# save to another file
save!(conf, "testout.ini")

####HTTP Files

# this is a comment
email:[email protected]
password:qwerty

# this is another comment
url:julialang.org
foobars:foo,bar,snafu
using ConfParser

conf = ConfParse("confs/config.http")
parse_conf!(conf)

# get and store config parameters
email    = retrieve(conf, "email")
password = retrieve(conf, "password")
foobars  = retrieve(conf, "foobars")

# modify config parameter
commit!(conf, "email", "[email protected]")

# save changes
save!(conf)

####Simple Files

# this is a comment
protocol kreberos
port 6643
user                root

# this is another comment
foobar barfoo
using ConfParser

conf = ConfParse("confs/config.simple")
parse_conf!(conf)

# store config items in vars
protocol = retrieve(conf, "protocol")
port     = retrieve(conf, "port")
user     = retrieve(conf, "user")

# remove config parameter
erase!(conf, "protocol")

# generate new config from data
save!(conf, "outconf.simple")

=======

ConfParser.jl