Metadata-Version: 2.1
Name: formal-datahub
Version: 0.1.0
Summary: Formal Datahub Plugin
Author-email: Formal <hello@joinformal.com>
License: Copyright (c) 2018 The Python Packaging Authority
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/formalco/formal-datahub
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# formal-datahub

This package allows you to sync your Formal Inventory with Datahub.

## Quickstart


Get familiar with Datahub Custom Sources and Actions:
    - https://datahubproject.io/docs/how/add-custom-ingestion-source
    - https://datahubproject.io/docs/actions



Install the Formal package:
`pip install formal-datahub`



See `/example` for examples. Be sure to set your secrets in environment variables.


---

# Examples

Run Ingestion: `datahub ingest -c ingest/formal_to_datahub.dhub.yaml`

Run Action: `datahub actions -c actions/datahub_to_formal.yaml`

If you are having trouble installing on M1, see the following: https://segmentfault.com/a/1190000040867082/en

