diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..0c718cd --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,15 @@ +Issues and Pull Requests are always welcome. Thank you for your contribution! + +# Reporting an Issue +Please check the latest development version to see if your issue has been fixed since the latest stable release. + +# Test Suite +There is a `decoding_test.py` script in the `tests/` directory which acts as a harness in order to allow toml to be used with [the toml test suite](https://github.com/uiri/toml-test), written (unfortunately) in Go. + +## Usage +1. Install Go (golang) +2. The toml-test suite + 1. [Instructions](https://github.com/BurntSushi/toml-test#try-it-out) +3. Test both versions of Python: + * `~/go/bin/toml-test ./tests/decoding_test2.sh` - for Python 2 + * `~/go/bin/toml-test ./tests/decoding_test3.sh` - for Python 3 diff --git a/TESTING.md b/TESTING.md deleted file mode 100644 index f9a68bb..0000000 --- a/TESTING.md +++ /dev/null @@ -1,19 +0,0 @@ -# Testing -There is a `toml_test.py` script which acts as a harness in order to allow toml to be used with [BurntSushi's toml test suite](https://github.com/BurntSushi/toml-test), written in Go. - -## Usage -1. Install Go (golang) -2. The toml-test suite - 1. [Instructions](https://github.com/BurntSushi/toml-test#try-it-out) -3. Execute with either of: - * `~/go/bin/toml-test ./tests/decoding_test.sh` - Default (PATH) Python version - * `~/go/bin/toml-test ./tests/decoding_test2.sh` - Python 2 - * `~/go/bin/toml-test ./tests/decoding_test3.sh` - Python 3 - -## Addendum -There's also two Python test-files in the `./tests` directory -* `example_test.py`, -* and `decoding_test.py`. - -Both of which require the `toml` library to be importable (aka `import toml` to work). -Both also require Python 3 (due to using `print()`). diff --git a/tests/example_test.py b/tests/example_test.py deleted file mode 100755 index b2d87a3..0000000 --- a/tests/example_test.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python -"""Decodes toml and outputs it as JSON""" - -import toml_test -import toml -import sys -import json - -if __name__ == '__main__': - tdata = toml.loads(sys.stdin.detach().read().decode('utf-8')) - tagged = toml_test.tag(tdata) - print(json.dumps(tagged))