Manage application options
Project description
Shaper
Tool for render configurations from few templates/sources.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Installing
Install via pypi:
pip install shaper
Use cases
Aim of shaper - make configuration management easier with templating, DSL and CMDBs.
Step 1 - Convert existing project configurations to DSL
cd myproject
shaper read
We will get out.yml
file with DSL of our project configuration
out.yml
my-backend:
src:
main:
resources:
application-dev1.properties:
spring.cache.type: 'redis'
spring.redis.host: 'dev1.111111.0001.use1.cache.amazonaws.com'
spring.redis.port: '6379'
spring.redis.ssl: 'false'
spring.redis.ttl.minutes: '30'
spring.redis.database: '0'
spring.redis.available: 'true'
app.init.enabled: 'true'
app.email.support_address: 'support@my-domain.com'
app.email.default_from: 'no-replay@my-domain.com'
app.lock.provider: 'redis'
application-qa1.properties:
spring.cache.type: 'redis'
spring.redis.host: dev1.111111.0001.use1.cache.amazonaws.com
spring.redis.port: '6379'
spring.redis.ssl: 'false'
spring.redis.ttl.minutes: '30'
spring.redis.database: '0'
spring.redis.available: 'true'
app.init.enabled: 'true'
app.email.support_address: 'support@my-domain.com'
app.email.default_from: 'no-replay@my-domain.com'
app.lock.provider: 'redis'
application-prod1.properties:
spring.cache.type: 'redis'
spring.redis.host: dev1.111111.0001.use1.cache.amazonaws.com
spring.redis.port: '6379'
spring.redis.ssl: 'false'
spring.redis.ttl.minutes: '30'
spring.redis.database: '0'
spring.redis.available: 'true'
app.init.enabled: 'true'
app.email.support_address: 'support@my-domain.com'
app.email.default_from: 'no-replay@my-domain.com'
app.lock.provider: 'redis'
application.properties:
app.init.enabled: 'true'
Step 2 - Agregate common parameters with YAML anchor/alias
Using YAML specification let's rewrite duplicating data with anchors/aliases
out_refactored.yml
mappings.yml:
redis:
- host: &redis_dev_host 'dev.111111.0001.use1.cache.amazonaws.com'
db:
dev1: &redis_dev1_dbname 0
qa1: &redis_qa1_dbname 1
- host: &redis_prod_host 'prod.0000000.0001.use1.cache.amazonaws.com'
db:
prod1: &redis_prod1_dbname 0
common_properties: &common_properties
spring.cache.type: 'redis'
spring.redis.port: '6379'
spring.redis.ssl: 'false'
spring.redis.ttl.minutes: '30'
spring.redis.available: 'true'
app.init.enabled: 'true'
app.email.support_address: 'support@my-domain.com'
app.email.default_from: 'no-replay@my-domain.com'
app.lock.provider: 'redis'
my-backend:
src:
main:
resources:
application-dev1.properties:
<<: *common_properties
spring.redis.host: *redis_dev_host
spring.redis.database: *redis_dev1_dbname
application-qa1.properties:
<<: *common_properties
spring.redis.host: *redis_dev_host
spring.redis.database: *redis_qa1_dbname
application-prod1.properties:
<<: *common_properties
spring.redis.host: *redis_prod_host
spring.redis.database: *redis_prod1_dbname
application.properties:
app.init.enabled: 'true'
This datastructure after loads equal to previus version, but look much more pretty without duplicates parameters.
Step 3 - Write properties from CMDB
shaper write out_refactored.yml
Step 4 - Enjoy
Check diff with existing configuration, fix if something wrong and embed into your CD pipeline.
Running the tests
We are using tox to agregate all testing steps. Just run it in project repository. All merges runs tests in travis.
tox
Contributing
If you want to contribute to a project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.
How to make a clean pull request
Look for a project's contribution instructions. If there are any, follow them.
- Create a personal fork of the project on Github (howto).
- Clone the fork on your local machine. Your remote repo on Github is called
origin
. - Add the original repository as a remote called
upstream
. - If you created your fork a while ago be sure to pull upstream changes into your local repository.
- Create a new branch to work on! Branch from
develop
if it exists, else frommaster
. - Implement/fix your feature, comment your code.
- Follow the code style of the project, including indentation.
- If the project has tests run them!
- Write or adapt tests as needed.
- Add or change the documentation as needed.
- Squash your commits into a single commit with git's interactive rebase. Create a new branch if necessary.
- Push your branch to your fork on Github, the remote
origin
. - From your fork open a pull request in the correct branch. Target the project's
develop
branch if there is one, else go formaster
! - If the maintainer requests further changes just push them to your branch. The PR will be updated automatically.
- Once the pull request is approved and merged you can pull the changes from
upstream
to your local repo and delete your extra branch(es).
And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.
Versioning
We use versioneer for versioning. For the versions available, see the tags on this repository.
Authors
- Ivan Bogomazov - arno49
See also the list of contributors who participated in this project.
License
This project is licensed under the Apache 2.0 - see the LICENSE file for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file shaper-0.1.3.tar.gz
.
File metadata
- Download URL: shaper-0.1.3.tar.gz
- Upload date:
- Size: 35.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/2.7.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9dacf6b9c783b30f51232cf7c1b77b771010954097d6b3eb81a32ac6d205c85 |
|
MD5 | c77fa05e26b80b0de912b91a313e1a60 |
|
BLAKE2b-256 | 0cbfc275914e0258f077585b64746d79d18816bfd54af9df1c88323c4ec9e02f |
File details
Details for the file shaper-0.1.3-py2.py3-none-any.whl
.
File metadata
- Download URL: shaper-0.1.3-py2.py3-none-any.whl
- Upload date:
- Size: 21.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/2.7.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ecc8f8b8b85a3112ebaaba898db87583bea5793b292bcecf87c2b8ebf85cba5 |
|
MD5 | ed973b4489653f9c2b21ce9130e66d3e |
|
BLAKE2b-256 | 6cc70cef0be074a5cb3a8292c437e41c5fdf0a26930b48932c37040fc7717f21 |