https://github.com/jhermann/javaprops

:package: Read and write Java property files from Python, including comments and location info.
https://github.com/jhermann/javaprops

Last synced: 2 days ago
JSON representation

:package: Read and write Java property files from Python, including comments and location info.

• Host: GitHub
• URL: https://github.com/jhermann/javaprops
• Owner: jhermann
• License: apache-2.0
• Created: 2015-01-23T15:52:01.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-15T09:33:51.000Z (over 8 years ago)
• Last Synced: 2024-02-21T22:55:27.312Z (7 months ago)
• Language: Python
• Homepage:
• Size: 52.7 KB
• Stars: 2
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# “javaprops” Python Package

![logo](https://raw.githubusercontent.com/Feed-The-Web/javaprops/master/static/img/javaprops-128.png)

Read and write Java property files, including comments and location info.

 [![Groups](https://img.shields.io/badge/Google_groups-ftw--users-orange.svg)](https://groups.google.com/forum/#!forum/ftw-users)

 ![Apache 2.0 licensed](http://img.shields.io/badge/license-Apache_2.0-red.svg)

 [![Travis CI](https://api.travis-ci.org/Feed-The-Web/javaprops.svg)](https://travis-ci.org/Feed-The-Web/javaprops)

## Project Goals

This library allows you to read Java property files including all the lesser known formatting details,

like Unicode escaping. What sets it apart from similar projects are these requirements:

* Modification of property files with minimal differences due to normalization.

* Comments are parsed and associated with their property key.

* Location information is available, mostly to improve diagnostics for humans.

* The property set can be exposed as a dict-like object with attribute semantics, mainly for use in template engines; stemmed values are supported.

* Provide an optional inclusion mechanism via special comments.

## Installation

To create a development environment, use these commands:

```sh

git clone "https://github.com/Feed-The-Web/javaprops.git"

cd javaprops; deactivate; /usr/bin/virtualenv .venv/$(basename $PWD)

. .venv/$(basename $PWD)/bin/activate

pip install -U pip; pip install -r "dev-requirements.txt"

invoke build --docs

```

See [CONTRIBUTING.md](https://github.com/Feed-The-Web/javaprops/blob/master/CONTRIBUTING.md)

for details on how to give back your improvements and fixes to upstream, so every user can benefit from them.

## Usage

### Reading

**TODO**

### Writing

**TODO**

### Property Mapper

**TODO**

### Includes

**TODO**

## `javaprops` command line tool

**TODO**

## Similar Projects

**Python**

* [jprops](https://github.com/mgood/jprops)

* [java-props-in-python](https://github.com/hackorama/java-props-in-python)

* [pyjavaproperties](https://bitbucket.org/jnoller/pyjavaproperties/)

* [PyHOCON](https://github.com/chimpler/pyhocon)

**Go**

* [magiconair/properties](https://github.com/magiconair/properties)

## Acknowledgements

[![1&1](https://raw.githubusercontent.com/1and1/1and1.github.io/master/images/1and1-logo-42.png)](https://github.com/1and1)  Project sponsored by [1&1](https://github.com/1and1).