Skip to main content

Set of CLI commands to help manage a project

Project description

peltak is a command line tool to automate a lot of project related tasks. The tool should only wrap up existing project tools and not try to replace them. Also when implementing new commands lean towards just calling external tools rather than interfacing through the API. This way the commands implementation should resemble shell scripts in their structure and also serve as a reference on how to call the respective 3rd party tool without the use of peltak. Docker commands are a good example here as docker has a great python support but reading through the command implementation you know exactly what to do to do it manually and you probably don’t even have to know python.

WARNING: Pre release state: The project is mainly lacking good documentation for all commands. There are a few that are well documented from a user standpoint but not enough examples to fully understand all commands without looking at the source code. The testing could be improved as well as now it’s mostly manually tested by being used in almost all my private projects and all of their CIs.

Note

The CircleCI builds can be found here

Installation

$ pip install peltak

Contributing

Setting up development repo

$ git clone git@github.com:novopl/peltak.git
$ cd peltak
$ virtualenv env
$ source ./env/bin/activate
$ pip install -r requirements.txt -r ops/devrequirements.txt
$ peltak git add-hooks

Running tests

Config: The types of tests are defined in pelconf.py and the pytest configuration is defined in ops/tools/pytest.ini.

$ peltak test

Linting

Config: The list of locations to lint is defined in pelconf.py and the linters configuration is defined in ops/tools/{pylint,pep8}.ini.

$ peltak lint

Generating docs

Config: The list of documented files and general configuration is in pelconf.py and the Sphinx configuration is defined in docs/conf.py.

$ peltak docs

Project details


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
peltak-0.15.tar.gz (23.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page