Overview

pyprecag

A suite of tools for Precision Agriculture data analysis

• Homepage: https://github.com/CSIRO-Precision-Agriculture/pyprecag
• Documentation: https://CSIRO-Precision-Agriculture.github.io/pyprecag_docs
• Installation
• Version: 0.3.0
• License: CSIRO Open Source Software License Agreement

pyprecag is currently supported only on Python version 2.7

Dependencies

• Python version 2.7
• GDAL
• Fiona
• Rasterio
• VESPER (for Kriging)

Development

There is a makefile in the project root with targets for the most common development operations such as lint checks, running unit tests, building the documentation, and building installer packages. tox does not have a target, as make tox is more typing than tox.

Run make with no target to see the list of targets:

$ make

Bumpversion is used to manage the package version numbers. This ensures that the version number is correctly incremented in all required files. Please see the bumpversion documentation for usage instructions, and do not edit the version strings directly.

Version numbers follow the Semantic versioning guidelines.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• The pyprecag package version.
• Detailed steps to reproduce the bug.

Documentation improvements

pyprecag could always use more documentation, whether as part of the official pyprecag docs, in docstrings, or even on the web in blog posts, articles, and such.

Note

This project uses Google-style docstrings. Contributed code should follow the same conventions. For examples, please see the Napoleon examples, or the Google Python Style Guide.

Feature requests and feedback

The best way to send feedback is to file an issue

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

Or, implement the feature yourself and submit a pull request.

Development

To set up pyprecag for local development:

1. Fork the pyprecag repo on GitHub.

2. Clone your fork locally:

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

3. Create a branch for local development:

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

   Now you can make your changes locally.

4. When you’re done making changes, run all the tests, doc builder and pylint checks using the project makefile:

   make clean lint test docs
   

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

6. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

1. Include passing tests (run make test).
2. Update documentation when there’s new API, functionality etc.
3. Add a note to CHANGELOG.rst about the changes.
4. Add yourself to AUTHORS.rst.