Skip to content
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

Add functionality and documentation for building Conda pacakges. #643

Merged
merged 1 commit into from Feb 27, 2017

Conversation

jmchilton
Copy link
Member

@jmchilton jmchilton commented Feb 24, 2017

  • Add documentation that links out to external sources for building Conda recipes - recommending specific docs and a specific order.
  • Allow Planemo to work with locally built Conda packages using the --conda_use_local command.
  • Add an exercise to the documentation that requires building a package and the use of --conda_use_local. This uses a new project template that adds a tool targeting the package https://github.com/jmchilton/fleeqtk I forked from seqtk for this purpose.
  • Update galaxy-lib dependency for the required library functionality to use --conda_use_local.
  • Add test case that follows the example in the documentation targeting the fleeqtk package. It builds a fleeqk recipe, uses conda_install --conda_use_local on a tool that requires it, and finally runs planemo test to ensure that Galaxy properly uses the resulting package.

Fixes #620

Copy link
Member

@bgruening bgruening left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff John - as usual!

@@ -0,0 +1,102 @@
<tool id="fleeqtk_seq" name="Convert to FASTA (fleeqtk)" version="0.1.0">
<stdio>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we get rid of stdio here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah - but this was based on the seqtk tutorial and tool_init. I have created an issue for this here #644. I'll get to this before say the GCC I think - but I want to do every variant of seqtk in the code base at once after that issue is addressed.

<command><![CDATA[
fleeqtk seq
#if $settings.advanced == "advanced"
$settings.shift_quality
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to see here indentations to make it more readable

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah - good plan. I think I want to update the seqtk tools at the same time. I created an issue #645.

- `Contributing a recipe <https://bioconda.github.io/contribute-a-recipe.html>`__ (through "Write a Recipe")
- `Building Conda Package <https://conda.io/docs/building/bpp.html#>`__ in particular

- `Building conda packages with conda skeleton <https://conda.io/docs/build_tutorials/pkgs.html>`__
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe highlight with a single sentence that skeletons are the usual way to create templates for scripting languages ... so that people don't start to write this by hand?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool - I will rebase this with that advice - thanks!

- Add documentation that links out to external sources for building Conda recipes - recommending specific docs and a specific order.
- Allow Planemo to work with locally built Conda packages using the ``--conda_use_local`` command.
- Add an exercise to the documentation that requires building a package and the use of ``--conda_use_local``. This uses a new project template that adds a tool targeting the package https://github.com/jmchilton/fleeqtk I forked from seqtk for this purpose.
- Update galaxy-lib dependency for the required library functionality to use ``--conda_use_local``.
- Add test case that follows the example in the documentation targeting the fleeqtk package. It builds a fleetqk recipe, uses conda_install --conda_use_local on a tool that requires it, and finally runs planemo test to ensure that Galaxy properly uses the resulting package.
@bgruening bgruening merged commit 96782cd into galaxyproject:master Feb 27, 2017
@bgruening
Copy link
Member

Thanks John!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants