regressout 0.0.1

Regress Out Covariates

Regress Out Covariates (WIP)

TODOs: Configuring this template

Create a Netlify site for your repository, then turn off automatic builds in Netlify settings.

Add these CI secrets: PYPI_API_TOKEN, NETLIFY_AUTH_TOKEN (Netlify user settings - personal access tokens), DEV_NETLIFY_SITE_ID, PROD_NETLIFY_SITE_ID (API ID from Netlify site settings)

Set up Codecov at TODO

Overview

Installation

pip install regressout

Usage

Development

Submit PRs against develop branch, then make a release pull request to master.

# Optional: set up a pyenv virtualenv
pyenv virtualenv 3.9 regressout-3.9
echo "regressout-3.9" > .python-version
pyenv version

# Install requirements
pip install --upgrade pip wheel
pip install -r requirements_dev.txt

# Install local package
pip install -e .

# Install pre-commit
pre-commit install

# Run tests
make test

# Run lint
make lint

# bump version before submitting a PR against master (all master commits are deployed)
bump2version patch # possible: major / minor / patch

# also ensure CHANGELOG.md updated

Changelog

0.0.1

• First release on PyPI.