✨ Inventory Resources

[shnizzedy]

Related to

Related to #757 by @sgiavasis
Related to FCP-INDI/fcp-indi.github.io#185 by @sgiavasis
Related to FCP-INDI/fcp-indi.github.io#180 by @sgiavasis

Description

Crawls the codebase looking for where resources are

• created in the resource pool, either directly or as outputs from nodeblocks
• used as inputs for nodeblocks
• output to the output directory
  and creates an inventory YAML file listing this information alphabetically.

Technical details

• I based this PR on many_pipes, but it should be trivial to rebase it if we want it to go to develop or another branch instead.
• You should be able to run like

  docker run --rm -it --entrypoint resource_inventory ghcr.io/fcp-indi/c-pac:resource_inventory [-h] [-o [OUTPUT]]

  to get an inventory like resource_inventory.yaml

Tests

Screenshots

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the many_pipes branch of the repository.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added tests for the changes I made (if applicable).
• I updated the changelog.
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[shnizzedy]

Updated example output with more special cases covered (@ b3521fc): resource_inventory.yaml