Skip to main content

RDDL lexer/parser in Python3.

Project description

# pyrddl [![Build Status](https://travis-ci.org/thiagopbueno/pyrddl.svg?branch=master)](https://travis-ci.org/thiagopbueno/pyrddl) [![Documentation Status](https://readthedocs.org/projects/pyrddl/badge/?version=latest)](https://pyrddl.readthedocs.io/en/latest/?badge=latest) [![License](https://img.shields.io/aur/license/yaourt.svg)](https://github.com/thiagopbueno/pyrddl/blob/master/LICENSE)

RDDL lexer/parser in Python3.

# Quickstart

```text
$ pip3 install pyrddl
```

# Usage


## Script mode

The ``pyrddl`` script provides ways to parse and inspect RDDL files
from the command line.

```text
$pyrddl --help

usage: pyrddl [-h] [-v] rddl

RDDL lexer/parser in Python3.

positional arguments:
rddl RDDL filepath

optional arguments:
-h, --help show this help message and exit
-v, --verbose verbosity mode
```

## Programmatic mode

The ``pyrddl`` package provides an API for integrating RDDL parser
with your own Python package/project.

```python
from pyrddl import RDDLParser

# read RDDL file
with open(filepath, 'r') as file:
rddl = file.read()

# buid parser
parser = RDDLParser()
parser.build()

# parse RDDL
model = parser.parse(rddl) # AST
```

# License

Copyright (c) 2018 Thiago Pereira Bueno All Rights Reserved.

pyrddl is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.

pyrddl is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with pyrddl. If not, see http://www.gnu.org/licenses/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyrddl-0.1.5.tar.gz (28.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page