FunctionHub client

System Requirements

This README is currently tailored to Unix-like systems (MacOS, Linux).

For FunctionHub developers and users, the following additional software must be installed:

• pip - Python standard package manager

Using FunctionHub

Install fuhub with

1. pip install functionhub

User account & Navigation

1. Create a user account on FunctionHub
2. Store the deploy token given to you
3. Navigate through the website to discover different options for functions

Pushing functions to FunctionHub using CLI

1. Create a project. fuhub create exampleProject
2. Change directory to the project directory. cd exampleProject
3. Set the configuration file config.ini with your parameters. (example of config.ini can be found in test directory)
4. Create a zipped folder containing your function and libraries if necessary.
5. Upload the function to FunctionHub. fuhub --token <deploy-token> upload myfunction.zip

Retreiving Functions from FunctionHub

1. Browse FunctionHub and find the Function of your choice
2. Copy the ArtifacId
3. In terminal do curl -o function.zip https://cloudstash.io/artifact_download/<ArtifactId>

Contribution

We encourage contributions from everyone who finds interest in this project!

For any ideas, bugs or new features use our issue tracker at our GitHub project.

When contributing, fork the repository and commit work through pull requests.

Read the roadmap

Test Suite

The test suite is located in the test folder. The following instructions executes the test suite powered by pytest and coverage.

1. coverage run --source ../functionhub -m pytest
2. coverage report -m