beetbox / beetbox/confuse

example should show case where no existing config file exists

Open
#109 3 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
424
Forks
57
PR merge metrics
No merged PRs in 30d

Description

example.py should create a new_template for the case where there is no existing configuration file, in order to create one the first time.

eg.

```
new_template = {
'library': 'test_library.db',
'import_write': 'yes',
'ignore': 'ignore regex string',
'plugins': [],

'paths': {
'directory': '.Music',
'default': 'iTunes',
},

'servers': [
{
'hostname': 'matane.plar.ca',
'options': ['foo'],
},
{
'hostname': 'arsène.plar.ca',
'options': ['bar', 'baz'],
},
]
}
```

and then change from LazyConfig to base Configuration and set read=False.

`config = confuse.Configuration('PaulConfuseExample', __name__, read=False)`

Contributor guide

No contributing guide indexed for this repository

Research direction

Open example.py and inspect how it currently uses LazyConfig when a configuration file is absent. Update the example to define the shown new_template, use confuse.Configuration with read=False, and verify that the example demonstrates creating the initial configuration file.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.