Skip to main content

should make things more reproducible

Project description

DBIS Pipeline

This pipline can be used to run analyses in a structured way.

Usage

the user writes a minimal configuration file which contains only the following information:

  • "how do I get the data?", by providing a dataloader
  • "what to do with the data?", by providing a scikit pipeline
  • "what to do with the result?", by providing output handlers.

Please have a look at the examples for more information.

Requirements

pipenv

everything else should be installed by pipenv.

Installation

  1. Create a fresh directory.
  2. In that directory, call pipenv install dbispipeline This call will install a virtual environment as well as all dependencies.
  3. Write your configuration(s)
  4. call pipenv run python -m dbispipeline <yourconfigurationfile.py>

Enjoy!

Configuration

The framework look in multiple directories for its configuration files.

  • /usr/local/etc/dbispipeline.ini used for system wide default.
  • $HOME/.config/dbispipeline.ini used for user specific configurations.
  • ./dbispipeline.ini for project sepcifig configurations.

And example configuration file looks like this:

[database]

# url to your postgres database
host = your.personal.database

# your database user name
user = user

# port of your postgres database, default = 5432
# port = 5432

# password of your database user
password = <secure-password>

# database to use
database = pipelineresults

# table to be used
result_table = my_super_awesome_results

[project]
# this will be stored in the database
name = dbispipeline-test

[mail]
# email address to use as sender
sender = botname@yourserver.com

# recipient. This should probably be set on a home-directory-basis.
recipient = you@yourserver.com

# smtp server address to use
smtp_server = smtp.yourserver.com

# use smtp authentication, default = no
# authenticate = no

# username for smtp authentication, required if authenticate = yes
# username = foo

# password for smtp authentication, required if authenticate = yes
# password = bar

# port to use for smtp server connection, default = 465
# port = 465

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

dbispipeline-0.3.1.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

dbispipeline-0.3.1-py3-none-any.whl (42.7 kB view details)

Uploaded Python 3

File details

Details for the file dbispipeline-0.3.1.tar.gz.

File metadata

  • Download URL: dbispipeline-0.3.1.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.5

File hashes

Hashes for dbispipeline-0.3.1.tar.gz
Algorithm Hash digest
SHA256 f6426412d6282474ec736fd93c86894066e1329f9bd7f7a37f1a3fc6ed608512
MD5 e604cb5b80215ea1a0ea0d617a74d2ba
BLAKE2b-256 ce445764ddc67b590c472f5dbfa6fa3f87655ae1ff47e5b23bbb66724a170482

See more details on using hashes here.

File details

Details for the file dbispipeline-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: dbispipeline-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 42.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.5

File hashes

Hashes for dbispipeline-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d9a9ae19e106874e23a3c753f2df2a17733d9ee7819ee909e8a93d8d78342d71
MD5 97246d836f08b4c59f2a349657b7cfc0
BLAKE2b-256 9322e5432f37e361fc7ea30a21d6ea5f8b38a8750ea39b9d4414c962731b52f4

See more details on using hashes here.

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