pyconf can read and write python config files non-destructively (preserves comments)
Go to file
AJ ONeal 07039a8407 Update README.md 2015-12-19 10:16:23 -08:00
.gitignore Initial commit 2015-12-14 22:51:47 -08:00
LICENSE Initial commit 2015-12-14 22:51:47 -08:00
README.md Update README.md 2015-12-19 10:16:23 -08:00
example.conf v1.0.0 2015-12-14 23:07:04 -08:00
index.js v1.0.0 2015-12-14 23:07:04 -08:00
package.json v1.0.0 2015-12-14 23:07:04 -08:00
test.js test non-file 2015-12-14 23:10:32 -08:00

README.md

node-config-python

Read and write python config files non-destructively (preserves comments and lines)

Turns this kind of thing:

foo = True
bar = None
baz = whatever
qux = apples,bananas

Into this kind of thing:

{ foo: true
, bar: null
, baz: "whatever"
, qux: ["apples", "bananas"]
}

(comments are stored in meta-data keys __lines and __keys)

Install & Usage

npm install --save pyconf
var pyconf = require('pyconf');

# alias for fs.readFile() then pyconf.parse()
pyconf.readFile("/path/to/foo.conf", function (err, obj) {
  console.log(obj);
});

pyconf.writeFile("/path/to/foo.conf", obj, function (err, obj) {
  console.log("wrote file");
});

Note: the writeFile function uses safe-replace so that it will work even in environments where race conditions are possible and will also create a backup file whatever.conf.bak of the config being overwritten.

API

pyconf
  .parse(str, cb)                   // => err, object
  
  .stringify(obj, cb)               // => err, text
  
  .readFile(filename, cb)           // => err, object
  
  .writeFile(filename, obj, cb)     // => err