Welcome to YamJam’s documentation!

keeping private data out of source control and applying DRY principles for resource information since 2009

Overview

is a multi-project, shared, yaml based configuration system. It is also a mechanism to keep secret/private data from leaking out to source control systems (i.e. git, bitbucket, svn, et al) by factoring out sensitive data from your commits.

Tested on Python 2.7, 3.2, 3.3, 3.4

Installation

pip install yamjam
mkdir ~/.yamjam
touch ~/.yamjam/config.yaml
chmod -R go-rwx ~/.yamjam

Now open ~/.yamjam/config.yaml with your editor of choice and start factoring out your sensitive information. Organizing your config.yaml

What Next?

• License: BSD
• Documentation
• Project
• Contributing
• Change Log

We work so well with Django, you’d think we should spell our name YamDjam

Contents:

• Organizing your config.yaml
  • Location of config.yaml
  • Django Specific
  • Base config only
  • Structure of config.yaml
  • Example
  • yjlint - linting for your config.yaml
  • Logical Alignment
  • Merging Config Data
• Django Usage
  • Django Scenario - Sensitive Data
  • Django Scenario - Differing Settings for Development/ Staging/ and Production
• DRY Scenario
  • Multiple apps that access common resources
  • Advanced DRY usage
• Frequently asked questions
  • Why yaml for persistence?
  • How do I write to my config?
  • Security
  • What is so special about YamJam, I could roll my own
  • What’s up with the name, YamJam?
• Contributing
  • Code
  • Bug Reports
  • Get the Word Out
• Release Procedures
  • Full Release
  • Build Dist Only
  • Install and test dist locally
• Change Log
  • v0.2.0
  • v0.1.8
  • v0.1.7
  • v0.1.6
  • v0.1.3 - v0.1.5
  • v0.1.2
  • v0.1.0 - v.0.1.1
• Authors

Indices and tables

• Index
• Module Index
• Search Page