pycsw Home | Community | Demos | Docs | Issue Tracker | FAQ | Download

Development

Code Overview

  • the pycsw wiki documents an overview of the codebase

GitHub

  • pycsw source code and documentation are managed using GitHub
  • documentation is managed in docs/, in reStructuredText format. Sphinx is used to generate the documentation

Submitting Pull Requests

  • where possible, pull requests as part of a GitHub issue
  • if you are submitting a patch, please add the has-patch label to the ticket (so tickets with patches can be easily filtered). Also read the FAQ before submitting

GitHub Commit Access

  • proposals to provide developers with GitHub commit access shall be emailed to the pycsw-devel mailing list (see Community). Proposals shall be approved by the pycsw development team. Committers shall be added by the project admin
  • removal of commit access shall be handled in the same manner
  • each committer shall be listed in https://github.com/geopython/pycsw/blob/master/COMMITTERS.txt

GitHub Commit Guidelines

  • enhancements and bug fixes shall be identified with a GitHub issue
  • non-trivial Git commits shall be associated with a GitHub issue. As documentation can always be improved, tickets need not be opened for improving the docs
  • Git commits shall include a description of changes
  • Git commits shall include the GitHub issue number (i.e. #1234) in the Git commit log message
  • all enhancements or bug fixes must successfully pass all OGC CITE tests before they are committed
  • all enhancements or bug fixes must successfully pass all Tester tests before they are committed
  • enhancements which can be demonstrated from the pycsw Tester should be accompanied by example CSW request XML

Coding and Documentation Guidelines

  • pycsw instead of PyCSW, pyCSW, Pycsw
  • always code with PEP 8 conventions
  • always run source code through pep8 and pylint, using all pylint defaults except for C0111. sbin/pycsw-pylint.sh is included for convenience
  • for exceptions which make their way to OGC ExceptionReport XML, always specify the appropriate locator and code parameters
  • the pycsw wiki documents developer tasks for things like releasing documentation, testing, etc.

Table Of Contents

Previous topic

Cataloguing and Metadata Tools

Next topic

Support

This Page

This product conforms to the OpenGIS Catalogue Service Implementation Specification [Catalogue Service for the Web], Revision 2.0.2. OGC, OGC®, and CERTIFIED OGC COMPLIANT are trademarks or registered trademarks of the Open Geospatial Consortium, Inc. in the United States and other countries.

This product conforms to the OpenGIS Catalogue Service Implementation Specification [Catalogue Service for the Web], Revision 2.0.2. OGC, OGC®, and CERTIFIED OGC COMPLIANT are trademarks or registered trademarks of the Open Geospatial Consortium, Inc. in the United States and other countries.

OSGeo Project in Incubation