FunctionHub client
| Items | Contents |
|---|---|
| Short Description | The FunctionHub-cli provides interaction with FunctionHub for storing and accessing reusable functions. FunctionHub is child of Cloudstash, a broader cloud based storage unit for functions and artifacts. |
| Documentation | https://functionhub-cli.readthedocs.io/ |
| Video | WPI |
| Licence | Apache License, Version 2.0 |
| Contact |
|
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
pip install functionhub
User account & Navigation
- Create a user account on FunctionHub
- Store the deploy token given to you
- Navigate through the website to discover different options for functions
Pushing functions to FunctionHub using CLI
- Create a project.
fuhub create exampleProject - Change directory to the project directory.
cd exampleProject - Set the configuration file config.ini with your parameters. (example of config.ini can be found in test directory)
- Create a zipped folder containing your function and libraries if necessary.
- Upload the function to FunctionHub.
fuhub --token <deploy-token> upload myfunction.zip
Retreiving Functions from FunctionHub
- Browse FunctionHub and find the Function of your choice
- Copy the ArtifacId
- 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.
coverage run --source ../functionhub -m pytestcoverage report -m