|
| 1 | +Testlink-tests |
| 2 | +============== |
| 3 | + |
| 4 | + |
| 5 | +.. image:: https://img.shields.io/github/issues/TestLinkOpenSourceTRMS/testlink-tests.svg |
| 6 | + :alt: Issues on Github |
| 7 | + :target: https://github.com/TestLinkOpenSourceTRMS/testlink-tests/issues |
| 8 | + |
| 9 | +.. image:: https://img.shields.io/github/issues-pr/TestLinkOpenSourceTRMS/testlink-tests.svg |
| 10 | + :alt: Pull Request opened on Github |
| 11 | + :target: https://github.com/TestLinkOpenSourceTRMS/testlink-tests/issues |
| 12 | + |
| 13 | +.. image:: https://img.shields.io/github/release/TestLinkOpenSourceTRMS/testlink-tests.svg |
| 14 | + :alt: Release version on Github |
| 15 | + :target: https://github.com/TestLinkOpenSourceTRMS/testlink-tests/releases/latest |
| 16 | + |
| 17 | +.. image:: https://img.shields.io/github/release-date/TestLinkOpenSourceTRMS/testlink-tests.svg |
| 18 | + :alt: Release date on Github |
| 19 | + :target: https://github.com/TestLinkOpenSourceTRMS/testlink-tests/releases/latest |
| 20 | + |
| 21 | + |
| 22 | ++-----------------------+-----------------------+--------------------------+--------------------------+------------------------------+ |
| 23 | +| Branch | TravisCI | Appveyor | CircleCi - Docker | CodeClimate | |
| 24 | ++=======================+=======================+==========================+==========================+==============================+ |
| 25 | +| master | |master_ci_travis| | |master_ci_appveyor| | |master_ci_circleci| | |master_ci_codeclimate| | |
| 26 | ++-----------------------+-----------------------+--------------------------+--------------------------+------------------------------+ |
| 27 | + |
| 28 | + |
| 29 | +Python tested versions |
| 30 | +---------------------- |
| 31 | + |
| 32 | ++-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+ |
| 33 | +| **3.6** | **3.5** | **3.4** | **3.3** | **3.2** | **2.7** | |
| 34 | ++===================+===================+===================+===================+===================+===================+ |
| 35 | +| *Supported* | *Supported* | *Supported* | *Not Supported* | *Not Supported* | *Supported* | |
| 36 | ++-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+ |
| 37 | + |
| 38 | + |
| 39 | +Prerequisites |
| 40 | +------------- |
| 41 | + |
| 42 | ++ Prerequisites : ``TODO: make sense`` |
| 43 | + |
| 44 | + |
| 45 | +How to install ? |
| 46 | +---------------- |
| 47 | + |
| 48 | ++ Install from PIP : ``pip install testlinktests`` |
| 49 | + |
| 50 | ++ Install from setup.py file : ``python setup.py install`` |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | +How to exec tests ? |
| 55 | +------------------- |
| 56 | + |
| 57 | ++ Tests from setup.py file : ``python setup.py test`` |
| 58 | + |
| 59 | ++ Install from PIP file : ``pip install tox`` |
| 60 | ++ Tests from tox : ``tox -l && tox -e TOX_ENV_NAME`` ( *see tox.ini file to get environment names* ) |
| 61 | + |
| 62 | + |
| 63 | ++---------------------+--------------------------------+ |
| 64 | +| TOX Env name | Env description | |
| 65 | ++=====================+================================+ |
| 66 | +| py27,py34,py35,py36 | Python supported versions | |
| 67 | ++---------------------+--------------------------------+ |
| 68 | +| flake8 | Exec linter in qalab/ tests/ | |
| 69 | ++---------------------+--------------------------------+ |
| 70 | +| coverage | Generate XML and HTML reports | |
| 71 | ++---------------------+--------------------------------+ |
| 72 | +| docs | Generate doc HTML in /docs | |
| 73 | ++---------------------+--------------------------------+ |
| 74 | + |
| 75 | +Configuration File |
| 76 | +~~~~~~~~~~~~~~~~~~ |
| 77 | + |
| 78 | + |
| 79 | +:: |
| 80 | + |
| 81 | + { |
| 82 | + "connection":{ |
| 83 | + "is_https": false, |
| 84 | + "host": "qalab.tk", |
| 85 | + "port": 86 |
| 86 | + }, |
| 87 | + "dev_key": "1bfd2ef4ceda22b482b12f2b25457495", |
| 88 | + "log_level":"DEBUG", |
| 89 | + } |
| 90 | + |
| 91 | +Getting Started |
| 92 | +~~~~~~~~~~~~~~~ |
| 93 | + |
| 94 | +*Just starting example of usage before read* `Usage Guide`_. |
| 95 | + |
| 96 | + |
| 97 | +.. _Usage Guide: USAGE.rst |
| 98 | +.. |master_ci_travis| image:: https://travis-ci.org/netzulo/testlink-tests.svg?branch=master |
| 99 | + :target: https://travis-ci.org/netzulo/testlink-tests |
| 100 | +.. |master_ci_appveyor| image:: https://ci.appveyor.com/api/projects/status/8kqf9o9mjgvte40j?svg=true |
| 101 | + :target: https://ci.appveyor.com/project/netzulo/testlink-tests |
| 102 | +.. |master_ci_circleci| image:: https://circleci.com/gh/netzulo/testlink-tests.svg?style=svg |
| 103 | + :target: https://circleci.com/gh/netzulo/testlink-tests) |
| 104 | +.. |master_ci_codeclimate| image:: https://api.codeclimate.com/v1/badges/84904556cd07ad4fcf00/maintainability |
| 105 | + :target: https://codeclimate.com/github/netzulo/testlink-tests/maintainability |
0 commit comments