nyc-records-common 0.1.26

Common utilities for NYC Records Scraper

NYC Records Packages

Common utilities for NYC Records projects.

Prerequisites

• Python 3.11+
• pip
• virtualenv

Installation

1. Create and activate virtual environment:

Conda:

conda activate myenv

cd packages
python -m venv .venv
source .venv/bin/activate  # Linux/Mac

. .venv/Scripts/Activate # Powershell

2. Install dependencies:

pip install -r requirements/dev.txt
pip install -r requirements/prod.txt
pip install -e .

3. Install pre-commit hooks:

pre-commit install

Testing

pytest tests/ -v                  # Command line
pytest tests/ --cov=src          # With coverage

Code Formating

black src/ tests/                # Format code
isort src/ tests/                # Sort imports
flake8 src/ tests/              # Check style
mypy src/                       # Type checking
pytest tests/                   # Run tests
pylint --rcfile=.pylintrc src/nyc_records_common
pylint --rcfile=.pylintrc src/nyc_records_db