https://github.com/dictybase/modware-stock
dictyBase grpc service to manage biological stocks
https://github.com/dictybase/modware-stock
golang grpc
Last synced: about 1 year ago
JSON representation
dictyBase grpc service to manage biological stocks
- Host: GitHub
- URL: https://github.com/dictybase/modware-stock
- Owner: dictyBase
- License: bsd-2-clause
- Created: 2018-12-17T19:14:45.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-13T21:50:53.000Z (over 1 year ago)
- Last Synced: 2025-03-04T20:40:36.342Z (about 1 year ago)
- Topics: golang, grpc
- Language: Go
- Size: 1020 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# modware-stock
[](LICENSE)
[](https://codecov.io/gh/dictyBase/modware-stock)
[](https://codeclimate.com/github/dictyBase/modware-stock/maintainability)
[](https://reporter.nih.gov/project-details/10024726)
dictyBase API server to manage biological stocks. The API server supports gRPC protocol for data exchange.
## Usage
```bash
NAME:
modware-stock - cli for modware-stock microservice
USAGE:
modware-stock [global options] command [command options] [arguments...]
VERSION:
1.0.0
COMMANDS:
start-server starts the modware-stock microservice with grpc backends
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--log-format value format of the logging out, either of json or text. (default: "json")
--log-level value log level for the application (default: "error")
--help, -h show help
--version, -v print the version
```
## Subcommand
```bash
NAME:
modware-stock start-server - starts the modware-stock microservice with grpc backends
USAGE:
modware-stock start-server [command options] [arguments...]
OPTIONS:
--port value tcp port at which the server will be available (default: "9560")
--stock-collection value arangodb collection for storing biological stocks (default: "stock")
--stockprop-collection value arangodb collection for storing stock properties (default: "stockprop")
--stock-key-generator-collection value arangodb collection for generating unique IDs (default: "stock_key_generator")
--stock-type-edge value arangodb edge collection for connecting stocks to their types (strain or plasmid) (default: "stock_type")
--parent-strain-edge value arangodb edge collection for connecting strains to their parent (default: "parent_strain")
--stockproptype-graph value arangodb named graph for managing relations between stocks and their properties (default: "stockprop_type")
--strain2parent-graph value arangodb named graph for managing relations between strains and their parents (default: "strain2parent")
--reflection, --ref flag for enabling server reflection
--arangodb-pass value, --pass value arangodb database password [$ARANGODB_PASS]
--arangodb-database value, --db value arangodb database name [$ARANGODB_DATABASE]
--arangodb-user value, --user value arangodb database user [$ARANGODB_USER]
--arangodb-host value, --host value arangodb database host (default: "arangodb") [$ARANGODB_SERVICE_HOST]
--arangodb-port value arangodb database port (default: "8529") [$ARANGODB_SERVICE_PORT]
--is-secure flag for secured or unsecured arangodb endpoint
--nats-host value nats messaging server host [$NATS_SERVICE_HOST]
--nats-port value nats messaging server port [$NATS_SERVICE_PORT]
```
## Default Names
### Collections
- stock
- stockprop
- stock_key_generator
### Edge Collections
- parent_strain
- stock_type
### Graphs
- stockprop_type
- strain2parent
## API
### gRPC
The protocol buffer definitions and service apis are documented
[here](https://github.com/dictyBase/dictybaseapis/blob/master/dictybase/stock/stock.proto).
# Misc badges
[](https://codeclimate.com/github/dictyBase/modware-stock/code)