Skip to content

Commit

Permalink
Fixed naming and version number.
Browse files Browse the repository at this point in the history
  • Loading branch information
arkottke committed Jul 9, 2016
1 parent bdcc5db commit db79c25
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 33 deletions.
37 changes: 28 additions & 9 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand All @@ -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
2 changes: 1 addition & 1 deletion README.rst
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
Expand Down
23 changes: 12 additions & 11 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,33 +1,34 @@
.. _install:

============
Installation
============

Prior to using pyRVT, Python and a number of packages need to be installed. In
Prior to using `pyrvt`, Python and a number of packages need to be installed. In
addition to Python, the following packages need to be installed:

*Required:*

- numpy -- fast vector operations
- `numpy` -- fast vector operations

- scipy -- indefinite integration
- `scipy` -- indefinite integration

- nose -- required for the unit tests
- `pytest` -- required for the unit tests

*Optional:*

- matplotlib -- used for plotting
- `matplotlib` -- used for plotting

- xlrd/xlwt -- reading and writing xls files
- `xlrd`/`xlwt` -- reading and writing xls files

- openpyxl -- reading xlsx files
- `openpyxl` -- reading xlsx files

Install Python dependencies is best accomplished with a package manager. On
Windows or OS-X, I recommend using Miniconda3. On Linux, the package manager
is preferred.

Miniconda has installers for `Windows 32-bit`_, `Windows 64-bit`_, and `OS-X`_.
While pyRVT has support Python27, Python3 is preferred.
While `pyrvt` has support Python27, Python3 is preferred.

.. _Windows 32-bit: http://repo.continuum.io/miniconda/Miniconda3-latest-Windows-x86.exe
.. _Windows 64-bit: http://repo.continuum.io/miniconda/Miniconda3-latest-Windows-x86_64.exe
Expand All @@ -47,13 +48,13 @@ window, and select "Properties", and then check the "Quick Edit Mode" check box
within the "Edit Options" group. Copy the text, and then paste it by click the
right mouse button.

Now that the dependencies have been installed, install or upgrade pyRVT using
Now that the dependencies have been installed, install or upgrade `pyrvt` using
pip:

::

pip install --upgrade pyrvt

You should now have pyRVT completely installed. Next, read about
:ref:`using <usage>` pyRVT.
You should now have `pyrvt` completely installed. Next, read about
:ref:`using <usage>` `pyrvt`.

4 changes: 2 additions & 2 deletions pyrvt/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@
__author__ = 'Albert Kottke'
__copyright__ = 'Copyright 2016 Albert Kottke'
__license__ = 'MIT'
__title__ = 'pyrvt'
__version__ = get_distribution('pyrvt').version
__title__ = 'pyRVT'
__version__ = get_distribution('pyRVT').version
4 changes: 1 addition & 3 deletions requirements_dev.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
-r ./requirements.txt
-r ./requirements_rtfd.txt

coveralls
cryptography
Expand All @@ -9,8 +10,5 @@ pyprind
pytest-cov
pytest-flake8
pytest-runner
sphinx
sphinx_rtd_theme
sphinxcontrib-bibtex
watchdog
wheel
11 changes: 4 additions & 7 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit db79c25

Please sign in to comment.