Commit 2a6b4b34 authored by Joe Snyder's avatar Joe Snyder
Browse files

Update style and add linting information

Update the style of the generator.py file to align with pycodestyle
standards (Configured locally to allow long lines).

Add information on where to acquire and how to run the pycodestyle
program.
parent 19cb357f
......@@ -4,6 +4,9 @@ Wrapper Generator
This repository contains the first set of Python code which could be used to
automatically generate PyBin11 code from C++ files with proper annotation.
Program execution
+++++++++++++++++
Prereq Install
---------------
......@@ -13,7 +16,9 @@ On Ubuntu::
which will install CastXML, a prerequsite for PyGCCXML.
Then::
pip install pygccxml
to install PyGCCXML.
......@@ -55,4 +60,19 @@ To run over the entirety of the local example, we use a command like this::
$ python3 generator.py -g ~/Work/TRI/CastXML/build/bin/castxml -s ~/Work/TRI/wrapper_generator/example/
which would output a single C++ files of wrapper code called ``test_py.cpp``
\ No newline at end of file
which would output a single C++ files of wrapper code called ``test_py.cpp``
Development Tools
+++++++++++++++++
Style Checking / Linting
-------------------------
This repository uses the pycodestyle_ tool for linting and style checking which
can be installed via the ``pip`` program.
The program should be run at the top level so that the ``setup.cfg`` in the
repository is available. An example run is as follows::
$ pycodestyle generator.py
.. _pycodestyle: https://pypi.org/project/pycodestyle/
\ No newline at end of file
This diff is collapsed.
[pycodestyle]
max-line-length = 160
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment