Package: cloudmesh-catalog
Cloudmesh CatalogCloudmesh catalog can be used to store information about a service, software
component, or project. The information included in it can be
categorized so that a comparision is possible.  The catalog is
implemented as REST service so it can be integrated in other projects
and searched programatically.The catalog depends on the cloudmesh command shell which allows eay
integration of new commands line environment.  It projects a sample
Interface for the catalog from the commandlineWe also can create static web pages from the catalog while using the export
feature and integrating the pages in for example hugo.We are currently exploring hugo docsy as it provides
an easy way to generate hirarchical web pages, but also leverages
hugos tags and categories. Other export formats include markdown and
bibtex.Instalation for developersIf you do not have yet create an ssh key and upload it to the
github repository.ssh-keygenUpload the~/.ssh/id_rsa.pubkey to githubDownload cloudmesh with its source repositoriesMake sure you ave python 3.10.2On Mac or Linux do$python3.10-mvenv~/ENV3
$source~/ENV3/bin/activateOn Windows$py--version# make sure its 3.10.2$py-mvenv~/ENV3
$source~/ENV3/bin/activateAfter that the instalation is the same on all operating systems.$mkdircm
$cdcm

$pipinstallcloudmesh-installer
$cloudmesh-installer-sshinstallcatalog
$cmshelpThis will download all source code for the cloudmesh shell
and compile from source.Now you are all ready to do programming and enhancing
cloudmesh-catalog If you have any issues, contactlaszewski@gmail.comManual pageA manual pasge shoudl be implemented incloudmesh-catalog/catalog/command/catalog.pyThis manual page can
be displayed with the following command:$cmshelpcataloghelpTo just see the usage type in$cmscatalogManaging the ServiceTODO: The integration of data into the service is not yet completed.TODO: service management on Windows is not yet completed.On Linux and macOS we can already experiment with an early prototype
that allows us starting, sopping, and getting the status of the service.
This service has nnot yet been integrated with a database.BUGTODO: The adat is not yet integrated and we like to use
cloudmesh/yamldb for it.Adding catalog and registry dataTODO: To add catalog and registry data for new services, one must create new
.yaml files in the appropriate folders: 'data/catalog/my_example.yaml'
and 'data/registry/my_example.yaml'. Each file must follow yaml
formatting similar to the following example.Example file: Amazon Comprehend (Catalog), amazon_comprehend.yaml---
id: amazon_comprehend:
name: Amazon Comprehend
title: Amazon Comprehend
author: Amazon
slug: amazon-comprehend
public: true
description: |
 Comprehend is Amazon's solution for cloud-based NLP.
 It is available with an AWS account. To use,
 it requires use of either the AWS Command Line
 Interface or an AWS SDK for Python, Java, or .NET.
 Notable features include functionality for giving
 batches of documents to be processed as well as
 submission of multiple jobs in a list. The DetectEntities
 function also allows use of a custom-trained
 model, but many other functions do not.
version: unknown
license: unknown
microservice: no
protocol: AWS API
owner: Amazon Web Services
modified: 9/29/2021
created: 11/29/2017
documentation: https://docs.aws.amazon.com/comprehend/index.html
source: unknown
specification: unknown
tags: ["nlp", "nlp service", "machine learning", "cloud service", "nlp api",
     "deep learning", "natural language processing", "artificial intelligence"]
categories: ["NLP"]
additional_metadata: unknown
endpoint: unknown
sla: https://aws.amazon.com/machine-learning/language/sla/
authors: The AWS team can be contacted through support ticket at https://aws.amazon.com/contact-us/
data: |
 User data is stored on Amazon servers under the associated AWS account and is protected under the AWS
 shared responsibility model as detailed here https://aws.amazon.com/compliance/shared-responsibility-model/Using the Catalog and Registry classesWritten in catalog.py and registry.py are classes capable of reading and storing the data written in the .yaml files. Both use the same interface.
Here is an example of the Catalog class in action:# initialize the catalog using data found in the given directory
catalog = Catalog('data/catalog/')
# query the catalog for Amazon Comprehend data, save result to amazon_catalog_data
amazon_catalog_data = cat.query({'name': 'Amazon Comprehend'})
# add a new data file to the catalog
catalog.add('new_example/azure_language.yaml')
# save entire catalog to a pickle file
catalog.to_pickle('catalog.pkl')
# load from pickle file
catalog.from_pickle('catalog.pkl')
# print catalog data
print(catalog.data)Using the yaml to markdown conversion scriptThe catalog command includes several prototype export formats
that takes all files recursively in a directory or an explicit file and converts it to the specified outputThis includescmscatalogexportbibtex--souce=SOURCE
cmscatalogexporthugo--souce=SOURCE
cmscatalogexportmd--souce=SOURCEThe commands will create next to the yal file entreies for bibtex,
hugo markdown, and markdown.The templates are just suggestions and we may improve them based on our
findings.Checking entriesIt is very important that any entry be checked for minimal yaml complience.
Hence we implemented a commandcmscatalogcheck--souce=SOURCEwhich will check all file sin the specified directory. THIs check will ignore line legth limits if the line contains an http or https refernce.
We also check the data format for YYYY-MM-DD.We know that it may be problematic to distingush automatically between YYYY-MM-DD and YYYY-DD-MM.
Hence we encourage you to be careful when adding entries.Developer Video TutorialsWe are providing a number of developer video tutorials that help undesrtanding how we develop code and leverage the
cloudmesh-cmd5 shell features:Cloudmesh Catalog. Who to improve the check featureCloudmesh Catalog. Overview of the converterCloudmesh Catalog. How to use the integration with hugoCloudmesh Catalog. Managing the server with start, stop, info, statusCloudmesh Catalog. Running the Server on a Mac on port 8001Github Tips and Project managementOverview Cloudmesh NIST projectOther videos are available athttps://www.youtube.com/c/GregorvonLaszewski/videos