Skip to content

Commit 65d95dc

Browse files
authored
33287: Support domain APIs (#13)
1 parent 1df56a2 commit 65d95dc

21 files changed

+1054
-228
lines changed

README.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,30 @@ Lets you query, insert, and update data on a [LabKey Server](https://www.labkey.
99

1010
The following APIs can be used against a LabKey Server instance.
1111

12-
Query API (labkey.query)
12+
Query API - [sample code](samples/query_examples.py)
1313

1414
- **delete_rows()** - Delete records in a table.
1515
- **execute_sql()** - Execute SQL (LabKey SQL dialect) through the query module.
1616
- **insert_rows()** - Insert rows into a table.
1717
- **select_rows()** - Query and get results sets.
1818
- **update_rows()** - Update rows in a table.
1919

20-
Experiment API (labkey.experiment)
20+
Domain API - [sample code](samples/domain_example.py)
21+
22+
- **create()** - Create many types of domains (e.g. lists, datsets).
23+
- **drop()** - Delete a domain.
24+
- **get()** - Get a domain design.
25+
- **infer_fields()** - Infer fields for a domain design from a file.
26+
- **save()** - Save changes to a domain design.
27+
28+
Experiment API - [sample code](samples/experiment_example.py)
2129

2230
- **load_batch()** - Retrieve assay data (batch level).
23-
- **save_batch()** - Save assay data (batch level)
31+
- **save_batch()** - Save assay data (batch level).
32+
33+
Security API - [sample code](samples/security_example.py)
2434

25-
Security API (labkey.security). Available for administrating and configuring user accounts and permissions.
35+
- Available for administrating and configuring user accounts and permissions.
2636

2737
## Installation
2838
To install, simply use `pip`:
@@ -93,7 +103,7 @@ Python 2.6+ and 3.4+ are fully supported.
93103
LabKey Server v15.1 and later.
94104

95105
## Contributing
96-
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).
106+
This package is maintained by [LabKey](http://www.labkey.com/). If you have any questions or need support, please use the [LabKey Server developer support forum](https://www.labkey.org/home/Support/Developer%20Forum/project-begin.view?).
97107

98108
### Testing
99109
If you are looking to contribute please run the tests before issuing a PR. For now you need to manually get the dependencies:

labkey/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
from labkey import query, experiment, security, utils
16+
from labkey import domain, query, experiment, security, utils
1717

1818
__title__ = 'labkey'
1919
__version__ = '0.6.1'

0 commit comments

Comments
 (0)