Skip to content
This repository has been archived by the owner on Aug 19, 2020. It is now read-only.

adding genome related api code #12

Merged
merged 3 commits into from
Jul 29, 2015
Merged

Conversation

mlhenderson
Copy link
Contributor

Some prototype code for an API library that works on genome annotations, assemblies, taxons.
This code works against two different type varieties, the current Genome object types and a new set that we want to validate, both of which will be abstracted behind these API methods so that developers can code against the API and not need to have deep knowledge of how the type information is structured or embed that knowledge in various pieces of our codebase.

There is a top level README.md that has instructions for getting the code installed. Since this is a prototype, many things are subject to change in the design.

@dangunter
Copy link
Contributor

Can we get some tests running in TravisCI?

@mlhenderson
Copy link
Contributor Author

At the moment all the tests rely on having a kbase auth token. There are
tests of course, but they are not yet connected to travis and if you were
to try to run them now they would fail.

On Tue, Jul 28, 2015 at 12:42 PM, Dan Gunter notifications@github.com
wrote:

Can we get some tests running in TravisCI?


Reply to this email directly or view it on GitHub
#12 (comment).

@dangunter
Copy link
Contributor

OK. I would say getting some tests should be high priority. We should do mocks or local MongoDB (TravisCI has one) to get it running. But we need to get going, so I'll look at code now.

@dangunter
Copy link
Contributor

So, the code looks close enough. I don't know if any of it works, but since Matt claims it does I'll take his word for it. The style of comments is not exactly correct (see Google Python Style, which is what this is imitating, I believe) and this may make generating docs a pain even with the napoleon Sphinx plugin.

@mlhenderson
Copy link
Contributor Author

You can actually verify that at least basic tests work without too much
effort, just not using TravisCI.

On Tue, Jul 28, 2015 at 1:35 PM, Dan Gunter notifications@github.com
wrote:

So, the code looks close enough. I don't know if any of it works, but
since Matt claims it does I'll take his word for it. The style of comments
is not exactly correct (see Google Python Style, which is what this is
imitating, I believe) and this may make generating docs a pain even with
the napoleon Sphinx plugin.


Reply to this email directly or view it on GitHub
#12 (comment).

@mlhenderson
Copy link
Contributor Author

Yes, it is pseudo Google docstring style. We can change that, I don't have
a strong preference.

On Tue, Jul 28, 2015 at 1:35 PM, Dan Gunter notifications@github.com
wrote:

So, the code looks close enough. I don't know if any of it works, but
since Matt claims it does I'll take his word for it. The style of comments
is not exactly correct (see Google Python Style, which is what this is
imitating, I believe) and this may make generating docs a pain even with
the napoleon Sphinx plugin.


Reply to this email directly or view it on GitHub
#12 (comment).

@dangunter
Copy link
Contributor

I think you need better module level documentation

In [3]: assembly?
Type: module
String form: <module 'biokbase.data_api.assembly' from '/Users/dang/.virtualenvs/kbase_data_api/lib/python2.7/site-packages/genome_api-0.1-py2.7.egg/biokbase/data_api/assembly.pyc'>
File: ~/.virtualenvs/kbase_data_api/lib/python2.7/site-packages/genome_api-0.1-py2.7.egg/biokbase/data_api/assembly.py
Docstring:

it would be really helpful if each module provided an overview of the functions

dangunter added a commit that referenced this pull request Jul 29, 2015
looks good -- doc and test changes can be made later in separate PR
@dangunter dangunter merged commit 67f5187 into kbaseattic:master Jul 29, 2015
kkellerlbl added a commit that referenced this pull request Dec 1, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants