Skip to content

Commit 99ddf16

Browse files
committed
Unify instructions between README and docs
move everything into documentation to avoid duplicates
1 parent 6a95519 commit 99ddf16

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

README.rst

+3-22
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,12 @@ Python API for Kiwi TCMS
2929

3030

3131
This package allows to connect and access Kiwi TCMS API.
32-
For more information see
33-
http://kiwitcms.readthedocs.io/en/latest/api/index.html.
3432

3533

36-
INSTALLATION
37-
------------
34+
DOCUMENTATION
35+
-------------
3836

39-
::
40-
41-
pip install tcms-api
42-
43-
If you want to use Kerberos then::
44-
45-
pip install tcms-api[gssapi]
46-
47-
**WARNING:** on Windows you need to install MIT Kerberos and make sure
48-
``C:\Program Files\MIT\Kerberos\bin`` is included in ``%PATH%`` -
49-
this is usually the case when you install and restart! It must be
50-
a 64bit installation, see
51-
`MIT Kerberos for Windows 4.1 <https://web.mit.edu/kerberos/dist/index.html#kfw-4.1>`_
52-
53-
**WARNING:** on Linux you will need gcc, Python and kerberos devel packages to
54-
build ``gssapi`` because it doesn't provide binary packages. Try
55-
``dnf install gcc krb5-devel python3-devel`` (Red Hat/Fedora) or
56-
``apt-get install gcc libkrb5-dev libpython3-dev`` (Debian/Ubuntu).
37+
https://tcms-api.readthedocs.io/en/latest/modules/tcms_api.html
5738

5839

5940
CHANGELOG

tcms_api/__init__.py

+19
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22
#
33
# Python API for the Kiwi TCMS test case management system.
4+
#
45
# Copyright (c) 2012 Red Hat, Inc. All rights reserved.
56
# Author: Petr Splichal <[email protected]>
67
#
@@ -25,10 +26,28 @@
2526
This module provides a dictionary based Python interface for the
2627
Kiwi TCMS test management system. It operates via the XML-RPC protocol.
2728
29+
2830
Installation::
2931
3032
pip install tcms-api
3133
34+
35+
If you want to use Kerberos then::
36+
37+
pip install tcms-api[gssapi]
38+
39+
**WARNING:** on Windows you need to install MIT Kerberos and make sure
40+
``C:\\Program Files\\MIT\\Kerberos\\bin`` is included in ``%PATH%`` -
41+
this is usually the case when you install and restart! It must be
42+
a 64bit installation, see
43+
`MIT Kerberos for Windows 4.1 <https://web.mit.edu/kerberos/dist/index.html#kfw-4.1>`_
44+
45+
**WARNING:** on Linux you will need gcc, Python and kerberos devel packages to
46+
build ``gssapi`` because it doesn't provide binary packages via PyPI. Try
47+
``dnf install gcc krb5-devel python3-devel`` (Red Hat/Fedora) or
48+
``apt-get install gcc libkrb5-dev libpython3-dev`` (Debian/Ubuntu).
49+
50+
3251
Minimal config file ``~/.tcms.conf``::
3352
3453
[tcms]

0 commit comments

Comments
 (0)