diff --git a/.coverage b/.coverage new file mode 100644 index 0000000..9fb7071 Binary files /dev/null and b/.coverage differ diff --git a/MANIFEST.in b/MANIFEST.in index 33f21da..8da5b21 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,2 @@ include README.md MANIFEST.in setup.py .gitignore recursive-include idlbridge *.py *.pyx *.pxd *.pxi *.pro VERSION -recursive-include dev * diff --git a/README b/README.md similarity index 58% rename from README rename to README.md index 3de4a3f..dc3eb27 100644 --- a/README +++ b/README.md @@ -1,5 +1,4 @@ -IDLBridge -========= +# IDLBridge A python wrapper for the IDL. @@ -18,6 +17,34 @@ without requiring significant code refactoring. - Dr Alex Meakins (alex.meakins@ukaea.uk) +# Installation +First ensure the `IDL_DIR` environment variable is set to the path to the IDL +installation root (containing `/bin` and `/external`). `IDLBridge` can then be +installed from [PyPI](https://pypi.org/): +```bash +pip install idlbridge +``` +# Development + +## Build source distribution + +First install `build`: + +```bash +pip install build +``` + +Then build the source distribution, note `IDL_DIR` must also be set for this: + +```bash +python -m build --sdist . +``` + +## Run tests + +```bash +python -m unittest +``` diff --git a/dev/build.sh b/dev/build.sh deleted file mode 100755 index 45914c2..0000000 --- a/dev/build.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash - -python setup.py build_ext --inplace --force diff --git a/dev/test.sh b/dev/test.sh deleted file mode 100755 index a53191b..0000000 --- a/dev/test.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash - -python -m unittest