Schul-Cloud Content API
Project description
This repository contains
a server to test scrapers against
tests to test the server
Installation
Using pip, you can install all dependencies like this:
pip install --user -r requirements.txt test-requrements.txt
Server
You can find the API definition. The server serves according to the API. It verifies the input and output for correctness.
To start the server, run
python3 -m schul_cloud_ressources_server_tests.app
Tests
You always test against the running server. Tests may delete everyting you can reach. If you test the running server, make sure to authenticate in a way that does not destroy the data you want to keep.
pytest --pyargs schul_cloud_ressources_server_tests.test --url=http://localhost:8080/v1/
http://localhost:8080/v1/ is the default url.
Steps for Implementation
If you want to implement your serverm you can follow the TDD steps to implement one test after the other.
pytest --pyargs schul_cloud_ressources_server_tests.test -m step1
pytest --pyargs schul_cloud_ressources_server_tests.test -m step2
pytest --pyargs schul_cloud_ressources_server_tests.test -m step3
...
step1 runs the first test
step2 runs the first and the second test
step3 runs the first, second and third test
…
You can run a single test with
pytest --pyargs schul_cloud_ressources_server_tests.test -m step3only
TODO
generate a docker container for the server
generate a docker container for the tests
document how to embed the tests and the server in
a crawler
travis build script of arbitrary language
create example crawler with tests
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
Built Distribution
Hashes for schul_cloud_ressources_server_tests-1.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d450f646be2b91b550d2139ad0925343af7461ad84adc6419fe950512bbc6ea7 |
|
MD5 | 0ad0911172f50f12b69431dbccbd7c1f |
|
BLAKE2b-256 | 17c0702a8d6ba34bfcdafaf0489189cab442202c0ffb9e0deebda1f4f8e0560c |
Hashes for schul_cloud_ressources_server_tests-1.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09f69cffcd2d6bf65dc4c4fa07173164fd7a61b33993c79abcb13c53eceabde8 |
|
MD5 | e3413a9b8880c85e1e15015ec396faf5 |
|
BLAKE2b-256 | ed1766b144d3f8ce9152bba988abb18be2c5ca1fcfb999bb46681619f1d6ad0b |