|
1 |
| -Python API for LabKey Server. Lets you query, insert, and update data on a LabKey Server using Python. |
| 1 | +# Python API for LabKey Server |
| 2 | +<p> |
| 3 | + <a href="https://pypi.python.org/pypi/labkey"><img src="https://img.shields.io/pypi/v/labkey.svg" alt="pypi version"></a> |
| 4 | +</p> |
| 5 | +Lets you query, insert, and update data on a [LabKey Server](http://www.labkey.com/) using Python. |
2 | 6 |
|
3 |
| -## Release Notes |
| 7 | +## Features |
4 | 8 |
|
5 |
| -Changes in the current release: |
6 |
| - |
7 |
| -- Support for Python 3 |
8 |
| -- Use netrc files for credentials -- see [Credentials](#credentials) |
9 |
| -- New methods for working with assay data: |
10 |
| - - [load_batch](./labkey/experiment.py) |
11 |
| - - [save_batch](./labkey/experiment.py) |
12 |
| -- server_context parameter added to all methods |
13 |
| -- PEP standards - the latest version follows PEP code styling standards |
14 |
| -- New [samples](./samples) |
| 9 | +- **labkey.query.select_rows()** - Query and get results sets from LabKey Server. |
| 10 | +- **labkey.query.execute_sql()** - Execute SQL (LabKey SQL dialect) through the query module on LabKey Server. |
| 11 | +- **labkey.query.insert_rows()** - Insert rows into a table on LabKey Server. |
| 12 | +- **labkey.query.update_rows()** - Update rows in a table on LabKey Server. |
| 13 | +- **labkey.query.delete_rows()** - Delete records in a table on LabKey Server. |
| 14 | +- **labkey.experiment.load_batch()** - Retreive assay data (batch level) from LabKey Server. |
| 15 | +- **labkey.experiment.save_batch()** - Save assay data (batch level) on LabKey Server. |
15 | 16 |
|
16 | 17 | ## Installation
|
17 | 18 | To install, simply use `pip`:
|
@@ -48,16 +49,6 @@ password mypassword
|
48 | 49 | ```
|
49 | 50 | Note that the netrc file only deals with connections at the machine level and should not include a port or protocol designation, meaning both "mymachine.labkey.org:8888" and "https://mymachine.labkey.org" are incorrect.
|
50 | 51 |
|
51 |
| -## Supported Functions |
52 |
| - |
53 |
| -- **labkey.query.select_rows()** - Query and get results sets from LabKey Server. |
54 |
| -- **labkey.query.execute_sql()** - Execute SQL (LabKey SQL dialect) through the query module on LabKey Server. |
55 |
| -- **labkey.query.insert_rows()** - Insert rows into a table on LabKey Server. |
56 |
| -- **labkey.query.update_rows()** - Update rows in a table on LabKey Server. |
57 |
| -- **labkey.query.delete_rows()** - Delete records in a table on LabKey Server. |
58 |
| -- **labkey.experiment.load_batch()** - Retreive assay data (batch level) from LabKey Server. |
59 |
| -- **labkey.experiment.save_batch()** - Save assay data (batch level) on LabKey Server. |
60 |
| - |
61 | 52 | ## Examples
|
62 | 53 |
|
63 | 54 | Sample code is available in the [samples](https://github.com/LabKey/labkey-api-python/tree/master/samples) directory.
|
@@ -90,7 +81,7 @@ Python 2.6+ and 3.4+ are fully supported.
|
90 | 81 | LabKey Server v13.3 and later.
|
91 | 82 |
|
92 | 83 | ## Contributing
|
93 |
| -This library and the LabKey Server are maintained by LabKey. If you have any questions or need support, please use the [LabKey Server support forum](https://www.labkey.org/wiki/home/page.view?name=support) |
| 84 | +This package is maintained by [LabKey](http://www.labkey.com/). If you have any questions or need support, please use the [LabKey Server support forum](https://www.labkey.org/wiki/home/page.view?name=support). |
94 | 85 |
|
95 | 86 | ### Testing
|
96 | 87 | If you are looking to contribute please run the tests before issuing a PR. For now you need to manually get the dependencies:
|
|
0 commit comments