Skip to content

Commit 529e1ce

Browse files
committed
Initial commit of v0.24. Migrated from svn
1 parent fdf83fa commit 529e1ce

File tree

7 files changed

+1389
-2
lines changed

7 files changed

+1389
-2
lines changed

CHANGELOG

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
+++++++++++
2+
LabKey Python Client API News
3+
+++++++++++
4+
5+
6+
What's New in the LabKey 0.24 package
7+
==============================
8+
9+
*Release date: 03/20/2015*
10+
11+
- Fixed bug in updateWiki due to changes in LabKey Server v15.1
12+
13+
14+
What's New in the LabKey 0.23 package
15+
==============================
16+
17+
*Release date: 11/24/2014*
18+
19+
- Force all SSL connections to use TLSv1 Protocol or higher.
20+
This disables the use of SSLv2(Heartbleed) and SSLv3(Poodle) to
21+
protect against the Heartbleed and Poodle vulnerabilities.
22+
23+
24+
What's New in the LabKey 0.22 package
25+
==============================
26+
27+
*Release date: 04/15/2014*
28+
29+
- Fixed bug in updateWiki when updating a wiki where Guests have read access
30+
31+
32+
What's New in the LabKey 0.21 package
33+
==============================
34+
35+
*Release date: 03/30/2012*
36+
37+
- Fixed bug in updateWiki due to changes in LabKey Server v12.1
38+
39+
40+
What's New in the LabKey 0.20 package
41+
==============================
42+
43+
*Release date: 01/25/2012*
44+
45+
- Fixed authentication bug in labkey.wiki and labkey.messageboard
46+
functions.
47+
48+
49+
What's New in the LabKey 0.19 package
50+
==============================
51+
52+
*Release date: 11/02/2011*
53+
54+
- Updated name of the sample labkeycredentials file
55+
56+
- Cleaned up docstring comments in each module file.
57+
58+
- Checked into the LabKey subversion repository.
59+
60+
61+
What's New in the LabKey 0.18 package
62+
==============================
63+
64+
*Release date: 10/25/2011*
65+
66+
- Created README.txt, MANIFEST.in. Added further package information to
67+
setup.py
68+
69+
- Added empty test directory that will be used in future releases
70+
for unit tests
71+
72+
73+
What's New in the LabKey 0.16 package
74+
==============================
75+
76+
*Release date: Unreleased*
77+
78+
- Ported labkeyquery.py from a stand-alone module to be part of this
79+
package. To access the functions that were in labkeyquery.py, you
80+
will need to import labkey or import labkey.query
81+
82+
- Added collaboration module which allows programmatic access to
83+
wikis and message boards on the LabKey Server

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
1-
# labkey-api-python
2-
Python client API for LabKey Server
1+
# About
2+
Python client API for LabKey Server. To get started, please see the [full documentation for this library](https://www.labkey.org/wiki/home/Documentation/page.view?name=python).
3+
4+
# Installation
5+
Currently, the labkey-api-python library can only be installed via source. To install, clone this repository then run:
6+
7+
```bash
8+
$ python setup.py install
9+
```
10+
11+
# Credentials
12+
In order to the use the Python client API for LabKey Server, you will need to specify your login credentials in a credential file. The package assumes that this file will be located either:
13+
14+
1. ``$HOME/.labkeycredentials.txt``
15+
2. The location will be specified in the ``LABKEY_CREDENTIALS`` environment variable.
16+
17+
The ``labkeycredentials`` file must be in the following format. (3 separate lines):
18+
```
19+
machine https://hosted.labkey.com
20+
login labkeypython@gmail.com
21+
password python
22+
```
23+
where:
24+
- machine: URL of your LabKey Server
25+
- login: email address to be used to login to the LabKey Server
26+
- password: password associated with the login
27+
28+
A sample ``labkeycredentials`` file has been shipped with the source and named ``.labkeycredentials.sample``.
29+
30+
# Supported Versions
31+
Python 2.6 or 2.7 are fully supported.
32+
LabKey Server v11.1 and later.
33+
34+
# Contributing
35+
This library and the LabKey Server are maintained by the LabKey Software Foundation. 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).

labkeyapi/__init__.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#
2+
# Copyright (c) 2011-2014 LabKey Corporation
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#
16+
import labkey
17+
import labkey.query
18+
import labkey.wiki
19+
import labkey.messageboard

0 commit comments

Comments
 (0)