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

Replace rake functions with python paver functions #2146

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,6 @@ Bertrand Marron <bertrand.marron@ionis-group.com>
Yihua Lou <supermouselyh@hotmail.com>
Andy Armstrong <andya@edx.org>
Matt Drayer <mattdrayer@edx.org>
David Glance <david.glance@gmail.com>


12 changes: 6 additions & 6 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ new pep8 or pylint errors (and ideally, should fix up other errors you
encounter in the files you edit). From the edx-platform main directory, you can
run the command::

$ rake quality
$ paver run_quality

to print the "Diff Quality" report, a report of the quality violations your
branch has made.
Expand Down Expand Up @@ -90,13 +90,13 @@ list *before* you start coding.

Running the command ::

$ rake test
$ paver test

in the edx-platform directory will run all the unit tests on edx-platform (to
run specific tests, refer to the testing documentation). Once you've run this
command, you can run ::

$ rake coverage
$ paver coverage

to generate the "Diff Coverage" report. This report tells you how much of the
Python and JavaScript code you've changed is covered by unit tests. We aim for
Expand All @@ -117,12 +117,12 @@ When you open a pull request (PR), please follow these guidelines:

* As far as code goes, a first pass is to make sure that your code is of high
quality. This means ensuring plenty of comments, as well as a 100% pass rate
when you run ``rake quality`` locally. See the section **Code Quality
when you run ``paver run_quality`` locally. See the section **Code Quality
Guidelines**.

* Testing coverage should be as complete as possible. 95% or greater on
JavaScript and Python coverage (you can check this by running ``rake test;
rake coverage`` locally). Percentage coverage is only calculated from unit
JavaScript and Python coverage (you can check this by running ``paver test;
paver coverage`` locally). Percentage coverage is only calculated from unit
tests, however. If you're adding new visual features, we love seeing
acceptance tests as applicable. See the section **Testing Coverage
Guidelines**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@


#
# To run from command line: rake cms:delete_course LOC=edX/111/Foo1
# To run from command line: paver delete_course --env=<settings> --location=edX/111/Foo1
#
class Command(BaseCommand):
help = '''Delete a MongoDB backed course'''
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
#
# Run it this way:
# ./manage.py cms --settings dev edit_course_tabs --course Stanford/CS99/2013_spring
# Or via rake:
# rake django-admin[edit_course_tabs,cms,dev,"--course Stanford/CS99/2013_spring --delete 4"]
# Or via paver:
# paver django_admin --system=cms --settings=dev --action=edit_course_tabs --options="--course Stanford/CS99/2013_spring"
#
from optparse import make_option
from django.core.management.base import BaseCommand, CommandError
Expand Down
2 changes: 1 addition & 1 deletion cms/djangoapps/contentstore/management/commands/xlint.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
Verify the structure of courseware as to it's suitability for import
To run test: rake cms:xlint DATA_DIR=../data [COURSE_DIR=content-edx-101 (optional parameter)]
To run test: paver xlint_course --data_dir=../data --course_dir=content-edx-101
"""
from django.core.management.base import BaseCommand, CommandError
from xmodule.modulestore.xml_importer import perform_xlint
Expand Down
2 changes: 1 addition & 1 deletion cms/envs/acceptance.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ def seed():
}
}

# Set this up so that rake lms[acceptance] and running the
# Set this up so that paver acceptance and running the
# harvest command both use the same (test) database
# which they can flush without messing up your dev db
DATABASES = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Preprocess templatized asset files, enabling asset authors to use
Python/Django inside of Sass and CoffeeScript. This preprocessing
will happen before the invocation of the asset compiler (currently
handled by the asset Rakefile).
handled by the assets paver file).

For this to work, assets need to be named with the appropriate
template extension (e.g., .mako for Mako templates). Currently Mako
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
class Command(BaseCommand):
"""Add our handler to the space where django-admin looks up commands."""

# TODO: revisit now that rake has been deprecated
# It appears that with the way Rake invokes these commands, we can't
# have more than one arg passed through...annoying.
args = ("course_id", )
Expand Down
2 changes: 1 addition & 1 deletion common/lib/xmodule/xmodule/tests/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Run like this:

rake test_common/lib/xmodule
paver test_lib --lib=common/lib/xmodule

"""

Expand Down
1 change: 1 addition & 0 deletions docs/developers/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
sys.path.append(os.path.join(root, "lms/lib"))
sys.path.append(os.path.join(root, "cms/djangoapps"))
sys.path.append(os.path.join(root, "cms/lib"))
sys.path.append(os.path.join(root, "pavelib"))
sys.path.insert(0, os.path.abspath(os.path.normpath(os.path.dirname(__file__)
+ '/../../')))
sys.path.append('.')
Expand Down
1 change: 1 addition & 0 deletions docs/developers/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Contents:
overview.rst
common-lib.rst
djangoapps.rst
pavelib.rst

Indices and tables
==================
Expand Down
Loading