Skip to main content

My personal little ML engineering library.

Project description

Readme

PyPI - Version PyPI - Python Version Tests Codecov Read the Docs PyPI - License

Black pre-commit

My personal little ML engineering library.

Features

Quickstart for development

Notice

This project uses groups for extras dependencies, which is currently a PRERELEASE feature (slated for 1.2). Assuming poetry was installed the recommended way (see below), this can be done using:

curl -sSL https://install.python-poetry.org/ | python -
poetry self update --preview 1.2.0a2

Setting up for local development

Assumes a "modern" version of Ubuntu (guide written under Ubuntu 20.04.2 LTS) with basic dev dependencies installed.

This project uses groups for extras dependencies. If installation fails, make sure that output from poetry --version is 1.2.0 or greater.

To get started, run the following commands:

  1. Installing the latest version of Poetry

    curl -sSL https://install.python-poetry.org/ | python -
    
  2. Installing the project

    git clone git@github.com:rsundqvist/rics.git
    cd rics
    poetry install --with dev-extras
    inv install-hooks
    ./run-invocations
    

    The last step is optional, but serves to verify that the project is ready-to-run.

Registering the project on Codecov

Probably only for forking?

curl -Os https://uploader.codecov.io/latest/linux/codecov
chmod +x codecov

Visit https://app.codecov.io and log in, follow instructions to link the repo and get a token for private repos.

CODECOV_TOKEN="<from-the-website>"
inv coverage --fmt=xml
./codecov -t ${CODECOV_TOKEN}

Credits

This package was created with Cookiecutter and the fedejaure/cookiecutter-modern-pypackage project template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rics-0.5.0.tar.gz (44.3 kB view hashes)

Uploaded Source

Built Distribution

rics-0.5.0-py3-none-any.whl (61.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page