Skip to content

kelsoncm/python-sc4net

Repository files navigation

sc4net

License Python QA Coverage Publish Docs pre-commit

Network helpers for HTTP(S) and FTP downloads, with convenience JSON and ZIP readers.

Installation

pip install sc4net

Security

Please report vulnerabilities according to SECURITY.md.

How to contribute

git clone git@github.com:kelsoncm/sc4.git ~/projetos/PESSOAL/sc4net
code ~/projetos/PESSOAL/sc4net

Pre-commit

This repository uses pre-commit to run quality checks before each commit and coverage regression checks before each push.

Setup:

python -m venv .venv
.venv\bin\activate
.\.venv\Scripts\Activate.ps1
pip install --upgrade pip uv
uv pip install --upgrade -e ".[dev]"
pre-commit install
pre-commit install --hook-type pre-push

Run manually:

pre-commit run --all-files
pre-commit run --hook-stage pre-push --all-files

Hooks:

  • pre-commit: black, isort, bandit, flake8 (with flake8-bandit)
  • pre-push:
    1. Runs pytest --cov=sc4net --cov-report=xml to produce coverage.xml
    2. pytest-coverage-gate reads coverage.xml, compares against .coverage-baseline (2 decimal places), blocks the push on regression and updates the baseline on improvement
  • GitHub Actions only: semgrep SAST

About

Network helpers for HTTP(S) and FTP downloads, with convenience JSON and ZIP readers.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Contributors

Languages