https://github.com/bitranox/configmagick

manipulate config files
https://github.com/bitranox/configmagick

Last synced: over 1 year ago
JSON representation

manipulate config files

• Host: GitHub
• URL: https://github.com/bitranox/configmagick
• Owner: bitranox
• License: mit
• Created: 2019-07-13T09:05:56.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2025-01-24T23:22:46.000Z (over 1 year ago)
• Last Synced: 2025-01-24T23:23:09.861Z (over 1 year ago)
• Language: Python
• Size: 37.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
configmagick

============

|Pypi Status| |license| |maintenance|

|Build Status| |Codecov Status| |Better Code| |code climate| |snyk security|

.. |license| image:: https://img.shields.io/github/license/webcomics/pywine.svg

   :target: http://en.wikipedia.org/wiki/MIT_License

.. |maintenance| image:: https://img.shields.io/maintenance/yes/{last_update_yyyy}.svg

.. |Build Status| image:: https://travis-ci.org/bitranox/configmagick.svg?branch=master

   :target: https://travis-ci.org/bitranox/configmagick

.. for the pypi status link note the dashes, not the underscore !

.. |Pypi Status| image:: https://badge.fury.io/py/configmagick.svg

   :target: https://badge.fury.io/py/configmagick

.. |Codecov Status| image:: https://codecov.io/gh/bitranox/configmagick/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/bitranox/configmagick

.. |Better Code| image:: https://bettercodehub.com/edge/badge/bitranox/configmagick?branch=master

   :target: https://bettercodehub.com/results/bitranox/configmagick

.. |snyk security| image:: https://snyk.io/test/github/bitranox/configmagick/badge.svg

   :target: https://snyk.io/test/github/bitranox/configmagick

.. |code climate| image:: https://api.codeclimate.com/v1/badges/aa4651702479ef8a2749/maintainability

   :target: https://codeclimate.com/github/bitranox/configmagick/maintainability

   :alt: Maintainability

some convenience functions for logging

supports python 3.7 and possibly other dialects.

`100% code coverage `_, mypy static type checking, tested under `Linux, OsX, Windows and Wine `_, automatic daily builds  and monitoring

----

- `Installation and Upgrade`_

- `Basic Usage`_

- `Requirements`_

- `Acknowledgements`_

- `Contribute`_

- `Report Issues `_

- `Pull Request `_

- `Code of Conduct `_

- `License`_

- `Changelog`_

----

Installation and Upgrade

------------------------

From source code:

.. code-block:: bash

    # normal install

    python setup.py install

    # test without installing

    python setup.py test

via pip latest Release:

.. code-block:: bash

    # latest Release from pypi

    pip install configmagick

    # test without installing

    pip install configmagick --install-option test

via pip latest Development Version:

.. code-block:: bash

    # upgrade all dependencies regardless of version number (PREFERRED)

    pip install --upgrade git+https://github.com/bitranox/configmagick.git --upgrade-strategy eager

    # normal install

    pip install --upgrade git+https://github.com/bitranox/configmagick.git

    # test without installing

    pip install git+https://github.com/bitranox/configmagick.git --install-option test

via requirements.txt:

.. code-block:: bash

    # Insert following line in Your requirements.txt:

    # for the latest Release:

    configmagick

    # for the latest Development Version :

    git+https://github.com/bitranox/configmagick.git

    # to install and upgrade all modules mentioned in requirements.txt:

    pip install --upgrade -r //requirements.txt

via python:

.. code-block:: python

    # for the latest Release

    python -m pip install upgrade configmagick

    # for the latest Development Version

    python -m pip install upgrade git+https://github.com/bitranox/configmagick.git

Basic Usage

-----------

TBA

Requirements

------------

following modules will be automatically installed :

.. code-block:: bash

    ## Test Requirements

    ## following Requirements will be installed temporarily for

    ## "setup.py install test" or "pip install  --install-option test"

    typing ; python_version < "3.5"

    pathlib; python_version < "3.4"

    mypy ; platform_python_implementation != "PyPy" and python_version >= "3.5"

    pytest

    pytest-pep8 ; python_version < "3.5"

    pytest-pycodestyle ; python_version >= "3.5"

    pytest-mypy ; platform_python_implementation != "PyPy" and python_version >= "3.5"

    pytest-runner

    ## Project Requirements

    Arpeggio

    fire

    lib_log_utils @ git+https://github.com/bitranox/lib_log_utils.git

    lib_path @ git+https://github.com/bitranox/lib_path.git

Acknowledgements

----------------

- special thanks to "uncle bob" Robert C. Martin, especially for his books on "clean code" and "clean architecture"

Contribute

----------

I would love for you to fork and send me pull request for this project.

- `please Contribute `_

License

-------

This software is licensed under the `MIT license `_

---

Changelog

=========

0.0.1

-----

2019-09-03: Initial public release