Skip to content

About

Project

momapy is a Python library for working with molecular maps. It supports SBGN PD and AF maps and CellDesigner maps, providing a unified API for reading, writing, inspecting, styling, and rendering them.

The project is developed at the University of Luxembourg.

Authors

Contributing

Bug reports and feature requests are welcome via the GitHub issue tracker.

To contribute code:

  1. Fork the repository on GitHub.
  2. Create a feature branch.
  3. Make your changes, following the coding conventions in CLAUDE.md.
  4. Run the test suite: pytest tests/
  5. Open a pull request against main.

All commits must follow Conventional Commits (enforced via commitlint). See CLAUDE.md for the list of valid types and examples.

Versioning and deprecation policy

momapy loosely follows semantic versioning as a guideline, not a strict contract.

Below 1.0 the public API is not stable and may change in a breaking way in any release.

From 1.0 onward, breaking changes are introduced gradually where practical: a deprecated API keeps working and emits a DeprecationWarning for at least one release before removal, naming a replacement when one exists.

The public API is what the documentation and each subpackage's __all__ describe. Underscore-prefixed names are not public and may change at any time.

License

This code is distributed under the GPLv3 license.