Test RAML API definition
Project description
# `Ra`
[![Build Status](https://travis-ci.org/ramses-tech/ra.svg?branch=master)](https://travis-ci.org/ramses-tech/ra)
[![Documentation](https://readthedocs.org/projects/ra/badge/?version=stable)](http://ra.readthedocs.org)
Ra is a test suite generator and helper library for testing APIs described
in [RAML](http://raml.org/).
Out of the box, Ra provides a basic, automated test suite to test the routes
declared in the RAML document. It provides test helpers for augmenting these
with custom tests to test application-specific logic, side effects, etc.
Ra is primarily designed to provide testing support for
[ramses](http://github.com/ramses-tech/ramses) and
[nefertari](http://github.com/ramses-tech/nefertari) applications, but can
be used with any WSGI-conformant, RAML-described API.
It currently depends on pytest but may be adapted for other test frameworks
in the future. It works best using WebTest but doesn't require it.
## Name
Ra was the god of the sun, the most important god in ancient Egypt.
## Try it (dev)
Run the test suite:
```bash
$ pip install -r requirements.txt
$ py.test
```
Check out the example:
```bash
$ cd examples/ramses-test
$ pip install -r requirements.txt
$ py.test
```
The example RAML at `examples/ramses-test/api.raml` and the test file
`examples/ramses-test/tests/test_api.py` should be helpful to reference.
See the docs in `docs/`, and the `api.raml` and `tests/test_api.py` in
`tests/apps/ramses_test`
[![Build Status](https://travis-ci.org/ramses-tech/ra.svg?branch=master)](https://travis-ci.org/ramses-tech/ra)
[![Documentation](https://readthedocs.org/projects/ra/badge/?version=stable)](http://ra.readthedocs.org)
Ra is a test suite generator and helper library for testing APIs described
in [RAML](http://raml.org/).
Out of the box, Ra provides a basic, automated test suite to test the routes
declared in the RAML document. It provides test helpers for augmenting these
with custom tests to test application-specific logic, side effects, etc.
Ra is primarily designed to provide testing support for
[ramses](http://github.com/ramses-tech/ramses) and
[nefertari](http://github.com/ramses-tech/nefertari) applications, but can
be used with any WSGI-conformant, RAML-described API.
It currently depends on pytest but may be adapted for other test frameworks
in the future. It works best using WebTest but doesn't require it.
## Name
Ra was the god of the sun, the most important god in ancient Egypt.
## Try it (dev)
Run the test suite:
```bash
$ pip install -r requirements.txt
$ py.test
```
Check out the example:
```bash
$ cd examples/ramses-test
$ pip install -r requirements.txt
$ py.test
```
The example RAML at `examples/ramses-test/api.raml` and the test file
`examples/ramses-test/tests/test_api.py` should be helpful to reference.
See the docs in `docs/`, and the `api.raml` and `tests/test_api.py` in
`tests/apps/ramses_test`
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ra-0.2.0.tar.gz
(14.0 kB
view details)
File details
Details for the file ra-0.2.0.tar.gz
.
File metadata
- Download URL: ra-0.2.0.tar.gz
- Upload date:
- Size: 14.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2617d27d33b1b53a14748fb64ec7f2ba6ec212a9da53cd6175540e7bdff9a3eb |
|
MD5 | a149f3f7864bea3b043d22835a98f928 |
|
BLAKE2b-256 | 34eadcb7b17f3352dc094c53e2aa1c7023fdb8d64085aab72783fec435cc0512 |