Skip to content

Commit

Permalink
Initial commit.
Browse files Browse the repository at this point in the history
Planemo is a set of command-line utilities to assist in developing tools for the Galaxy project (http://galaxyproject.org/).

View the documentation at http://planemo.readthedocs.org/en/latest/ and in particular the quick start guide at http://planemo.readthedocs.org/en/latest/readme.html#quick-start.

Still a couple critical bugs before 0.1.0 - see TODO.rst for details.
  • Loading branch information
jmchilton committed Oct 5, 2014
0 parents commit 7d07782
Show file tree
Hide file tree
Showing 134 changed files with 9,636 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# http://editorconfig.org

root = true

[*]
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true
charset = utf-8
end_of_line = lf

[*.bat]
indent_style = tab
end_of_line = crlf

[LICENSE]
insert_final_newline = false

[Makefile]
indent_style = tab
45 changes: 45 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
*.py[cod]

# C extensions
*.so

# Packages
*.egg
*.egg-info
dist
build
eggs
parts
bin
var
sdist
develop-eggs
.installed.cfg
lib
lib64

# Installer logs
pip-log.txt

# Unit test / coverage reports
.coverage
.tox
nosetests.xml
htmlcov

# Translations
*.mo

# Mr Developer
.mr.developer.cfg
.project
.pydevproject

# Complexity
output/*.html
output/*/index.html

# Sphinx
docs/_build

.venv
17 changes: 17 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Config file for automatic testing at travis-ci.org

language: python

python:
- "3.4"
- "2.7"
- "2.6"
- "pypy"

install:
- if [[ $TRAVIS_PYTHON_VERSION == 2.6 ]]; then pip install unittest2; fi
- pip install -r requirements.txt
- pip install pyflakes flake8

# command to run tests, e.g. python setup.py test
script: make lint && make test
115 changes: 115 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
============
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
----------------------

Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/jmchilton/planemo/issues.

If you are reporting a bug, please include:

* Your operating system name and version, versions of other relevant software
such as Galaxy or Docker.
* Links to relevant tools.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug"
is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~

Look through the GitHub issues for features. Anything tagged with "feature"
is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~

Planemo could always use more documentation, whether as part of the
official Planemo docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/jmchilton/planemo/issues.

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* This will hopefully become a community-driven project and contributions
are welcome :)

Get Started!
------------

Ready to contribute? Here's how to set up `planemo` for local development.

1. Fork the `planemo` repo on GitHub.
2. Clone your fork locally::

$ git clone git@github.com:your_name_here/planemo.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

$ mkvirtualenv planemo
$ cd planemo/
$ python setup.py develop

4. Create a branch for local development::

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

5. When you're done making changes, check that your changes pass ``flake8``
and the tests::

$ flake8 planemo tests
$ python setup.py test

To get ``flake8``, just ``pip install`` them into your virtualenv.

.. including testing other Python versions with tox
.. $ python setup.py test
.. $ tox
..
.. To get flake8 and tox, just pip install them into your virtualenv.
6. Commit your changes and push your branch to GitHub::

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

7. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------

Before you submit a pull request, check that it meets these guidelines:

1. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring.
2. The pull request should work for Python 2.6, 2.7, and 3.4. Check
https://travis-ci.org/jmchilton/planemo/pull_requests
and make sure that the tests pass for all supported Python versions.

.. Tips
.. ----
.. To run a subset of tests::
.. $ python -m unittest tests.test_planemo
11 changes: 11 additions & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. :changelog:
History
-------

---------------------
0.0.1 (2014-10-04)
---------------------

* Initial work on the project - commands for testing, linting, serving Galaxy
tools - and more experimental features involving Docker and Homebrew.
Loading

0 comments on commit 7d07782

Please sign in to comment.