Initial checkin

- base parser
- base documentation
- base test cases
- CI integration

Signed-off-by: Konrad Weihmann <[email protected]>

Author: priv-kweihmann

.github/workflows/pythonpackage.yml

@@ -0,0 +1,37 @@
+name: Python package
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.5, 3.6, 3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python3 -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install pytest
+    - name: Lint with flake8
+      run: |
+        pip install flake8
+        cd oelint_parser
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Build
+      run: python3 setup.py build
+    - name: Test
+      run: pytest
+    - name: Install
+      run: python3 setup.py install

README.md

@@ -1,2 +1,58 @@
-# oelint-parsr
+# oelint-parser
+
 alternative parser for bitbake recipes
+
+## API documentation
+
+Find the full API docs [here](docs/api-documentation.md)
+
+## Examples
+
+```python
+from oelint_parser.cls_stash import Stash
+
+# create an stash object
+_stash = Stash()
+
+# add any bitbake like file
+_stash.AddFile("/some/file")
+
+# Resolves proper cross file dependencies
+_stash.Finalize()
+
+# Use _stash.GetItemsFor() method to filter the stash
+```
+
+### Get variables from the files
+
+To get variables from the stash object do
+
+```python
+from oelint_parser.cls_item import Variable
+
+# get all variables of the name PV from all files
+for x in _stash.GetItemsFor(attribute=Variable.ATTR_VAR, attributeValue="PV"):
+    print(x)
+```
+
+this returns the raw object representation
+
+### Expand raw variables
+
+```python
+from oelint_parser.cls_item import Variable
+from oelint_parser.helper_files import expand_term
+
+# get all variables of the name PV from all files
+for x in _stash.GetItemsFor(attribute=Variable.ATTR_VAR, attributeValue="PV"):
+    # raw unexpanded variable
+    print(x.VarValue)
+    # raw unexpanded variable without quotes
+    print(x.VarValueStripped)
+    # expanded variable
+    print(expand_term(stash, "/some/file", x.VarValueStripped))
+    # single items from a list
+    print(x.get_items())
+    # expanded single items from a list
+    print([expand_term(stash, "/some/file", y) for y in x.get_items()])
+```

build.sh

@@ -0,0 +1,4 @@
+#!/bin/sh -e
+python3 setup.py build
+python3 setup.py sdist
+pytest