https://github.com/jwodder/javaproperties-cli

Command-line manipulation of Java .properties files
https://github.com/jwodder/javaproperties-cli

available-on-pypi config configfile configuration java javaproperties properties python

Last synced: 20 days ago
JSON representation

Command-line manipulation of Java .properties files

• Host: GitHub
• URL: https://github.com/jwodder/javaproperties-cli
• Owner: jwodder
• License: mit
• Created: 2017-04-20T13:33:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-08T16:39:35.000Z (about 1 month ago)
• Last Synced: 2024-10-12T09:15:30.097Z (about 1 month ago)
• Topics: available-on-pypi, config, configfile, configuration, java, javaproperties, properties, python
• Language: Python
• Size: 318 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
|repostatus| |ci-status| |coverage| |pyversions| |license|

.. |repostatus| image:: https://www.repostatus.org/badges/latest/active.svg

    :target: https://www.repostatus.org/#active

    :alt: Project Status: Active - The project has reached a stable, usable

          state and is being actively developed.

.. |ci-status| image:: https://github.com/jwodder/javaproperties-cli/actions/workflows/test.yml/badge.svg

    :target: https://github.com/jwodder/javaproperties-cli/actions/workflows/test.yml

    :alt: CI Status

.. |coverage| image:: https://codecov.io/gh/jwodder/javaproperties-cli/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/jwodder/javaproperties-cli

.. |pyversions| image:: https://img.shields.io/pypi/pyversions/javaproperties-cli.svg

    :target: https://pypi.org/project/javaproperties-cli

.. |license| image:: https://img.shields.io/github/license/jwodder/javaproperties-cli.svg?maxAge=2592000

    :target: https://opensource.org/licenses/MIT

    :alt: MIT License

`GitHub `_

| `PyPI `_

| `Documentation `_

| `Issues `_

| `Changelog `_

``javaproperties-cli`` is a wrapper around the |javaproperties|_ package (from

which it was split off) that provides programs for basic command-line

manipulation of |properties|_ files, including getting, setting, & deleting

values and converting to & from JSON.

Installation

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

``javaproperties-cli`` requires Python 3.8 or higher.  Just use `pip

`_ for Python 3 (You have pip, right?) to install

``javaproperties-cli`` and its dependencies::

    python3 -m pip install javaproperties-cli

Quickstart

==========

::

    javaproperties get      ...

Output the values of the given keys in the given ``.properties`` file

::

    javaproperties select   ...

Output the key-value pairs for the given keys in the given ``.properties`` file

::

    javaproperties set      

Set ```` in ```` to ```` and output the result

::

    javaproperties delete   ...

Output the given ``.properties`` file with the given keys deleted

::

    javaproperties format []

Reformat the given ``.properties`` file, removing comments & extraneous

whitespace and putting keys in sorted order

::

    json2properties [ []]

Convert a JSON object to a ``.properties`` file

::

    properties2json [ []]

Convert a ``.properties`` file to a JSON object

.. |properties| replace:: ``.properties``

.. _properties: https://en.wikipedia.org/wiki/.properties

.. |javaproperties| replace:: ``javaproperties``

.. _javaproperties: https://github.com/jwodder/javaproperties