A command-line interface for preparing and outputting Cumulus Messages for Cumulus Tasks
Project description
# 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 `
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file cumulus-message-adapter-1.0.0.tar.gz.
File metadata
- Download URL: cumulus-message-adapter-1.0.0.tar.gz
- Upload date:
- Size: 7.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cd35412e239d2bd162a6f5bfe040449bd272fc91b231c3aee55fc2ea8fe5300f |
|
| MD5 | f65546e3a37987c189d78eaafefa3c07 |
|
| BLAKE2b-256 | e419f0e667dfdbcba0e05509f5592ad6d6c0593b7ec6bb712bfccec762d629b0 |
](https://circleci.com/gh/cumulus-nasa/cumulus-message-adapter){kind=link}