# Artifact API Requirements **URL:** \ **Category:** Developer Discussion\ **Tags:** install, docker\ **Created:** [July 13, 2018, 6:12pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038 "2018-07-13T18:12:25Z")\ **Posts on this page:** 15\ **Page:** 1
**Author:** ![Matt\_Kizaric1](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/m/e5b9ba/32.png) [@Matt\_Kizaric1](https://forum.qiime2.org/u/Matt_Kizaric1)\ **Post date:** [July 13, 2018, 6:12pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/1 "2018-07-13T18:12:25Z")
Hi! I was looking to extend the Artifact and Plugin APIs for a project I am working on, so I grabbed the module qiime/core from your github page. However when I go to run a very basic "Hello World" script, I am bombarded with ModuleNotFoundErrors. I realized that the github page does not list the required dependencies for the core module and I will probably have to scrape through a previous cli install to find most of them. Could you please list the requirements for the core module somewhere on the github page or website? Thanks! ---
**Author:** ![thermokarst](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/t/8e7dd6/32.png) [@thermokarst](https://forum.qiime2.org/u/thermokarst)\ **Post date:** [July 16, 2018, 3:34pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/2 "2018-07-16T15:34:48Z")
---
**Author:** ![thermokarst](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/t/8e7dd6/32.png) [@thermokarst](https://forum.qiime2.org/u/thermokarst)\ **Post date:** [July 17, 2018, 1:01pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/3 "2018-07-17T13:01:21Z")
Hey there @Matt_Kizaric1! What are you working on - it sounds like maybe you are working on using the Artifact API for analysis, or maybe writing a new plugin? The easiest way to get a development environment bootstrapped is to follow our [quickstart guide.](https://dev.qiime2.org/latest/quickstart/) > [@Matt\_Kizaric1](#): > > Could you please list the requirements for the core module somewhere on the github page or website? Each individual code repo on our [GitHub Org](https://github.com/qiime2) has a `meta.yaml` file in it, used for building `conda` packages - this lists the dependencies (e.g., [the QIIME 2 framework](https://github.com/qiime2/qiime2/blob/master/ci/recipe/meta.yaml)) . Hope that helps! :qiime2: 🦖 ---
**Author:** ![thermokarst](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/t/8e7dd6/32.png) [@thermokarst](https://forum.qiime2.org/u/thermokarst)\ **Post date:** [July 17, 2018, 1:01pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/4 "2018-07-17T13:01:23Z")
---
**Author:** ![Matt\_Kizaric1](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/m/e5b9ba/32.png) [@Matt\_Kizaric1](https://forum.qiime2.org/u/Matt_Kizaric1)\ **Post date:** [July 18, 2018, 2:53pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/5 "2018-07-18T14:53:37Z")
I was working on developing a docker wrapper for the cli since it does not persist when running in docker. However, I decided to do this a bit differently and do a REST API to send commands. I was wondering if the Docker image was intended to not persist and be controlled with a single shell script. If so, I think it might be a good idea to have a distribution that's made for servers that allows for real-time control and execution of commands from outside the environment. Just some thoughts, but thank you for the info! ---
**Author:** ![thermokarst](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/t/8e7dd6/32.png) [@thermokarst](https://forum.qiime2.org/u/thermokarst)\ **Post date:** [July 18, 2018, 4:19pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/6 "2018-07-18T16:19:05Z")
---
**Author:** ![thermokarst](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/t/8e7dd6/32.png) [@thermokarst](https://forum.qiime2.org/u/thermokarst)\ **Post date:** [July 19, 2018, 12:45pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/7 "2018-07-19T12:45:45Z")
Hey hey @Matt_Kizaric1! > [@Matt\_Kizaric1](#): > > since it does not persist when running in docker This is basically how docker itself is designed to operate - disposable containers don't persist data, _unless_ you ask them to! It sounds like maybe you aren't mounting a volume while running the docker container - that will certainly make things difficult in terms of persistence. As well, you can run things in interactive and TTY mode - at that point its basically like you are running the command natively ([check out our simple example in the docs](https://docs.qiime2.org/2018.6/install/virtual/docker/)): ```bash $ ls demux.qza # This is local, on my host laptop # Volume mounting with -v, run QIIME 2 in a docker container $ docker run -t -i -v $(pwd):/data qiime2/core:2018.6 qiime demux summarize --i-data demux.qza --o-visualization demux.qzv $ ls demux.qza demux.qzv # still local! ``` ```bash # TTY/interactive mode with -t -i $ docker run -t -i -v $(pwd):/data qiime2/core:2018.6 bash $ # you are now inside the container ``` All of this and much more can be found in the [`docker run` docs](https://docs.docker.com/engine/reference/run/), in case you want to see more! Now with that said, maybe I misunderstood your question, or you are just generally curious - the `Dockerfile` for this image can be [found here](https://github.com/qiime2/vm-playbooks/blob/master/docker/Dockerfile), one of the great things about docker is that you can layer your own functionality on to our image using your own Dockerfile, no need to let us get in your way! Anyway, have fun and keep us posted! :qiime2: ---
**Author:** ![thermokarst](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/t/8e7dd6/32.png) [@thermokarst](https://forum.qiime2.org/u/thermokarst)\ **Post date:** [July 19, 2018, 12:45pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/8 "2018-07-19T12:45:47Z")
---
**Author:** ![Matt\_Kizaric1](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/m/e5b9ba/32.png) [@Matt\_Kizaric1](https://forum.qiime2.org/u/Matt_Kizaric1)\ **Post date:** [July 21, 2018, 2:31am UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/9 "2018-07-21T02:31:42Z")
Sorry I should have been more carefully on my wording, I meant the container stops and closes the environment without running any commands unless you give it a shell script to execute. ![qiime-no-container](https://forum-qiime2-org.s3.dualstack.us-west-2.amazonaws.com/original/2X/3/3b066884ecb7c95f8e40a1be4082526e1b83f249.PNG) I guess the -i option in docker does help this, but if you want other services to run on top of it (database managers, job status updates, automatic file transfer, ect.) there isn't a great way to hook into the docker image unless you are constantly starting and stopping the container. This might be a bit outside of qiime2's scope, but I think making something that has a simple non-cli interface for the docker image(Http, process interrupt, event, ect.) could really bring qiime to another level. ---
**Author:** ![thermokarst](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/t/8e7dd6/32.png) [@thermokarst](https://forum.qiime2.org/u/thermokarst)\ **Post date:** [July 21, 2018, 4:30am UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/10 "2018-07-21T04:30:40Z")
It sounds like the `docker run` behavior you are looking for is called ["detached mode"](https://docs.docker.com/engine/reference/run) (specified with the `-d` flag): ```bash $ docker run -dti qiime2/core bash $ docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 58919f3f68c4 qiime2/core "/usr/bin/tini -- ba…" 2 minutes ago Up 2 minutes frosty_bell $ docker exec -ti frosty_bell qiime info System versions Python version: 3.5.5 QIIME 2 release: 2018.6 QIIME 2 version: 2018.6.0 q2cli version: 2018.6.0 Installed plugins alignment: 2018.6.0 composition: 2018.6.0 cutadapt: 2018.6.0 dada2: 2018.6.0 deblur: 2018.6.0 demux: 2018.6.0 diversity: 2018.6.0 emperor: 2018.6.0 feature-classifier: 2018.6.0 feature-table: 2018.6.0 gneiss: 2018.6.0 longitudinal: 2018.6.0 metadata: 2018.6.0 phylogeny: 2018.6.0 quality-control: 2018.6.1 quality-filter: 2018.6.0 sample-classifier: 2018.6.0 taxa: 2018.6.0 types: 2018.6.0 vsearch: 2018.6.0 Application config directory /root/.config/q2cli Getting help To get help with QIIME 2, visit https://qiime2.org $ docker exec -ti frosty_bell qiime demux summarize --help Usage: qiime demux summarize [OPTIONS] Summarize counts per sample for all samples, and generate interactive positional quality plots based on `n` randomly selected sequences. Options: --i-data ARTIFACT PATH SampleData[JoinedSequencesWithQuality | PairedEndSequencesWithQuality | SequencesWithQuality] ... ... ``` Hope that helps! :qiime2: ---
**Author:** ![Matt\_Kizaric1](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/m/e5b9ba/32.png) [@Matt\_Kizaric1](https://forum.qiime2.org/u/Matt_Kizaric1)\ **Post date:** [July 21, 2018, 7:05pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/11 "2018-07-21T19:05:49Z")
Oh, that does make sense. It's not super applicable to my project, however this is going to save me a lot of time debugging. Thank you for your help! 🙂 ---
**Author:** ![thermokarst](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/t/8e7dd6/32.png) [@thermokarst](https://forum.qiime2.org/u/thermokarst)\ **Post date:** [July 21, 2018, 7:09pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/12 "2018-07-21T19:09:22Z")
---
**Author:** ![thermokarst](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/t/8e7dd6/32.png) [@thermokarst](https://forum.qiime2.org/u/thermokarst)\ **Post date:** [July 23, 2018, 3:21pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/13 "2018-07-23T15:21:51Z")
> [@Matt\_Kizaric1](#): > > I decided to do this a bit differently and do a REST API to send commands Depending on what you're after here, REST might be an awkward model for this --- [RPC](https://en.wikipedia.org/wiki/Remote_procedure_call) might be a better fit (or even just a generic HTTP API). We have a bit of a prototype HTTP API backing [q2studio](https://github.com/qiime2/q2studio) --- you might want to take a quick spin through there to see if there is anything you can use. Keep us in the loop, we would love to know more about your project! 🦖 :qiime2: ---
**Author:** ![thermokarst](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/t/8e7dd6/32.png) [@thermokarst](https://forum.qiime2.org/u/thermokarst)\ **Post date:** [July 23, 2018, 3:21pm UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/14 "2018-07-23T15:21:53Z")
---
**Author:** ![Matt\_Kizaric1](https://forum.qiime2.org/letter_avatar_proxy/v4/letter/m/e5b9ba/32.png) [@Matt\_Kizaric1](https://forum.qiime2.org/u/Matt_Kizaric1)\ **Post date:** [July 24, 2018, 3:43am UTC](https://forum.qiime2.org/t/artifact-api-requirements/5038/15 "2018-07-24T03:43:40Z")
Yeah I'll check through the code for studio, that might help a bit for my project actually. I'd have to do more research into how RPC interacts with docker containers since I plan to run a few other services for data management that I don't want to be qiime specific. When I say REST I really mean a simple and standardized HTTP api, I don't plan it to be too extensive but i'd like a structured way to get various qiime jobs I'm running as well as PUTing and POSTing the commands/info for data analysis. Thanks again for the help, unfortunately this is for a private company so I cannot give too many details on the project, but I might have a demo post in the future when I'm done. It's in its early stages so don't expect anything too soon.