Socket
Socket
Sign inDemoInstall

reqstool-python-decorators

Package Overview
Dependencies
0
Maintainers
8
Alerts
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

    reqstool-python-decorators

Reqstool Python Decorators


Maintainers
8

Readme

Commit Activity GitHub Issues License Build Static Badge

Reqstool Python Decorators

Description

This provides decorators and collecting of decorated code, formatting it and writing to yaml file.

Installation

The package name is reqstool-python-decorators.

  • Using pip install:
$pip install reqstool-python-decorators 

Usage

pyproject.toml

  • Hatch
dependencies = [
    "reqstool-python-decorators == <version>"
]
  • Poetry
[tool.poetry.dependencies]
reqstool-python-decorators = "<version>"

Decorators

Import decorators:

from reqstool-decorators.decorators.decorators import Requirements, SVCs

Example usage of the decorators:

@Requirements("REQ_111", "REQ_222")
def somefunction():
@SVCs("SVC_111", "SVC_222")
def test_somefunction():

Processor

Import processor:

from reqstool.processors.decorator_processor import DecoratorProcessor

Main function to collect decorators data and generate yaml file:

process_decorated_data(path_to_python_files, output_file)

path_to_python_files is the directories to search through to find decorated code.

(Optional) output_file is output file(path) the yaml file is stored to. Default is /build/reqstool/annotations.yml.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

FAQs


Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc