Developer’s Guide

This article describes the guidelines to be followed by developers working on sunpy. If you are thinking of contributing to sunpy please read the following carefully.

We currently recommend the Newcomers’ Guide as the place to start. This goes over the basics and has links to useful tutorials on git.

• Newcomers’ Guide
  • How to Contribute to sunpy
• Coding Standards
  • Language Standard
  • Coding Style/Conventions
  • Private code
  • Utilities in sunpy
  • Formatting
  • Documentation and Testing
  • Data and Configuration
  • Standard output, warnings, and errors
  • Including C Code
• SunPy Documentation Rules
  • Overview
  • Sphinx
• Example Gallery
  • Contribution Guidelines
• Testing Guidelines
  • Dependencies for testing
  • tox
  • pytest
  • Remote data
  • Figure tests
  • Running tests in parallel
  • Coverage reports
  • Simple example
  • Where to put tests
  • Online Tests
  • Tests that create files
  • Tests that use test data
  • Figure unit tests
  • doctests
  • Bugs discovered
• Pull Requests and GitHub Teams
  • Review Process
  • Continuous Integration
  • SunPy GitHub Groups
• sunpy’s Public API
  • Deprecation Policy and Breaking Changes
• Dependency Support Policy
• Use of quantities and units
• Creating new sunpy Subclasses (Maps, TimeSeries)
  • Writing a new Instrument Map Class
  • Writing a new Instrument TimeSeries Class
• Extending Fido with New Sources of Data
  • Writing a new “scraper” client
  • Writing a “full” client
• Workflow for Maintainers
  • Integrating changes via the web interface (recommended)
  • Integrating changes manually
  • Using Milestones and Labels
  • Using Projects
  • Updating and Maintaining the Changelog
  • Releasing sunpy
• Logging, Warnings, and Exceptions
  • Overview
  • Issuing Warnings
  • Raising Exceptions
• Remote Data Manager
  • Usage
  • Usage
  • Testing
• Global Settings
• Submodule and funding
  • Database