finopspp 0.1.0__tar.gz

finopspp-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 FinOps++ Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

finopspp-0.1.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: finopspp
+Version: 0.1.0
+Summary: CLI tool used for the FinOps++ Assessment.
+Author: Travis Salas Cox
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click==8.2.1
+Requires-Dist: click-didyoumean==0.3.1
+Requires-Dist: click-help-colors==0.9.4
+Requires-Dist: GitPython==3.1.62
+Requires-Dist: jinja2==3.1.6
+Requires-Dist: pandas==2.3.2
+Requires-Dist: pydantic==2.12.0
+Requires-Dist: pyyaml==6.0.2
+Requires-Dist: rich==14.2.0
+Requires-Dist: semver==3.0.4
+Requires-Dist: textual==8.2.3
+Requires-Dist: xlsxwriter==3.2.5
+Provides-Extra: validation
+Requires-Dist: pylint==4.0.3; extra == "validation"
+Provides-Extra: testing
+Requires-Dist: pytest==9.0.1; extra == "testing"
+Dynamic: license-file
+
+# CLI Tool
+
+To aid with formatting, transforming, and using the yaml specification files, we built the `finopspp` CLI tool. Currently, to use it you have to build it from source from this repository. To do this, please read through [Developing the finopspp CLI tool](/guidelines/development.md#developing-the-finopspp-cli-tool) in the [development](/guidelines/development.md) guide.
+
+Below we will go through a few of the key commands this CLI tools provides. If you have the tool installed, we encourage you to play around with the tools and look at commands not discussed below, such as the `finopspp version` command.
+
+## Generating commands
+
+The most useful commands to use with `finopspp` will be related to generate some aspect of the framework. Either markdown documentation or Excel files.
+
+### Framework Markdown & Assessment Worksheet
+
+The most useful (or powerful) of the most useful commands offered by `finopspp` is the command used to generate the framework markdown and assessment worksheet files for a profile. The framework markdown files are designed to give a one-stop shop for getting an overview, in tabular format, of how a framework (generated from a profile) is logically grouped together. While the assessment worksheet is used for scoring the priority weighted maturity of an organization against action completeness for a profile.
+
+To generate the markdown for the framework overview and assessment excel file, make sure that the profile you desire to use is included under [specifications/profiles](https://github.com/FinOpsPP/Framework-Assessment/tree/main/specifications/profiles/) or, if need be, create a new profile.
+
+Then run the following
+
+```{sh}
+finopspp generate assessment --profile="<desired-profile-name>"
+```
+
+you can run `finopspp generate assessment --help` to see the list of profile options. The files generated by this command can be found in [assessments](https://github.com/FinOpsPP/Framework-Assessment/tree/main/assessments/). Simply search in this directory for a `<desired-profile-name>` subdirectory. This subdirectory will include your framework markdown and assessment.
+
+### Components Markdown
+
+These files are designed to be generally more human readable and easier to navigate than the yaml specifications. The four components supported directly correlate with the four specification types used currently by `finopspp`. Which are `profiles`, `domains`, `capabilities`, and `actions`; and can be found in subdirectories of the same names under.
+
+- [components/profiles](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/profiles/)
+- [components/domains](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/domains/)
+- [components/capabilities](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/capabilities/)
+- [components/actions](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/actions/)
+
+> [!NOTE]
+> `profiles` markdown files are generated and offered on an as-best-as-possible basis. This is because of the customization allowed for this type. Generally it is recommended to use the Framework markdown to get a true overview of the profiles. But we include them for the sake of compilation.
+
+To generate the files in these folder fresh from the yaml files, you can call the following command
+
+```{sh}
+finopspp generate components --specification-type=<desired-spec-type> <spec-id-or-all-or-diff>
+```
+
+> [!NOTE]
+> The serialization number for a markdown file uses the schema `xxx.md`, where `xxx` will match the serialization number of the yaml specification for the profile or component.
+
+Using this command, you can generate a component markdown file for a specific specification ID, for a specific specification type. If you pass in `all`, you can generate the component markdown files for all specifications under a given type specific type. While passing `diff` will generate component markdown files for the specifications of a given type that have changed when compared to the `main` branch of the repository. This last option requires the `git` tool to be installed. For more on that please read the [Development](/guidelines/development.md) Guideline.
+
+## Specification commands
+
+A set of utility commands that can do a number of different actions relevant to the yaml specifications. This range from showing the [OpenAPI schema](https://www.openapis.org/what-is-openapi) for the different specifications types, to full updates of the specifications via changes to a specification model derived using [Pydantic](https://docs.pydantic.dev/latest/concepts/models/).
+
+### Validation
+
+One of the most useful command is the validation command
+
+```{sh}
+finopspp specifications validate --specification-type=<desired-spec-type> <spec-id-or-all-or-diff>
+```
+
+With this, you can validate a specific specification by ID and type. While, by passing in `all`, you can validate all specification for a specific type. Or, if you have `git` installed, you can pass `diff` which will validate only the specifications of a given type that have changed when compared to the `main` branch of the repository.
+
+Validation is relatively strict, and makes uses of Pydantic [validator](https://docs.pydantic.dev/latest/concepts/validators/). Validation failures are logged to stderr for the user, and results in a failure return code on the command if any specifications fail to validate during a run.
+
+### Update
+
+Another really useful command is `update`, which can be called with the following
+
+```{sh}
+finopspp specifications update --specification-type=<desired-spec-type> <spec-id-or-all>
+```
+
+Giving a specification type, and corresponding changes to the specification type's [model definitions](/src/models/definitions.py), you can update that specification type's files by ID or all at once to match the new definition. Some updates work out-of-the-box, like adding/removing fields. While other more complex updates, such as renaming a field or changing the order of fields in the schema, are allowed by creating custom alias for fields or by using Pydantic [model_serializer](https://docs.pydantic.dev/latest/api/functional_serializers/#pydantic.functional_serializers.model_serializer).
+
+### New
+
+The `new` command will allow you to create new specification files from smart defaults, which can be found, in code, under [models/defaults.py](/src/models/defaults.py). The new specification file, created for a desired specification type, can be used as template to fill-in until the specification is in a state that is ready to be publish.
+
+The command to create these new specification is simply
+
+```{sh}
+finopspp specifications new --specification-type=<desired-spec-type> <desired-id>
+```
+
+> [!IMPORTANT]
+> If you are creating a new profile, make sure to select a Title for the specification that has not already been used. Otherwise this will cause a collision issues with the generate assessment command.
+
+The only requirement is that the desired ID be unique. If it has been used previously, an error will be returned and the specification file will not be created.

finopspp-0.1.0/README.md

@@ -0,0 +1,87 @@
+# CLI Tool
+
+To aid with formatting, transforming, and using the yaml specification files, we built the `finopspp` CLI tool. Currently, to use it you have to build it from source from this repository. To do this, please read through [Developing the finopspp CLI tool](/guidelines/development.md#developing-the-finopspp-cli-tool) in the [development](/guidelines/development.md) guide.
+
+Below we will go through a few of the key commands this CLI tools provides. If you have the tool installed, we encourage you to play around with the tools and look at commands not discussed below, such as the `finopspp version` command.
+
+## Generating commands
+
+The most useful commands to use with `finopspp` will be related to generate some aspect of the framework. Either markdown documentation or Excel files.
+
+### Framework Markdown & Assessment Worksheet
+
+The most useful (or powerful) of the most useful commands offered by `finopspp` is the command used to generate the framework markdown and assessment worksheet files for a profile. The framework markdown files are designed to give a one-stop shop for getting an overview, in tabular format, of how a framework (generated from a profile) is logically grouped together. While the assessment worksheet is used for scoring the priority weighted maturity of an organization against action completeness for a profile.
+
+To generate the markdown for the framework overview and assessment excel file, make sure that the profile you desire to use is included under [specifications/profiles](https://github.com/FinOpsPP/Framework-Assessment/tree/main/specifications/profiles/) or, if need be, create a new profile.
+
+Then run the following
+
+```{sh}
+finopspp generate assessment --profile="<desired-profile-name>"
+```
+
+you can run `finopspp generate assessment --help` to see the list of profile options. The files generated by this command can be found in [assessments](https://github.com/FinOpsPP/Framework-Assessment/tree/main/assessments/). Simply search in this directory for a `<desired-profile-name>` subdirectory. This subdirectory will include your framework markdown and assessment.
+
+### Components Markdown
+
+These files are designed to be generally more human readable and easier to navigate than the yaml specifications. The four components supported directly correlate with the four specification types used currently by `finopspp`. Which are `profiles`, `domains`, `capabilities`, and `actions`; and can be found in subdirectories of the same names under.
+
+- [components/profiles](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/profiles/)
+- [components/domains](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/domains/)
+- [components/capabilities](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/capabilities/)
+- [components/actions](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/actions/)
+
+> [!NOTE]
+> `profiles` markdown files are generated and offered on an as-best-as-possible basis. This is because of the customization allowed for this type. Generally it is recommended to use the Framework markdown to get a true overview of the profiles. But we include them for the sake of compilation.
+
+To generate the files in these folder fresh from the yaml files, you can call the following command
+
+```{sh}
+finopspp generate components --specification-type=<desired-spec-type> <spec-id-or-all-or-diff>
+```
+
+> [!NOTE]
+> The serialization number for a markdown file uses the schema `xxx.md`, where `xxx` will match the serialization number of the yaml specification for the profile or component.
+
+Using this command, you can generate a component markdown file for a specific specification ID, for a specific specification type. If you pass in `all`, you can generate the component markdown files for all specifications under a given type specific type. While passing `diff` will generate component markdown files for the specifications of a given type that have changed when compared to the `main` branch of the repository. This last option requires the `git` tool to be installed. For more on that please read the [Development](/guidelines/development.md) Guideline.
+
+## Specification commands
+
+A set of utility commands that can do a number of different actions relevant to the yaml specifications. This range from showing the [OpenAPI schema](https://www.openapis.org/what-is-openapi) for the different specifications types, to full updates of the specifications via changes to a specification model derived using [Pydantic](https://docs.pydantic.dev/latest/concepts/models/).
+
+### Validation
+
+One of the most useful command is the validation command
+
+```{sh}
+finopspp specifications validate --specification-type=<desired-spec-type> <spec-id-or-all-or-diff>
+```
+
+With this, you can validate a specific specification by ID and type. While, by passing in `all`, you can validate all specification for a specific type. Or, if you have `git` installed, you can pass `diff` which will validate only the specifications of a given type that have changed when compared to the `main` branch of the repository.
+
+Validation is relatively strict, and makes uses of Pydantic [validator](https://docs.pydantic.dev/latest/concepts/validators/). Validation failures are logged to stderr for the user, and results in a failure return code on the command if any specifications fail to validate during a run.
+
+### Update
+
+Another really useful command is `update`, which can be called with the following
+
+```{sh}
+finopspp specifications update --specification-type=<desired-spec-type> <spec-id-or-all>
+```
+
+Giving a specification type, and corresponding changes to the specification type's [model definitions](/src/models/definitions.py), you can update that specification type's files by ID or all at once to match the new definition. Some updates work out-of-the-box, like adding/removing fields. While other more complex updates, such as renaming a field or changing the order of fields in the schema, are allowed by creating custom alias for fields or by using Pydantic [model_serializer](https://docs.pydantic.dev/latest/api/functional_serializers/#pydantic.functional_serializers.model_serializer).
+
+### New
+
+The `new` command will allow you to create new specification files from smart defaults, which can be found, in code, under [models/defaults.py](/src/models/defaults.py). The new specification file, created for a desired specification type, can be used as template to fill-in until the specification is in a state that is ready to be publish.
+
+The command to create these new specification is simply
+
+```{sh}
+finopspp specifications new --specification-type=<desired-spec-type> <desired-id>
+```
+
+> [!IMPORTANT]
+> If you are creating a new profile, make sure to select a Title for the specification that has not already been used. Otherwise this will cause a collision issues with the generate assessment command.
+
+The only requirement is that the desired ID be unique. If it has been used previously, an error will be returned and the specification file will not be created.

finopspp-0.1.0/finopspp.egg-info/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: finopspp
+Version: 0.1.0
+Summary: CLI tool used for the FinOps++ Assessment.
+Author: Travis Salas Cox
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click==8.2.1
+Requires-Dist: click-didyoumean==0.3.1
+Requires-Dist: click-help-colors==0.9.4
+Requires-Dist: GitPython==3.1.62
+Requires-Dist: jinja2==3.1.6
+Requires-Dist: pandas==2.3.2
+Requires-Dist: pydantic==2.12.0
+Requires-Dist: pyyaml==6.0.2
+Requires-Dist: rich==14.2.0
+Requires-Dist: semver==3.0.4
+Requires-Dist: textual==8.2.3
+Requires-Dist: xlsxwriter==3.2.5
+Provides-Extra: validation
+Requires-Dist: pylint==4.0.3; extra == "validation"
+Provides-Extra: testing
+Requires-Dist: pytest==9.0.1; extra == "testing"
+Dynamic: license-file
+
+# CLI Tool
+
+To aid with formatting, transforming, and using the yaml specification files, we built the `finopspp` CLI tool. Currently, to use it you have to build it from source from this repository. To do this, please read through [Developing the finopspp CLI tool](/guidelines/development.md#developing-the-finopspp-cli-tool) in the [development](/guidelines/development.md) guide.
+
+Below we will go through a few of the key commands this CLI tools provides. If you have the tool installed, we encourage you to play around with the tools and look at commands not discussed below, such as the `finopspp version` command.
+
+## Generating commands
+
+The most useful commands to use with `finopspp` will be related to generate some aspect of the framework. Either markdown documentation or Excel files.
+
+### Framework Markdown & Assessment Worksheet
+
+The most useful (or powerful) of the most useful commands offered by `finopspp` is the command used to generate the framework markdown and assessment worksheet files for a profile. The framework markdown files are designed to give a one-stop shop for getting an overview, in tabular format, of how a framework (generated from a profile) is logically grouped together. While the assessment worksheet is used for scoring the priority weighted maturity of an organization against action completeness for a profile.
+
+To generate the markdown for the framework overview and assessment excel file, make sure that the profile you desire to use is included under [specifications/profiles](https://github.com/FinOpsPP/Framework-Assessment/tree/main/specifications/profiles/) or, if need be, create a new profile.
+
+Then run the following
+
+```{sh}
+finopspp generate assessment --profile="<desired-profile-name>"
+```
+
+you can run `finopspp generate assessment --help` to see the list of profile options. The files generated by this command can be found in [assessments](https://github.com/FinOpsPP/Framework-Assessment/tree/main/assessments/). Simply search in this directory for a `<desired-profile-name>` subdirectory. This subdirectory will include your framework markdown and assessment.
+
+### Components Markdown
+
+These files are designed to be generally more human readable and easier to navigate than the yaml specifications. The four components supported directly correlate with the four specification types used currently by `finopspp`. Which are `profiles`, `domains`, `capabilities`, and `actions`; and can be found in subdirectories of the same names under.
+
+- [components/profiles](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/profiles/)
+- [components/domains](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/domains/)
+- [components/capabilities](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/capabilities/)
+- [components/actions](https://github.com/FinOpsPP/Framework-Assessment/tree/main/components/actions/)
+
+> [!NOTE]
+> `profiles` markdown files are generated and offered on an as-best-as-possible basis. This is because of the customization allowed for this type. Generally it is recommended to use the Framework markdown to get a true overview of the profiles. But we include them for the sake of compilation.
+
+To generate the files in these folder fresh from the yaml files, you can call the following command
+
+```{sh}
+finopspp generate components --specification-type=<desired-spec-type> <spec-id-or-all-or-diff>
+```
+
+> [!NOTE]
+> The serialization number for a markdown file uses the schema `xxx.md`, where `xxx` will match the serialization number of the yaml specification for the profile or component.
+
+Using this command, you can generate a component markdown file for a specific specification ID, for a specific specification type. If you pass in `all`, you can generate the component markdown files for all specifications under a given type specific type. While passing `diff` will generate component markdown files for the specifications of a given type that have changed when compared to the `main` branch of the repository. This last option requires the `git` tool to be installed. For more on that please read the [Development](/guidelines/development.md) Guideline.
+
+## Specification commands
+
+A set of utility commands that can do a number of different actions relevant to the yaml specifications. This range from showing the [OpenAPI schema](https://www.openapis.org/what-is-openapi) for the different specifications types, to full updates of the specifications via changes to a specification model derived using [Pydantic](https://docs.pydantic.dev/latest/concepts/models/).
+
+### Validation
+
+One of the most useful command is the validation command
+
+```{sh}
+finopspp specifications validate --specification-type=<desired-spec-type> <spec-id-or-all-or-diff>
+```
+
+With this, you can validate a specific specification by ID and type. While, by passing in `all`, you can validate all specification for a specific type. Or, if you have `git` installed, you can pass `diff` which will validate only the specifications of a given type that have changed when compared to the `main` branch of the repository.
+
+Validation is relatively strict, and makes uses of Pydantic [validator](https://docs.pydantic.dev/latest/concepts/validators/). Validation failures are logged to stderr for the user, and results in a failure return code on the command if any specifications fail to validate during a run.
+
+### Update
+
+Another really useful command is `update`, which can be called with the following
+
+```{sh}
+finopspp specifications update --specification-type=<desired-spec-type> <spec-id-or-all>
+```
+
+Giving a specification type, and corresponding changes to the specification type's [model definitions](/src/models/definitions.py), you can update that specification type's files by ID or all at once to match the new definition. Some updates work out-of-the-box, like adding/removing fields. While other more complex updates, such as renaming a field or changing the order of fields in the schema, are allowed by creating custom alias for fields or by using Pydantic [model_serializer](https://docs.pydantic.dev/latest/api/functional_serializers/#pydantic.functional_serializers.model_serializer).
+
+### New
+
+The `new` command will allow you to create new specification files from smart defaults, which can be found, in code, under [models/defaults.py](/src/models/defaults.py). The new specification file, created for a desired specification type, can be used as template to fill-in until the specification is in a state that is ready to be publish.
+
+The command to create these new specification is simply
+
+```{sh}
+finopspp specifications new --specification-type=<desired-spec-type> <desired-id>
+```
+
+> [!IMPORTANT]
+> If you are creating a new profile, make sure to select a Title for the specification that has not already been used. Otherwise this will cause a collision issues with the generate assessment command.
+
+The only requirement is that the desired ID be unique. If it has been used previously, an error will be returned and the specification file will not be created.

finopspp-0.1.0/finopspp.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+finopspp.egg-info/PKG-INFO
+finopspp.egg-info/SOURCES.txt
+finopspp.egg-info/dependency_links.txt
+finopspp.egg-info/entry_points.txt
+finopspp.egg-info/requires.txt
+finopspp.egg-info/top_level.txt
+src/__main__.py
+tests/test_assessment_generation.py

finopspp-0.1.0/finopspp.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

finopspp-0.1.0/finopspp.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+finopspp = finopspp.__main__:cli

finopspp-0.1.0/finopspp.egg-info/requires.txt

@@ -0,0 +1,18 @@
+click==8.2.1
+click-didyoumean==0.3.1
+click-help-colors==0.9.4
+GitPython==3.1.62
+jinja2==3.1.6
+pandas==2.3.2
+pydantic==2.12.0
+pyyaml==6.0.2
+rich==14.2.0
+semver==3.0.4
+textual==8.2.3
+xlsxwriter==3.2.5
+
+[testing]
+pytest==9.0.1
+
+[validation]
+pylint==4.0.3

finopspp-0.1.0/finopspp.egg-info/top_level.txt

@@ -0,0 +1 @@
+finopspp

finopspp-0.1.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=80.9.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "finopspp"
+version = "0.1.0"
+description = "CLI tool used for the FinOps++ Assessment."
+readme = "README.md"
+requires-python = ">=3.13"
+authors = [{ name = "Travis Salas Cox" }]
+dependencies = [
+    "click == 8.2.1",
+    "click-didyoumean == 0.3.1",
+    "click-help-colors == 0.9.4",
+    "GitPython == 3.1.62",
+    "jinja2 == 3.1.6",
+    "pandas == 2.3.2",
+    "pydantic == 2.12.0",
+    "pyyaml == 6.0.2",
+    "rich == 14.2.0",
+    "semver == 3.0.4",
+    "textual == 8.2.3",
+    "xlsxwriter == 3.2.5"
+]
+
+[project.optional-dependencies]
+validation = [
+    "pylint == 4.0.3"
+]
+testing = [
+    "pytest == 9.0.1"
+]
+
+[project.scripts]
+finopspp = "finopspp.__main__:cli"
+
+[tool.setuptools]
+packages = ["finopspp"]
+
+[tool.setuptools.package-dir]
+"finopspp" = "src"
+"finopspp.commands" = "src/commands"
+"finopspp.models" = "src/models"
+"finopspp.templates" = "src/templates"

finopspp-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

finopspp-0.1.0/src/__main__.py

@@ -0,0 +1,51 @@
+"""primary code for the finopspp CLI"""
+import os
+import sys
+
+import click
+
+from finopspp.commands import utils
+from finopspp.commands.init import group as init_group
+from finopspp.commands.info import group as info_group
+from finopspp.commands.generate import group as generate_group
+from finopspp.commands.specifications import group as specifications_group
+from finopspp.commands.inventory import group as inventory_group
+from finopspp.commands.variables import group as variables_group
+
+
+@click.group(cls=utils.ClickGroup)
+@click.pass_context
+def cli(ctx):
+    """FinOps++ administration tool"""
+    home_directory = os.path.expanduser('~')
+    config_path = os.path.join(home_directory, '.finopspp', 'config.toml')
+    if not os.path.exists(config_path) and 'init' not in ctx.invoked_subcommand:
+        click.secho(
+            'Tool configuration does not exist. Please run `finopspp init`',
+            err=True,
+            fg='red'
+        )
+        sys.exit(1)
+    if 'init' in ctx.invoked_subcommand:
+        return
+
+    # load up the config based on the path. This command can exit if an invalid config is found
+    utils.load_config(config_path)
+
+    # configure profiles and variables from what are found
+    utils.profiles()
+    utils.variables()
+
+cli.add_command(init_group.init)
+cli.add_command(init_group.validate, name='init-validate')
+cli.add_command(info_group.info)
+cli.add_command(generate_group.generate)
+cli.add_command(specifications_group.specifications)
+cli.add_command(inventory_group.inventory)
+cli.add_command(variables_group.variables)
+
+
+# include for those running script directly
+# as a python module.
+if __name__ == "__main__":
+    cli() # pylint: disable=no-value-for-parameter

finopspp-0.1.0/tests/test_assessment_generation.py

@@ -0,0 +1,52 @@
+"""Test composers"""
+import json
+import os
+
+import yaml
+
+from finopspp.commands import utils
+from finopspp.commands.generate.helpers import specification_collector
+from finopspp.commands.generate.composers.helpers import normalize
+
+
+def test_normalize():
+    """Test for the composer util 'normalize'"""
+    profile = 'Example Profile'
+    home_directory = os.path.expanduser('~')
+    config_path = os.path.join(home_directory, '.finopspp', 'config.toml')
+    utils.load_config(config_path)
+    utils.profiles(testing=True)
+    with open(utils.ProfilesMap[profile], 'r', encoding='utf-8') as yaml_file:
+        profile_yaml = yaml.safe_load(
+            yaml_file
+        )
+        profile_spec = profile_yaml['Specification']
+        profile_spec['version'] = profile_yaml['Metadata']['Version']
+
+    # pull in formatted domains data-dict
+    # example specifications should only ever be in the Proposed status
+    allowed_statuses = [
+        'Proposed'
+    ]
+    variables = {}
+    domains = specification_collector(
+        profile, profile_spec, allowed_statuses, variables
+    )
+    assert domains
+
+    data_path = os.path.join(os.getcwd(), 'tests/data/expected_example_domains.json')
+    with open(data_path, mode='r', encoding='utf-8') as in_file:
+        expected_domains = json.load(in_file)
+
+    assert domains == expected_domains
+
+    # now normalize the domains
+    normalized_domains = normalize(domains)
+    assert normalized_domains is not None
+
+    data_path = os.path.join(os.getcwd(), 'tests/data/expected_example_dataframe.json')
+    with open(data_path, mode='r', encoding='utf-8') as in_file:
+        expected_dataframe = json.load(in_file)
+
+    json_dataframe = json.loads(normalized_domains.to_json())
+    assert json_dataframe == expected_dataframe