Contributing

Contributions and issues are most welcome! All issues and pull requests are handled through github on the ambitioninc repository. Please check for any existing issues before filing a new one!

Running the tests

To get the source source code and run the unit tests, run:

$ git clone git://github.com/ambitioninc/newrelic-api.git
$ cd newrelic-api
$ virtualenv env
$ . env/bin/activate
$ pip install nose
$ python setup.py install
$ python setup.py nosetests

While 100% code coverage does not make a library bug-free, it significantly reduces the number of easily caught bugs! Please make sure coverage is at 100% before submitting a pull request!

Code Quality

For code quality, please run flake8:

$ pip install flake8
$ flake8 .

Code Styling

Please arrange imports with the following style:

# Standard library imports
import os

# Third party package imports
from mock import patch

# Local package imports
from newrelic_api.base import Resource

Please follow Google’s python style guide wherever possible.

Building the docs

When in the project directory:

$ pip install -r requirements/docs.txt
$ python setup.py build_sphinx
$ open docs/_build/html/index.html

Release Checklist

Before a new release, please go through the following checklist:

• Add a release note in docs/release_notes.rst

• Bump version in newrelic_api/version.py

• Git tag the version

• Upload to pypi:

  python setup.py sdist bdist_wheel upload
  

Vulnerability Reporting

For any security issues, please do NOT file an issue or pull request on github! Please contact security@ambition.com with the GPG key provided on Ambition’s website.