Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

A command-line interface for preparing and outputting Cumulus Messages for Cumulus Tasks

Project description

# Cumulus Message Adapter

[![CircleCI](https://circleci.com/gh/cumulus-nasa/cumulus-message-adapter.svg?style=svg)](https://circleci.com/gh/cumulus-nasa/cumulus-message-adapter)

cumulus-message-adapter is a command-line interface for preparing and outputting Cumulus Messages for Cumulus Tasks. cumulus-message-adapter helps Cumulus developers integrate a task into a Cumulus Workflow.

Read more about how the cumulus-message-adapter works in the [CONTRACT.md](./CONTRACT.md).

## Releases

[CircleCI](https://circleci.com/gh/cumulus-nasa/cumulus-message-adapter) manages releases and release assets.

Whenever CircleCI passes on the master branch of cumulus-message-adapter and message_adapter/version.py has been updated with a version that doesn’t match an existing tag, CircleCI will:

  • Create a new tag with tag_name of the string in message_adapter/version.py
  • Create a new release using the new tag, with a name equal to tag_name (equal to version).
  • Build a cumulus-message-adapter.zip file and attach it as a release asset to the newly created release. The zip file is created using the [Makefile](./Makefile) in the root of this repository.

These steps are fully detailed in the [.circleci/config.yml](./.circleci/config.yml) file.

## Development

### Dependency Installation

$ pip install -r requirements-dev.txt $ pip install -r requirements.txt

### Running Tests

Running tests requires [localstack](https://github.com/localstack/localstack).

Tests only require localstack running S3, which can be initiated with the following command:

` $ SERVICES=s3 localstack start `

And then you can check tests pass with the following nosetests command:

` $ CUMULUS_ENV=testing nosetests -v -s `

### Linting

$ pylint message_adapter

### Contributing

If changes are made to the codebase, you can create the cumulus-message-adapter zip archive for testing libraries that require it:

`bash $ make clean $ make cumulus-message-adapter.zip `

Then you can run some integration tests:

`bash ./examples/example-node-message-adapter-lib.js `

### Troubleshooting

  • Error: “DistutilsOptionError: must supply either home or prefix/exec-prefix — not both” when running make cumulus-message-adapter.zip * [Solution](https://stackoverflow.com/a/24357384)

Project details


Release history Release notifications

This version
History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

History Node

1.0.0a1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
cumulus-message-adapter-1.0.4.tar.gz (8.7 kB) Copy SHA256 hash SHA256 Source None Mar 21, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page