Skip to content

Commit

Permalink
Update README for clarity, add Pypi description, fix sample code.
Browse files Browse the repository at this point in the history
  • Loading branch information
Shadark committed Jan 28, 2019
1 parent 0795329 commit f9167f6
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion ClauseWizard/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from .parse import parse_grammar as cwparse
from .format import format_full as cwformat

__version__ = '1.0.4'
__version__ = '1.0.5'

__all__ = ["cwparse", "cwformat"]
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![Build Status](https://travis-ci.com/Shadark/ClauseWizard.svg?branch=master)](https://travis-ci.com/Shadark/ClauseWizard) [![PyPI version](https://badge.fury.io/py/ClauseWizard.svg)](https://badge.fury.io/py/ClauseWizard) [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)]
[![Build Status](https://travis-ci.com/Shadark/ClauseWizard.svg?branch=master)](https://travis-ci.com/Shadark/ClauseWizard) [![PyPI version](https://badge.fury.io/py/ClauseWizard.svg)](https://badge.fury.io/py/ClauseWizard) ![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)

# ClauseWizard
Python-based JSON parser for files from the Clausewitz engine, used in multiple Paradox Interactive games.
Python-based JSON parser for files from the Clausewitz engine, used in multiple Paradox Interactive games. You can open the resulting files with any text editor, but since the file size can exceed the allowed limit for some editors, you can use other software such as [HugeJsonViewer](https://github.com/WelliSolutions/HugeJsonViewer).

Currently supports both savegames and files from:

Expand All @@ -27,9 +27,9 @@ Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.
pip install ClauseWizard
```

Binary packages will be available for release _Soon™_.
Binary packages are available for download in the [Release](https://github.com/Shadark/ClauseWizard/releases) page.

Python version is 3.7, will test other versions.
_Python version is 3.7, will test other versions._

## Usage

Expand Down
2 changes: 0 additions & 2 deletions sample/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,6 @@ def main():
except Exception as ex:
raise ex

exit(0)

# TODO Should I use return() or exit()?

# TODO Optional step to save parse result and possibly resume progress by pickleing
Expand Down
2 changes: 2 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ def find_version(*file_paths):
author_email='fauglir@gmail.com',
description='Python-based JSON parser for files from the Clausewitz engine,'
' used in multiple Paradox Interactive games.',
long_description=long_description,
long_description_content_type='text/markdown',
keywords='clausewitz paradoxinteractive parser',
entry_points={
'console_scripts': [
Expand Down

0 comments on commit f9167f6

Please sign in to comment.