The Cloud Scanner generic project includes many generic and common implementations for data storage including SQL and ElasticSearch providers.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cloud_scanner_generic
docs
tests
.gitignore
.travis.yml
LICENSE
Makefile
README.md
requirements.txt
setup.py

README.md

Cloud Scanner (Generic)

Build Status PyPI

Generic package of adapters for cloud-scanner library. Includes services and their required configurations.

Note: This library was developed by the Microsoft Commercial Software Engineering team as a tool for the Open Source community to use and contribute to as they see fit. Use at your own risk!

Developer Documentation

Read the API docs

Running Locally

You can run unit tests in a Python 3.6 virtual environment:

virtualenv env
source env/bin/activate
(env) pip install -r requirements.txt
(env) pytest

Required environment variables to run with cloud_scanner

Storage Adapters

  • ElasticSearch
    • Needs ELASTIC_SEARCH_URL and ELASTIC_SEARCH_ACCESS_KEY
  • MySQL
    • Needs MYSQL_HOST, MYSQL_DATABASE, MYSQL_USERNAME and MYSQL_PASSWORD
  • Rest API Post Request
    • Needs REST_STORAGE_URL

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.