-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
48 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -60,32 +60,48 @@ If you are proposing a feature: | |
Get Started! | ||
------------ | ||
|
||
Ready to contribute? Here's how to set up `pyrvt` for local development. | ||
Ready to contribute? Here's how to set up `pyRVT` for local development. | ||
|
||
1. Fork the `pyrvt` repo on GitHub. | ||
1. Fork the `pyRVT` repo on GitHub. | ||
2. Clone your fork locally:: | ||
|
||
$ git clone [email protected]:your_name_here/pyrvt.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:: | ||
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 pyrvt | ||
$ cd pyrvt/ | ||
$ pip install -r requirements_dev.txt | ||
$ python setup.py develop | ||
|
||
Note that it is easier to install `matplotlib`, `numpy` and `scipy` | ||
dependencies via your package manager. | ||
|
||
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, including testing other Python versions with tox:: | ||
5. When you're done making changes, check that your changes pass flake8 and the | ||
tests, including testing other Python versions with tox:: | ||
|
||
$ flake8 pyrvt tests | ||
$ python setup.py test | ||
$ tox | ||
|
||
To get flake8 and tox, just pip install them into your virtualenv. | ||
To get flake8 and tox, just pip install them into your virtualenv. If you | ||
have make installed, you can check the format and tests with:: | ||
|
||
$ make lint | ||
$ make test | ||
$ make test-all | ||
|
||
The documentation can be built with:: | ||
$ make docs | ||
|
||
6. Commit your changes and push your branch to GitHub:: | ||
|
||
|
@@ -104,13 +120,16 @@ Before you submit a pull request, check that it meets these guidelines: | |
2. If the pull request adds functionality, the docs should be updated. Put | ||
your new functionality into a function with a docstring, and add the | ||
feature to the list in README.rst. | ||
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check | ||
https://travis-ci.org/arkottke/pyrvt/pull_requests | ||
and make sure that the tests pass for all supported Python versions. | ||
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for | ||
PyPy. Check https://travis-ci.org/arkottke/pyrvt/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_pyrvt | ||
$ py.test tests | ||
|
||
Or if make is installed:: | ||
$ make tests |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
===== | ||
pyRVT | ||
pyrvt | ||
===== | ||
|
||
.. image:: https://img.shields.io/pypi/v/pyrvt.svg | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,23 +33,20 @@ | |
] | ||
|
||
setup( | ||
name='pyrvt', | ||
version='0.5.1', | ||
name='pyRVT', | ||
version='0.5.5', | ||
description='Ground motion models implemented in Python.', | ||
long_description=readme + '\n\n' + history, | ||
author='Albert Kottke', | ||
author_email='[email protected]', | ||
url='http://github.com/arkottke/pyrvt', | ||
packages=[ | ||
'pyrvt', | ||
], | ||
packages=['pyrvt'], | ||
entry_points={ | ||
'console_scripts': [ | ||
'rvt_operator = pyrvt.runner:main', | ||
], | ||
}, | ||
package_dir={'pyrvt': | ||
'pyrvt'}, | ||
package_dir={'pyrvt': 'pyrvt'}, | ||
include_package_data=True, | ||
install_requires=requirements, | ||
license='MIT', | ||
|