focus-converter 1.0.0

No project description provided

FOCUS Converter

The FOCUS Converter is a command-line utility to convert billing data files from popular public cloud providers, such as Amazon Web Services, Microsoft Azure, Google Cloud and Oracle Cloud, into the common schema known as FOCUS. You can read the specification at FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec.

The converter is optimized for:

• Ability to act on the large files and wire formats provided by cloud providers.
• Comprehensibility of the conversion process which encodes an understanding of the specification as-written.
• Best-effort conversion where the appropriate data for FOCUS does not exist in the provider's data file.
• Modularity so that new types of billing data can be supported.

Currently Supported Cloud Providers

• Amazon Web Services
• Google Cloud
• Microsoft Azure
• Oracle Cloud

Want to add your own? See CONTRIBUTING.md

Conversion Rules

The conversion rules are defined in YAML files in the conversion_configs directory. Each file contains a list of conversion rules, which are applied in order.

Rules are also exported per provider in the following directories based on format:

• Markdown: Rules Export Markdown
• CSV: Rules Export CSV

Installation

The FOCUS converter supports Python 3.9 and above. If you meet these requirements, you can install with pip:

pip install focus_converter

After this, you will have a script called focus-converter in your path.

Example Usage

focus-converter convert --provider aws --data-path path/to/aws/parquet/cur/ --data-format parquet --parquet-data-format dataset --export-path /tmp/output/

Use focus-converter list-providers to see the other providers that are supported.

Development setup

1. Clone this repository.
2. Install Poetry if you don't have it.
3. Install libmagic if you don't have it.
4. Run the following shell snippet:

cd focus_converter_base/
poetry install --only main --no-root

Before using python -m focus_converter.main as a substitute for the pre-installed focus-converter script and testing repository changes, ensure to run the poetry shell command to set up the environment correctly.

Provider Progress

Look at pie charts showing the progress of the conversion for each provider. For each provider there is a pie chart showing number of FOCUS dimensions added to the conversion plan vs pending.

License

This project is licensed under the terms of the MIT license.

Contributing

We're excited to work together. Please see CONTRIBUTING.md for information on how to get started.