click-boilerplate

Published:

View on Github

click-boilerplate

Build Status License Coverage

Python boilerplate project for creating sophisticated command line applications using the Click library

Features

  • Basic fully functional cli
  • Sample tests with nose
  • Travis CI integration
  • Both Python 2 and 3 compliant
  • Test coverage
  • Cool README boilerplate too

How to use

  • Fork this repository.
  • Clone this repo.
  • Change the name of the project to whatever you want.
  • Sign up on codecov and travis-ci.
  • Turn on detection for builds for this repo in travis.
  • Push and it should run build and generate coverage report.

TODO

  • Create a cookiecutter template out of this.
  • add some sophisticated commands as examples
  • add examples of some advanced functionalities in click, like using contexts, custom command groups etc.

LICENSE

MIT License

Copyright (c) 2018 Man Parvesh Singh Randhawa

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Leave a Comment