Skip to content

Commit 011b6f7

Browse files
committed
Update description for PyPi
1 parent aa75252 commit 011b6f7

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

setup.py

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,61 @@
2424
except ImportError as error:
2525
from distutils.core import setup
2626

27+
long_description = """
28+
The Database Library for [Robot Framework](https://robotframework.org) allows you to query a database and verify the results.
29+
It requires an appropriate **Python module to be installed separately** - depending on your database, like e.g. `oracledb` or `pymysql`.
30+
31+
The library consists of some keywords designed to perform different checks on your database.
32+
Here you can find the [keyword docs](http://marketsquare.github.io/Robotframework-Database-Library/).
33+
34+
# Requirements
35+
- Python
36+
- Robot Framework
37+
- Python database module you're going to use - e.g. `oracledb`
38+
39+
# Installation
40+
```
41+
pip install robotframework-databaselibrary
42+
```
43+
Don't forget to install the required Python database module!
44+
45+
# Usage example
46+
```RobotFramework
47+
*** Settings ***
48+
Library DatabaseLibrary
49+
Test Setup Connect To My Oracle DB
50+
51+
*** Keywords ***
52+
Connect To My Oracle DB
53+
Connect To Database
54+
... oracledb
55+
... dbName=db
56+
... dbUsername=my_user
57+
... dbPassword=my_pass
58+
... dbHost=127.0.0.1
59+
... dbPort=1521
60+
61+
*** Test Cases ***
62+
Person Table Contains Expected Records
63+
${output}= Query select LAST_NAME from person
64+
Length Should Be ${output} 2
65+
Should Be Equal ${output}[0][0] See
66+
Should Be Equal ${output}[1][0] Schneider
67+
68+
Person Table Contains No Joe
69+
${sql}= Catenate SELECT id FROM person
70+
... WHERE FIRST_NAME= 'Joe'
71+
Check If Not Exists In Database ${sql}
72+
```
73+
74+
# Database modules compatibility
75+
The library is basically compatible with any [Python Database API Specification 2.0](https://peps.python.org/pep-0249/) module.
76+
77+
However, the actual implementation in existing Python modules is sometimes quite different, which requires custom handling in the library.
78+
Therefore there are some modules, which are "natively" supported in the library - and others, which may work and may not.
79+
80+
See more on the [project page on GitHub](https://github.com/MarketSquare/Robotframework-Database-Library).
81+
"""
2782

2883
version_file = join(dirname(abspath(__file__)), 'src', 'DatabaseLibrary', 'version.py')
2984

@@ -34,6 +89,8 @@
3489
setup(name = 'robotframework-databaselibrary',
3590
version = VERSION,
3691
description = 'Database utility library for Robot Framework',
92+
long_description=long_description,
93+
long_description_content_type="text/markdown",
3794
author = 'Franz Allan Valencia See',
3895
author_email = '[email protected]',
3996
url = 'https://github.com/MarketSquare/Robotframework-Database-Library',

0 commit comments

Comments
 (0)