Software Process

Continuous Integration

PyNWB is tested against Ubuntu, macOS and Windows operating systems. The project has both unit and integration tests.

  • CircleCI runs all PyNWB tests on Ubuntu
  • Appveyor runs all PyNWB tests on Windows
  • Travis runs all PyNWB tests on macOS

Each time a PR is published or updated, the project is built, packaged and tested on all support operating systems and python distributions. That way, as a contributor you know if you introduced regressions or coding style inconsistencies.

There are badges in the README file which shows the current condition of the dev branch.

Coverage

Coverage is computed and reported using the coverage tool. There is a badge in the README file which shows percentage coverage. A detailed report can be found on codecov which shows line by line which lines are covered by the tests.

Requirement Specifications

There are 2 kinds of requirements specification in PyNWB.

Setup.py Dependencies

The first one is the dependencies in the setup.py file which lists the abstract dependencies for the PyNWB project. Note that there should not be specific versions of packages in the setup.py file.

Requirements.txt Dependencies

The second one is requirements.txt which contain a list of pinned (concrete) dependencies to reproduce an entire development environment to work with PyNWB.

In order to check the status of the required packages requires.io is used to create a badge on the project README. If all the required packages are up to date, a green badge appears.

If some of the packages are outdated, see How to Update Requirements Files.

Versioning and Releasing

PyNWB uses versioneer for versioning source and wheel distributions. Versioneer creates a semi-unique release name for the wheels that are created. It requires a version control system (git in PyNWB’s case) to generate a release name. After all the tests pass, circleci creates both wheels(.whl) and source distribution(.tgz) for both Python 2 and Python 3 and uploads them back to github as a release. Versioneer makes it possible to get the source distribution from github and create wheels directly without having to use a version control system because it hardcodes versions in the source distribution.