Bugs and feature requests are tracked in Bugzilla.
When writing up a bug, it helps to know the version of Antenna you’re using.
All code files need to start with the MPLv2 header:
# This Source Code Form is subject to the terms of the Mozilla Public # License, v. 2.0. If a copy of the MPL was not distributed with this # file, You can obtain one at http://mozilla.org/MPL/2.0/.
PEP8 is nice. To lint your code, do:
$ make lint
If you hit issues, use
Everything runs in a Docker container. Thus Antenna requires fewer things to get started and you’re guaranteed to have the same setup as everyone else and it solves some other problems, too.
Documentation for Antenna is build with Sphinx and is available on ReadTheDocs. API is automatically extracted from docstrings in the code.
To build the docs, run this:
$ make docs
To run the tests, run this:
$ make test
Tests go in
tests/. Data required by tests goes in
If you need to run specific tests or pass in different arguments, you can run
bash in the base container and then run
py.test with whatever args you want.
$ make shell app@...$ py.test <pytest output> app@...$ py.test tests/unittest/test_crashstorage.py
We’re using py.test for a test harness and test discovery.