Skip to content

33287: Support domain APIs #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
May 10, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,30 @@ Lets you query, insert, and update data on a [LabKey Server](https://www.labkey.

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

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

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

Experiment API (labkey.experiment)
Domain API - [sample code](samples/domain_example.py)

- **create()** - Create many types of domains (e.g. lists, datsets).
- **drop()** - Delete a domain.
- **get()** - Get a domain design.
- **infer_fields()** - Infer fields for a domain design from a file.
- **save()** - Save changes to a domain design.

Experiment API - [sample code](samples/experiment_example.py)

- **load_batch()** - Retrieve assay data (batch level).
- **save_batch()** - Save assay data (batch level)
- **save_batch()** - Save assay data (batch level).

Security API - [sample code](samples/security_example.py)

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

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

## Contributing
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).
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?).

### Testing
If you are looking to contribute please run the tests before issuing a PR. For now you need to manually get the dependencies:
Expand Down
2 changes: 1 addition & 1 deletion labkey/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
from labkey import query, experiment, security, utils
from labkey import domain, query, experiment, security, utils

__title__ = 'labkey'
__version__ = '0.6.1'
Expand Down
Loading