Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Housekeeper takes care of files.

Project Description

# Housekeeper [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url]

### Store, tag, fetch, and archive files with ease 🗃

Housekeeper is a tool that aims to provide:

  • a backend for storing versioned bundles of files
  • different interfaces (Python, CLI, REST) for fetching files based on tags
  • a way to backup and retrieve bundles from long-term storage

### Todo

  • [ ] re-implement the archive/encryption interface [@ingkebil]
  • [ ] handle clean up of expired bundles [@robinandeer]
  • [ ] expand the CLI with get command etc. [@robinandeer]

## Installation

Housekeeper written in Python 3.6+ and is available on the [Python Package Index][pypi] (PyPI).

`bash pip install housekeeper `

If you would like to install the latest development version:

`bash git clone cd housekeeper pip install --editable . `

## Documentation

### Command line interface

#### Config file

Housekeeper supports a very simple YAML config. The following options are supported:

`yaml --- database: mysql+pymysql:// root: /path/to/root/dir `

The root option is used to store files within the Housekeeper context.

#### Command: init

Setup (or reset) the database. It will simply setup all the tables in the database. You can reset an existing database by using the –reset option.

`bash housekeeper --database "sqlite:///hk.sqlite3" init Success! New tables: bundle, file, file_tag_link, tag, version `

#### Command: include

Include (hard-link) all files of an existing bundle version into Housekeeper and the root path.

`bash housekeeper myBundle `

This will only work if the bundle only has a single version which can be “imported”. If you want to import a specific version of a bundle you can use the –version option.


[travis-url]: [travis-image]: [coveralls-url]: [coveralls-image]:

Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download Files

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

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(103.3 kB) Copy SHA256 Hash SHA256
Wheel py2.py3 Sep 26, 2017
(40.9 kB) Copy SHA256 Hash SHA256
Source None Sep 26, 2017

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers