pip-audit

pip-audit एक उपकरण है जो Python वातावरणों को ज्ञात कमजोरियों वाले पैकेजों के लिए स्कैन करता है। यह कमजोरी रिपोर्ट के स्रोत के रूप में PyPI JSON API के माध्यम से Python Packaging Advisory Database (https://github.com/pypa/advisory-database) का उपयोग करता है।

यह परियोजना आंशिक रूप से Trail of Bits द्वारा Google के समर्थन से बनाए रखी जाती है। यह Google या Trail of Bits का आधिकारिक उत्पाद नहीं है।

Index

• विशेषताएं
• स्थापना
  • तृतीय-पक्ष पैकेज
  • GitHub Actions
  • pre-commit समर्थन
• उपयोग
  • पर्यावरण चर
  • एक्ज़िट कोड
  • ड्राई रन
• उदाहरण
• समस्या निवारण
• सुझाव और ट्रिक्स
• सुरक्षा मॉडल
• लाइसेंसिंग
• योगदान
• आचार संहिता

विशेषताएं

• स्थानीय वातावरणों और आवश्यकता-शैली फ़ाइलों के ऑडिट के लिए समर्थन
• एकाधिक कमजोरी सेवाओं के लिए समर्थन (PyPI, OSV)
• SBOMs को CycloneDX XML या JSON में उत्सर्जित करने का समर्थन
• स्वचालित रूप से कमजोर निर्भरताओं को ठीक करने का समर्थन (--fix)
• मानवीय और मशीन-पठनीय आउटपुट प्रारूप (स्तंभीय, Markdown, JSON)
• आपके मौजूदा स्थानीय pip कैश का निर्बाध पुन: उपयोग

स्थापना

pip-audit को Python 3.10 या नए की आवश्यकता है, और इसे सीधे pip के माध्यम से स्थापित किया जा सकता है:```bash python -m pip install pip-audit

### तृतीय-पक्ष पैकेज

`pip-audit` के लिए कई **तृतीय-पक्ष** पैकेज हैं। नीचे दिए गए मैट्रिक्स और बैज उनमें से कुछ को सूचीबद्ध करते हैं:

[![पैकेजिंग स्थिति](https://repology.org/badge/vertical-allrepos/python:pip-audit.svg)](https://repology.org/project/python:pip-audit/versions)
[![पैकेजिंग स्थिति](https://repology.org/badge/vertical-allrepos/pip-audit.svg)](https://repology.org/project/pip-audit/versions)
[![कोंडा - प्लेटफ़ॉर्म](https://img.shields.io/conda/pn/conda-forge/pip-audit?logo=anaconda&style=flat)][#conda-forge-package]
[![कोंडा (केवल चैनल)](https://img.shields.io/conda/vn/conda-forge/pip-audit?logo=anaconda&style=flat&color=orange)][#conda-forge-package]

[#conda-forge-package]: https://anaconda.org/conda-forge/pip-audit

विशेष रूप से, `pip-audit` को `conda` के माध्यम से स्थापित किया जा सकता है:```bash
conda install -c conda-forge pip-audit

तृतीय-पक्ष पैकेज इस प्रोजेक्ट द्वारा सीधे समर्थित नहीं हैं। कृपया अधिक विस्तृत इंस्टॉलेशन मार्गदर्शन के लिए अपने पैकेज मैनेजर के दस्तावेज़ देखें।

GitHub Actions

pip-audit का एक आधिकारिक GitHub Action है!

आप इसे GitHub Marketplace से इंस्टॉल कर सकते हैं, या इसे अपने CI में मैन्युअल रूप से जोड़ सकते हैं:```yaml jobs: pip-audit: steps: - uses: pypa/[email protected] with: inputs: requirements.txt

See the
[एक्शन दस्तावेज़ीकरण](https://github.com/pypa/gh-action-pip-audit/blob/main/README.md)
अधिक विवरण और उपयोग उदाहरणों के लिए।

### `pre-commit` समर्थन

`pip-audit` में [`pre-commit`](https://pre-commit.com/) का समर्थन है।

उदाहरण के लिए, `pip-audit` का उपयोग करके `pre-commit` के माध्यम से एक आवश्यकताएँ फ़ाइल का ऑडिट करना:```yaml
  - repo: https://github.com/pypa/pip-audit
    rev: v2.10.1
    hooks:
      -   id: pip-audit
          args: ["-r", "requirements.txt"]

ci:
  # Leave pip-audit to only run locally and not in CI
  # pre-commit.ci does not allow network calls
  skip: [pip-audit]

नीचे दिए गए किसी भी pip-audit तर्क को पास किया जा सकता है।

उपयोग

आप pip-audit को एक स्वतंत्र प्रोग्राम के रूप में, या python -m के माध्यम से चला सकते हैं:```bash pip-audit --help python -m pip_audit --help

<!-- @begin-pip-audit-help@ -->```
usage: pip-audit [-h] [-V] [-l] [-r REQUIREMENT] [--locked] [-f FORMAT]
                 [-s SERVICE] [--osv-url OSV_URL] [-d] [-S]
                 [--desc [{on,off,auto}]] [--aliases [{on,off,auto}]]
                 [--cache-dir CACHE_DIR] [--progress-spinner {on,off}]
                 [--timeout TIMEOUT] [--path PATH] [-v] [--fix]
                 [--require-hashes] [--index-url INDEX_URL]
                 [--extra-index-url URL] [--skip-editable] [--no-deps]
                 [-o FILE] [--ignore-vuln ID] [--disable-pip]
                 [project_path]

audit the Python environment for dependencies with known vulnerabilities

positional arguments:
  project_path          audit a local Python project at the given path
                        (default: None)