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.5.tar.gz (29.4 kB view details)

Uploaded Source

Built Distribution

dbispipeline-0.3.5-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dbispipeline-0.3.5.tar.gz
  • Upload date:
  • Size: 29.4 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.5.tar.gz
Algorithm Hash digest
SHA256 aae2cf9b14c67aaa2c10b6bdbf29c05797dd66752d964dd9459f11a9da8023cd
MD5 3b5b9379f33549c8151ddf057d1aaa43
BLAKE2b-256 da5b21d2216a1c0ce20d2eca3037e84d3b55d4de345e1e0aae30a22c3c9c77ef

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dbispipeline-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 44.6 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0516bce80f1c195a8123d0fb88e77fe582a2474fd94b2b3a3d5a620578d4e0c1
MD5 7863a1d33e33ced3ea79d39b819d178b
BLAKE2b-256 f4ce069f68d1c0392e0702d812d8ecfd2851dfcb4358e4975300daed53f5b4fa

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