myscipkg3¶

A package for science using numpy, matplotlib, readthedocs, etc.

Features¶

TODO

Contents:¶

Installation¶

At the command line via pip:

$ pip install myscipkg3

Or install the latest GitHub version using:

$ git clone https://github.com/{ cookiecutter.github_username }}/myscipkg3.git
$ cd myscipkg3
$ python setup.py install

History¶

0.1.0 (2015-01-15)¶

First release on PyPI.

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/ryanpdwyer/myscipkg3/issues.

If you are reporting a bug, please include:

Your operating system name and version.
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¶

myscipkg3 could always use more documentation, whether as part of the official myscipkg3 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/ryanpdwyer/myscipkg3/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.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up myscipkg3 for local development.

Fork the myscipkg3 repo on GitHub.

Clone your fork locally:

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

Create a branch for local development:

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

Now you can make your changes locally.

When you’re done making changes, check that your changes pass tests by running:
```
$ python setup.py test
```

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

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

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

The pull request should include tests.
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.
The pull request should work for Python 2.7. Check https://travis-ci.org/ryanpdwyer/myscipkg3 under pull requests for active pull requests to check that all configurations pass.

Tips¶

To run a subset of tests:

$ py.test test/test_myscipkg3.py

Credits¶

Development Lead¶

Ryan Dwyer <ryanpdwyer@gmail.com>

Contributors¶

None yet. Why not be the first?

Feedback¶

If you have any suggestions or questions about myscipkg3 feel free to email me at ryanpdwyer@gmail.com.

If you encounter any errors or problems with myscipkg3, please let me know! Open an Issue at the GitHub http://github.com/ryanpdwyer/myscipkg3 main repository.