Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 2.08 KB

index.md

File metadata and controls

57 lines (42 loc) · 2.08 KB

Surfactant

CI Test Status PyPI Python Versions MIT License Documentation Status pre-commit.ci status

Welcome to Surfactant's documentation!

Surfactant provides a modular framework to gather file information and analyze dependencies for generating an SBOM.

Some links to pages that may be useful are:

PyPI GitHub/Source Code Discussions

Contents

.. toctree::
   :maxdepth: 2

   self
   getting_started
   basic_usage
   configuration_files
   plugins
   settings
   contribution_guide
   changelog
   api_reference

Support

Full user guides for Surfactant are available online and in the docs directory in the GitHub repository.

For questions or support, please create a new discussion on GitHub Discussions, or open an issue for bug reports and feature requests.

License

Surfactant is released under the MIT license. See the LICENSE and NOTICE files for details. All new contributions must be made under this license.

Indices and tables

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`