Skip to main content

shellfoundry - Quali tool for creating, building and installing CloudShell shells

Project description

shellfoundry
============

**Create, Innovate and Automate with ShellFoundry**

|Chat| |BuildStatus| |CoverageStatus| |PyVersion| |PyPI| |DependencyStatus|

Command line utility for CloudShell shells developers. The utility helps
to create a new shell based on a template, build an installable shell
package and install a shell into your CloudShell.

Installation
============

.. code:: bash

$ pip install shellfoundry

Usage
=====

ShellFoundry streamlines the whole process of shell development from choosing a template, via code generation and
installation.

1. Choose a TOSCA template

.. code:: bash

$ shellfoundry list

2. Create a shell

.. code:: bash

$ shellfoundry new <shell> –-template <template>
$ cd <shell>

3. Define data model in shell-definition.yml
4. Generate data model

.. code:: bash

$ shellfoundry generate

5. Implement logic in driver.py using classes from data\_model.py
6. Install the shell package into Cloudshell

.. code:: bash

$ shellfoundry install

Additional Links
================

- For more commands and detailed usage please refer to `Documentation`_

- Opening issues and feature requests: `Issue Tracker`_

- Forum for questions and discussions: `Gitter.im`_

License
=======

`Apache License 2.0`_

.. _Documentation: docs/readme.md
.. _Issue Tracker: https://github.com/QualiSystems/shellfoundry/issues
.. _Gitter.im: https://gitter.im/QualiSystems/shellfoundry
.. _Apache License 2.0: https://github.com/QualiSystems/shellfoundry/blob/master/LICENSE

.. |Chat| image:: https://badges.gitter.im/QualiSystems/shellfoundry.svg
:target: https://gitter.im/QualiSystems/shellfoundry?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. |BuildStatus| image:: https://travis-ci.org/QualiSystems/shellfoundry.svg?branch=develop
:target: https://travis-ci.org/QualiSystems/shellfoundry
.. |CoverageStatus| image:: https://coveralls.io/repos/github/QualiSystems/shellfoundry/badge.svg?branch=develop
:target: https://coveralls.io/github/QualiSystems/shellfoundry?branch=develop
.. |PyVersion| image:: https://img.shields.io/pypi/pyversions/shellfoundry.svg?maxAge=2592000
:target: https://pypi.python.org/pypi/shellfoundry
.. |PyPI| image:: https://img.shields.io/pypi/v/shellfoundry.svg?maxAge=2592000
:target: https://pypi.python.org/pypi/shellfoundry
.. |DependencyStatus| image:: https://dependencyci.com/github/QualiSystems/shellfoundry/badge
:target: https://dependencyci.com/github/QualiSystems/shellfoundry








=======
History
=======

0.2.6 (2017-03-14)
------------------

* Fixed some minor bugs

0.2.2 (2017-01-22)
------------------

* gen2/resource is the now the default template for new command instead of gen1/resource

0.2.0 (2017-01-17)
------------------

* List command filtering parameters have changed (legacy => gen1, tosca => gen2)
* Added another filtering parameter --layer1
* Minimum CloudShell version column appears on list command output table
* gen2 is now the default view for list command

0.1.3 (2016-12-27)
------------------

* shellfoundry config will now echo all default configuration if not override by user

0.1.2 (2016-12-26)
------------------

* Config command will now encrypt password field

0.1.0 (2016-12-14)
------------------

* Show command was added to view all available versions of a template
* A new option was added to the 'new' command. Please welcome --version. It enables template versioning on shellfoundry.

0.0.44 (2016-12-12)
-------------------

* Fixed a bug in config command which caused shellfoundry to crash when config file has not existed

0.0.43 (2016-12-11)
-------------------

* List command is now able to filter results based on shell type (--tosca, --legacy, --all)

0.0.41 (2016-12-08)
-------------------

* Config command was added to allow setting configuration once for all shells in addition to local configuration

0.0.39 (2016-10-09)
-------------------

* Pack Shell icon if specified in shell-definition.yml file under metadata\template_icon for TOSCA based shells

0.0.38 (2016-09-28)
-------------------

* Update reference to cloudshell-rest-api 7.2.0.7 to use PUT method in update shell

0.0.35 (2016-09-15)
-------------------

* TOSCA support was added to pack and install commands
* Generate command was added that generates driver data model in Python

0.0.32 (2016-08-10)
-------------------

* Pack command downloads dependencies into dist directory
* Dependency for git was removed
* Local shell templates are supported
* Proxy support was added for access to github

0.0.31 (2016-08-04)
-------------------

* git prerequisite was removed. shellfoundry works without git being preinstalled

0.0.28 (2016-07-07)
-------------------

* Installation of package into CloudShell was fixed


0.0.26 (2016-06-23)
-------------------

* Images copied to the DataModel folder (Issue #21)

0.0.17 (2016-05-25)
-------------------

* Proper error message when install command fails in logging in into CloudShell

0.0.1 (2016-05-02)
------------------

* First release on PyPI.

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

shellfoundry-0.2.6.tar.gz (46.1 kB view hashes)

Uploaded Source

Built Distribution

shellfoundry-0.2.6-py2-none-any.whl (37.8 kB view hashes)

Uploaded Python 2

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