first commit

Author: CITGuru

.bumpversion.cfg

@@ -0,0 +1,7 @@
+[bumpversion]
+current_version = 1.0.0
+
+[bumpversion:file:setup.py]
+
+[bumpversion:file:pyconfig/__init__.py]
+

.gitignore

@@ -0,0 +1,71 @@
+*.egg-info
+.*.swp
+.*.swo
+*.pyc
+.DS_Store
+dist
+.tox
+.coverage
+htmlcov
+six-*.egg/
+*.orig
+.idea/
+*.iml
+*.log
+
+bak
+output
+output_*
+research
+venv
+venv3
+cache
+.cache
+vendor
+xvendor
+node_modules
+
+report.xml
+pylint-report.html
+pytest-report.html
+set_w
+snafu.py
+set_infra
+
+
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+.pypirc

LICENSE

@@ -0,0 +1,19 @@
+Copyright 2018 Oyetoke Toby and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE README.md

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+#SPHINXPROJ    = 
+SOURCEDIR     = docs
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -0,0 +1,122 @@
+# ConfigStore 
+
+A Python module for handling config files. It helps handles persist config files and also giving the ability to set, get, update and delete config settings
+
+> Easily load and persist config without having to think about where and how
+
+It's built base on nodejs [configstore](https://github.com/yeoman/configstore)
+
+Config is stored in a JSON file located in `$XDG_CONFIG_HOME` or `~/.localconfig`.<br>
+Example: `~/.localconfig/configstore/name.json`
+
+## Installation
+
+```bash
+pip install pyconfig
+```
+
+## Usage
+
+```python
+from pyconfig import ConfigStore
+
+// create a Configstore instance with a unique name e.g. gnit
+// Package name and optionally some default values
+conf = ConfigStore("Gnit", {"foo": 'bar'});
+
+print(conf.get('foo'));
+//>>> 'bar'
+
+conf.set('awesome', True);
+print(conf.get('awesome'));
+//>>> True
+
+// Use dot-notation to set nested properties
+conf.set('bar.baz', True);
+print(conf.get('bar'));
+//>>> {"baz": True}
+
+conf.delete('awesome');
+print(conf.get('awesome'));
+//>>>
+```
+
+
+## API
+
+### Configstore(packageName, [defaults], [options])
+
+Returns a new instance.
+
+#### packageName
+
+Type: `string`
+
+Name of your package.
+
+#### defaults
+
+Type: `Object`
+
+Default config.
+
+#### options
+
+##### globalConfigPath
+
+Type: `bool`<br>
+Default: `False`
+
+Store the config at `$CONFIG/package-name/config.json` instead of the default `$CONFIG/configstore/package-name.json`. This is not recommended as you might end up conflicting with other tools, rendering the "without having to think" idea moot.
+
+### Features
+
+You can use dot-notation to set, get, update and delete nested dict properties
+
+### .set(key, value)
+
+Set an item.
+
+### .set(object)
+
+Set multiple items at once.
+
+### .get(key)
+
+Get an item.
+
+### .has(key)
+
+Check if an item exists.
+
+### .delete(key)
+
+Delete an item.
+
+### .clear()
+
+Delete all items.
+
+### .all
+
+Get all the config as an object or replace the current config with an object:
+
+```python
+conf.all({
+	hello: 'world'
+}) 
+```
+
+### .size
+
+Get the item count.
+
+### .path
+
+Get the path to the config file. Can be used to show the user where the config file is located or even better open it for them.
+
+
+## License
+Copyright - 2018
+Oyetoke Toby <twitter:@OyetokeT>
+MIT LICENSE

docs/README.md

@@ -0,0 +1,122 @@
+# ConfigStore 
+
+A Python module for handling config files. It helps handles persist config files and also giving the ability to set, get, update and delete config settings
+
+> Easily load and persist config without having to think about where and how
+
+It's built base on nodejs [configstore](https://github.com/yeoman/configstore)
+
+Config is stored in a JSON file located in `$XDG_CONFIG_HOME` or `~/.localconfig`.<br>
+Example: `~/.localconfig/configstore/name.json`
+
+## Installation
+
+```bash
+pip install pyconfig
+```
+
+## Usage
+
+```python
+from pyconfig import ConfigStore
+
+// create a Configstore instance with a unique name e.g. gnit
+// Package name and optionally some default values
+conf = ConfigStore("Gnit", {"foo": 'bar'});
+
+print(conf.get('foo'));
+//>>> 'bar'
+
+conf.set('awesome', True);
+print(conf.get('awesome'));
+//>>> True
+
+// Use dot-notation to set nested properties
+conf.set('bar.baz', True);
+print(conf.get('bar'));
+//>>> {"baz": True}
+
+conf.delete('awesome');
+print(conf.get('awesome'));
+//>>>
+```
+
+
+## API
+
+### Configstore(packageName, [defaults], [options])
+
+Returns a new instance.
+
+#### packageName
+
+Type: `string`
+
+Name of your package.
+
+#### defaults
+
+Type: `Object`
+
+Default config.
+
+#### options
+
+##### globalConfigPath
+
+Type: `bool`<br>
+Default: `False`
+
+Store the config at `$CONFIG/package-name/config.json` instead of the default `$CONFIG/configstore/package-name.json`. This is not recommended as you might end up conflicting with other tools, rendering the "without having to think" idea moot.
+
+### Features
+
+You can use dot-notation to set, get, update and delete nested dict properties
+
+### .set(key, value)
+
+Set an item.
+
+### .set(object)
+
+Set multiple items at once.
+
+### .get(key)
+
+Get an item.
+
+### .has(key)
+
+Check if an item exists.
+
+### .delete(key)
+
+Delete an item.
+
+### .clear()
+
+Delete all items.
+
+### .all
+
+Get all the config as an object or replace the current config with an object:
+
+```python
+conf.all({
+	hello: 'world'
+}) 
+```
+
+### .size
+
+Get the item count.
+
+### .path
+
+Get the path to the config file. Can be used to show the user where the config file is located or even better open it for them.
+
+
+## License
+Copyright - 2018
+Oyetoke Toby <twitter:@OyetokeT>
+MIT LICENSE

example.py

@@ -0,0 +1,13 @@
+from pyconfig import ConfigStore
+
+conf = ConfigStore("vestub", {"url":"http://vestub.com"}, True)
+print(conf.get("url"))
+conf.set("Title", "Social Media for Idea Owners and Investors")
+conf.set("Tags", "Tech, Investors, Social Media")
+conf.set("Tags.Topic", "Python")
+conf.set({"Subject.Topic":"English"})
+print(conf.all())
+print(conf.path)
+
+conf.delete("url")
+print(conf.all())