Skip to main content

Binbash Leverage Command-Line tool.

Project description

Binbash Leverage

Leverage CLI

Leverage CLI is the tool used to manage and interact with any Leverage project.

It transparently handles the most complex and error prone tasks that arise from working with a state-of-the-art infrastructure definition like our Leverage Reference Architecture. Leverage CLI uses a dockerized approach to encapsulate the tools needed to perform such tasks and to free the user from having to deal with the configuration and management of said tools. Provides the means to interact with your Leverage project and allows you to define custom tasks to run.

Documentation

For installation instructions and all documentation regarding Leverage CLI, please refer to this page.

Running Tests

To run unit tests, pytest is the tool of choice, and the required dependencies are available in the corresponding dev-requirements.txt.

Integration tests are implemented using bats. Bear in mind that bats tests are meant to be run in a throwaway environment since they perform filesystem manipulations and installation and removal of packages, and the cleanup may not be completely thorough. As such, is highly recommended to run these tests using de docker image.

Manually

Unit tests:

pip3 install -r dev-requirements.txt
python3 -m pytest

Integration tests:

bats -r tests/bats

Using docker image

A Docker image suitable for running all tests is provided and available in DockerHub.

To run all tests, run make tests. Alternatively make test-unit or make test-int for unit or integration tests respectively.

Release Process

  • On every PR, a Github Action workflow is triggered to create/update a release draft.
  • The version number is determined by the labels of those PRs (major, minor, fix).
  • The release draft has to be manually published. This allows for any number of PR (features, fixes) to make the cut.
  • Once a release is published, another workflow is triggered to create and push the package to PyPi.

Contributors/Contributing

License

Leverage CLI is licensed under MIT licenseBinBash Inc

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

leverage-1.6.2.tar.gz (33.4 kB view hashes)

Uploaded Source

Built Distribution

leverage-1.6.2-py3-none-any.whl (37.7 kB view hashes)

Uploaded Python 3

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