|
1 | 1 | <h1 align="center">pepdbagent</h1>
|
2 |
| -<p align="center"> |
3 | 2 |
|
4 | 3 | [](https://pep.databio.org/)
|
5 | 4 | 
|
|
8 | 7 | [](https://pepy.tech/project/pepdbagent)
|
9 | 8 | [](https://github.com/pepkit/pepdbagent)
|
10 | 9 |
|
11 |
| -</p> |
12 | 10 |
|
13 | 11 | ---
|
14 | 12 |
|
|
19 | 17 | ---
|
20 | 18 |
|
21 | 19 | `pepdbagent` is a Python library and toolkit that gives a user-friendly
|
22 |
| -interface to connect, upload, update and retrieve information from pep database. This library is designed to work |
23 |
| -to be used by PEPhub, but it can be used for any other purpose, to manage data in pep database. |
| 20 | +interface to connect, upload, update and retrieve information from the pep database. This library is designed to work |
| 21 | +with PEPhub, but it can be used for any other purpose. |
24 | 22 |
|
25 |
| -pepdbagent creates a connection to the database and creates table schemas for the PEPhub database if necessary. |
| 23 | +`pepdbagent` creates a connection to the database and creates table schemas for the PEPhub database if necessary. |
26 | 24 | Core database is `postgres` database, but it can be easily extended to other relational databases.
|
27 |
| -To use `pepdbagent`, you need to have a database instance running with it's credentials. |
| 25 | +To use `pepdbagent`, you need to have a database instance running with its credentials. |
28 | 26 | If the version of the database schema is not compatible with the version of `pepdbagent`, it will throw an exception.
|
29 | 27 |
|
30 | 28 | ## Installation
|
@@ -128,7 +126,7 @@ Example:
|
128 | 126 | # search for a specified pattern of namespace in database.
|
129 | 127 | agent.namespace.get(query='Namespace')
|
130 | 128 |
|
131 |
| -# By default all get function will retrun namespace information for public projects, |
| 129 | +# By default all get functions will return namespace information for public projects, |
132 | 130 | # To get information with private projects, admin list should be provided.
|
133 | 131 | # admin list means list of namespaces where user has admin rights
|
134 | 132 | # For example:
|
|
0 commit comments