Repository Summary
| Checkout URI | https://github.com/pallets/click.git |
| VCS Type | git |
| VCS Version | 6.2 |
| Last Updated | 2015-11-27 |
| Dev Status | MAINTAINED |
| CI status | No Continuous Integration |
| Released | RELEASED |
| Tags | No category tags. |
| Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
README
$ click_
Click is a Python package for creating beautiful command line interfaces
in a composable way with as little code as necessary. It's the "Command
Line Interface Creation Kit". It's highly configurable but comes with
sensible defaults out of the box.
It aims to make the process of writing command line tools quick and fun
while also preventing any frustration caused by the inability to implement
an intended CLI API.
Click in three points:
- arbitrary nesting of commands
- automatic help page generation
- supports lazy loading of subcommands at runtime
Read the docs at http://click.pocoo.org/
This library is stable and active. Feedback is always welcome!
CONTRIBUTING
How to contribute to Click
Thanks for considering contributing to Click.
Support questions
Please, don't use the issue tracker for this. Check whether the Pocoo
IRC channel can help with your issue. If
your problem is not strictly Click-specific, #python on Freenode is
generally more active. StackOverflow is
also worth considering.
Reporting issues
- Under which versions of Python does this happen? This is even more important if your issue is encoding related.
- Under which versions of Click does this happen? Check if this issue is fixed in the repository.
Submitting patches
- Include tests if your patch is supposed to solve a bug, and explain clearly under which circumstances the bug happens. Make sure the test fails without your patch.
- Try to follow PEP8, but you may ignore the line-length-limit if following it would make the code uglier.
Running the testsuite
You probably want to set up a virtualenv.
The minimal requirement for running the testsuite is py.test. You can
install it with:
pip install pytest
Then you can run the testsuite with:
py.test
For a more isolated test environment, you can also install tox instead
of pytest. You can install it with:
pip install tox
The tox command will then run all tests against multiple combinations
of Python versions and dependency versions.
Repository Summary
| Checkout URI | https://github.com/pallets/click.git |
| VCS Type | git |
| VCS Version | 6.2 |
| Last Updated | 2015-11-27 |
| Dev Status | MAINTAINED |
| CI status | No Continuous Integration |
| Released | RELEASED |
| Tags | No category tags. |
| Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
README
$ click_
Click is a Python package for creating beautiful command line interfaces
in a composable way with as little code as necessary. It's the "Command
Line Interface Creation Kit". It's highly configurable but comes with
sensible defaults out of the box.
It aims to make the process of writing command line tools quick and fun
while also preventing any frustration caused by the inability to implement
an intended CLI API.
Click in three points:
- arbitrary nesting of commands
- automatic help page generation
- supports lazy loading of subcommands at runtime
Read the docs at http://click.pocoo.org/
This library is stable and active. Feedback is always welcome!
CONTRIBUTING
How to contribute to Click
Thanks for considering contributing to Click.
Support questions
Please, don't use the issue tracker for this. Check whether the Pocoo
IRC channel can help with your issue. If
your problem is not strictly Click-specific, #python on Freenode is
generally more active. StackOverflow is
also worth considering.
Reporting issues
- Under which versions of Python does this happen? This is even more important if your issue is encoding related.
- Under which versions of Click does this happen? Check if this issue is fixed in the repository.
Submitting patches
- Include tests if your patch is supposed to solve a bug, and explain clearly under which circumstances the bug happens. Make sure the test fails without your patch.
- Try to follow PEP8, but you may ignore the line-length-limit if following it would make the code uglier.
Running the testsuite
You probably want to set up a virtualenv.
The minimal requirement for running the testsuite is py.test. You can
install it with:
pip install pytest
Then you can run the testsuite with:
py.test
For a more isolated test environment, you can also install tox instead
of pytest. You can install it with:
pip install tox
The tox command will then run all tests against multiple combinations
of Python versions and dependency versions.
Repository Summary
| Checkout URI | https://github.com/pallets/click.git |
| VCS Type | git |
| VCS Version | 6.2 |
| Last Updated | 2015-11-27 |
| Dev Status | MAINTAINED |
| CI status | No Continuous Integration |
| Released | RELEASED |
| Tags | No category tags. |
| Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
README
$ click_
Click is a Python package for creating beautiful command line interfaces
in a composable way with as little code as necessary. It's the "Command
Line Interface Creation Kit". It's highly configurable but comes with
sensible defaults out of the box.
It aims to make the process of writing command line tools quick and fun
while also preventing any frustration caused by the inability to implement
an intended CLI API.
Click in three points:
- arbitrary nesting of commands
- automatic help page generation
- supports lazy loading of subcommands at runtime
Read the docs at http://click.pocoo.org/
This library is stable and active. Feedback is always welcome!
CONTRIBUTING
How to contribute to Click
Thanks for considering contributing to Click.
Support questions
Please, don't use the issue tracker for this. Check whether the Pocoo
IRC channel can help with your issue. If
your problem is not strictly Click-specific, #python on Freenode is
generally more active. StackOverflow is
also worth considering.
Reporting issues
- Under which versions of Python does this happen? This is even more important if your issue is encoding related.
- Under which versions of Click does this happen? Check if this issue is fixed in the repository.
Submitting patches
- Include tests if your patch is supposed to solve a bug, and explain clearly under which circumstances the bug happens. Make sure the test fails without your patch.
- Try to follow PEP8, but you may ignore the line-length-limit if following it would make the code uglier.
Running the testsuite
You probably want to set up a virtualenv.
The minimal requirement for running the testsuite is py.test. You can
install it with:
pip install pytest
Then you can run the testsuite with:
py.test
For a more isolated test environment, you can also install tox instead
of pytest. You can install it with:
pip install tox
The tox command will then run all tests against multiple combinations
of Python versions and dependency versions.