Skip to content

Commit 7d07782

Browse files
jmchiltonjmchilton
committed
Initial commit.
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.
0 parents  commit 7d07782

134 files changed

Lines changed: 9636 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.editorconfig‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
indent_style = space
7+
indent_size = 4
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
charset = utf-8
11+
end_of_line = lf
12+
13+
[*.bat]
14+
indent_style = tab
15+
end_of_line = crlf
16+
17+
[LICENSE]
18+
insert_final_newline = false
19+
20+
[Makefile]
21+
indent_style = tab

‎.gitignore‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
*.py[cod]
2+
3+
# C extensions
4+
*.so
5+
6+
# Packages
7+
*.egg
8+
*.egg-info
9+
dist
10+
build
11+
eggs
12+
parts
13+
bin
14+
var
15+
sdist
16+
develop-eggs
17+
.installed.cfg
18+
lib
19+
lib64
20+
21+
# Installer logs
22+
pip-log.txt
23+
24+
# Unit test / coverage reports
25+
.coverage
26+
.tox
27+
nosetests.xml
28+
htmlcov
29+
30+
# Translations
31+
*.mo
32+
33+
# Mr Developer
34+
.mr.developer.cfg
35+
.project
36+
.pydevproject
37+
38+
# Complexity
39+
output/*.html
40+
output/*/index.html
41+
42+
# Sphinx
43+
docs/_build
44+
45+
.venv

‎.travis.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Config file for automatic testing at travis-ci.org
2+
3+
language: python
4+
5+
python:
6+
- "3.4"
7+
- "2.7"
8+
- "2.6"
9+
- "pypy"
10+
11+
install:
12+
- if [[ $TRAVIS_PYTHON_VERSION == 2.6 ]]; then pip install unittest2; fi
13+
- pip install -r requirements.txt
14+
- pip install pyflakes flake8
15+
16+
# command to run tests, e.g. python setup.py test
17+
script: make lint && make test

‎CONTRIBUTING.rst‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
============
2+
Contributing
3+
============
4+
5+
Contributions are welcome, and they are greatly appreciated! Every
6+
little bit helps, and credit will always be given.
7+
8+
You can contribute in many ways:
9+
10+
Types of Contributions
11+
----------------------
12+
13+
Report Bugs
14+
~~~~~~~~~~~
15+
16+
Report bugs at https://github.com/jmchilton/planemo/issues.
17+
18+
If you are reporting a bug, please include:
19+
20+
* Your operating system name and version, versions of other relevant software
21+
such as Galaxy or Docker.
22+
* Links to relevant tools.
23+
* Any details about your local setup that might be helpful in troubleshooting.
24+
* Detailed steps to reproduce the bug.
25+
26+
Fix Bugs
27+
~~~~~~~~
28+
29+
Look through the GitHub issues for bugs. Anything tagged with "bug"
30+
is open to whoever wants to implement it.
31+
32+
Implement Features
33+
~~~~~~~~~~~~~~~~~~
34+
35+
Look through the GitHub issues for features. Anything tagged with "feature"
36+
is open to whoever wants to implement it.
37+
38+
Write Documentation
39+
~~~~~~~~~~~~~~~~~~~
40+
41+
Planemo could always use more documentation, whether as part of the
42+
official Planemo docs, in docstrings, or even on the web in blog posts,
43+
articles, and such.
44+
45+
Submit Feedback
46+
~~~~~~~~~~~~~~~
47+
48+
The best way to send feedback is to file an issue at https://github.com/jmchilton/planemo/issues.
49+
50+
If you are proposing a feature:
51+
52+
* Explain in detail how it would work.
53+
* Keep the scope as narrow as possible, to make it easier to implement.
54+
* This will hopefully become a community-driven project and contributions
55+
are welcome :)
56+
57+
Get Started!
58+
------------
59+
60+
Ready to contribute? Here's how to set up `planemo` for local development.
61+
62+
1. Fork the `planemo` repo on GitHub.
63+
2. Clone your fork locally::
64+
65+
$ git clone git@github.com:your_name_here/planemo.git
66+
67+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
68+
69+
$ mkvirtualenv planemo
70+
$ cd planemo/
71+
$ python setup.py develop
72+
73+
4. Create a branch for local development::
74+
75+
$ git checkout -b name-of-your-bugfix-or-feature
76+
77+
Now you can make your changes locally.
78+
79+
5. When you're done making changes, check that your changes pass ``flake8``
80+
and the tests::
81+
82+
$ flake8 planemo tests
83+
$ python setup.py test
84+
85+
To get ``flake8``, just ``pip install`` them into your virtualenv.
86+
87+
.. including testing other Python versions with tox
88+
.. $ python setup.py test
89+
.. $ tox
90+
..
91+
.. To get flake8 and tox, just pip install them into your virtualenv.
92+
93+
6. Commit your changes and push your branch to GitHub::
94+
95+
$ git add .
96+
$ git commit -m "Your detailed description of your changes."
97+
$ git push origin name-of-your-bugfix-or-feature
98+
99+
7. Submit a pull request through the GitHub website.
100+
101+
Pull Request Guidelines
102+
-----------------------
103+
104+
Before you submit a pull request, check that it meets these guidelines:
105+
106+
1. If the pull request adds functionality, the docs should be updated. Put
107+
your new functionality into a function with a docstring.
108+
2. The pull request should work for Python 2.6, 2.7, and 3.4. Check
109+
https://travis-ci.org/jmchilton/planemo/pull_requests
110+
and make sure that the tests pass for all supported Python versions.
111+
112+
.. Tips
113+
.. ----
114+
.. To run a subset of tests::
115+
.. $ python -m unittest tests.test_planemo

‎HISTORY.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. :changelog:
2+
3+
History
4+
-------
5+
6+
---------------------
7+
0.0.1 (2014-10-04)
8+
---------------------
9+
10+
* Initial work on the project - commands for testing, linting, serving Galaxy
11+
tools - and more experimental features involving Docker and Homebrew.

0 commit comments

Comments
 (0)
⚡