Skip to main content

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


Download files

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

Source Distribution

cumulus-message-adapter-1.0.3.tar.gz (8.0 kB view details)

Uploaded Source

File details

Details for the file cumulus-message-adapter-1.0.3.tar.gz.

File metadata

File hashes

Hashes for cumulus-message-adapter-1.0.3.tar.gz
Algorithm Hash digest
SHA256 7e0afead8d8dbb37e4d4ebad36edad7020383ed9d55f3f61610fc7e3dac61f6a
MD5 ac1888c9f8e52c6c0c89d696d7546b84
BLAKE2b-256 d6ff5ad8f81acb5839652628035a5cd1cb75bd1b489c276bcdeb2736ece7b800

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page