Initial commit

=======

Credits

=======

Development Lead

----------------

* Jay Laura <jlaura@usgs.gov>

Contributors

------------

None yet. Why not be the first?

============

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/jlaura@usgs.gov/autocnet/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

~~~~~~~~~~~~~~~~~~~

AutoCNet could always use more documentation, whether as part of the

official AutoCNet 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/jlaura@usgs.gov/autocnet/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 `autocnet` for local development.

1. Fork the `autocnet` repo on GitHub.

2. Clone your fork locally::

    $ git clone git@github.com:your_name_here/autocnet.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::

    $ mkvirtualenv autocnet

    $ cd autocnet/

    $ python setup.py develop

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::

    $ flake8 autocnet tests

    $ python setup.py test

    $ tox

   To get flake8 and tox, just pip install them into your virtualenv.

6. 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

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

-----------------------

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

1. The pull request should include tests.

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, and 3.4, and for PyPy. Check

   https://travis-ci.org/jlaura@usgs.gov/autocnet/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_autocnet

.. :changelog:

History

-------

0.1.0 (2015-01-11)

---------------------

* First release on PyPI.

Software and related material (data and (or) documentation), contained in or furnished in connection with a software distribution, are made available by the U.S. Geological Survey (USGS) to be used in the public interest and in the advancement of science. You may, without any fee or cost, use, copy, modify, or distribute this software, and any derivative works thereof, and its supporting documentation, subject to the following restrictions and understandings.

If you distribute copies or modifications of the software and related material, make sure the recipients receive a copy of this notice and receive or can get a copy of the original distribution. If the software and (or) related material are modified and distributed, it must be made clear that the recipients do not have the original and they must be informed of the extent of the modifications. For example, modified files must include a prominent notice stating the modifications made, the author of the modifications, and the date the modifications were made. This restriction is necessary to guard against problems introduced in the software by others, reflecting negatively on the reputation of the USGS.

The software is public property and you therefore have the right to the source code, if desired.

You may charge fees for distribution, warranties, and services provided in connection with the software or derivative works thereof. The name USGS can be used in any advertising or publicity to endorse or promote any products or commercial entity using this software if specific written permission is obtained from the USGS.

The user agrees to appropriately acknowledge the authors and the USGS in publications that result from the use of this software or in products that include this software in whole or in part.

Because the software and related material are free (other than nominal materials and handling fees) and provided "as is," the authors, the USGS, and the United States Government have made no warranty, express or implied, as to accuracy or completeness and are not obligated to provide the user with any support, consulting, training or assistance of any kind with regard to the use, operation, and performance of this software nor to provide the user with any updates, revisions, new versions or "bug fixes".

The user assumes all risk for any damages whatsoever resulting from loss of use, data, or profits arising in connection with the access, use, quality, or performance of this software.

 No newline at end of file

include AUTHORS.rst

include CONTRIBUTING.rst

include HISTORY.rst

include LICENSE

include README.rst

recursive-include tests *

recursive-exclude * __pycache__

recursive-exclude * *.py[co]

recursive-include docs *.rst conf.py Makefile make.bat