Welcome to lunchtime’s documentation!¶
Ignore all terminal commands while it’s lunchtime!
lunchtime¶
Ignore all terminal commands while it’s lunchtime!
- Free software: MIT license
- Documentation: https://lunchtime.readthedocs.io
- GitHub repo: https://github.com/robertopreste/lunchtime
Features¶
This is a simple command-line application that will ignore all terminal commands while it’s running.
Background¶
Most of us have a boss or supervisor that usually walks in right at lunch time, asking for updates on the job. This is quite annoying, and often things end up with people starving while they show their results to the boss.
For this reason I decided to build this tool, so you can pretend your computer is not working and hopefully convince your boss to leave and have lunch at a decent time!
PLEASE NOTE: use at your own risk! Use this tool wisely, as it might lead to unexpected consequences (for your job) if misused.
Installation¶
It is possible to install lunchtime using pip:
pip install lunchtime
Both Python2 and Python3 are supported.
Please refer to the Installation section of the documentation for more details.
Usage¶
Simply launch lunchtime and enjoy a broken terminal:
$ lunchtime
A new clean terminal will open, where you can type your commands and no response will be produced. The lunchtime will stop when the exit command is issued.
If you want to astonish your boss even more, you can use the --crazy option:
$ lunchtime --crazy
In this case, a weird string will be returned after each command!
Please refer to the Usage section of the documentation for more details.
Credits¶
This package was created with Cookiecutter and the cc-pypackage project template.
Installation¶
Stable release¶
To install lunchtime, run this command in your terminal:
$ pip install lunchtime
This is the preferred method to install lunchtime, as it will always install the most recent stable release.
If you don’t have pip installed, this Python installation guide can guide you through the process.
From sources¶
The sources for lunchtime can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/robertopreste/lunchtime
Or download the tarball:
$ curl -OL https://github.com/robertopreste/lunchtime/tarball/master
Once you have a copy of the source, you can install it with:
$ python setup.py install
Usage¶
Simply launch lunchtime and enjoy a broken terminal:
$ lunchtime
A new clean terminal will open, where you can type your commands and no response will be produced. The lunchtime will stop when the exit command is issued.
If you want to astonish your boss even more, you can use the --crazy option:
$ lunchtime --crazy
# or also
$ lunchtime -c
In this case, a weird string will be returned after each command!
When starting and stopping lunchtime, a simple message is printed and a 2-second sleep is performed. If you’re in a hurry because your boss is approaching, you can use the --silent option to skip these and jump right into the (broken) terminal:
$ lunchtime --silent
# or also
$ lunchtime -s
As usual, type exit to go back to your functioning terminal.
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/robertopreste/lunchtime/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Write Documentation¶
lunchtime could always use more documentation, whether as part of the official lunchtime docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/robertopreste/lunchtime/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up lunchtime for local development.
Fork the lunchtime repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/lunchtime.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv lunchtime $ cd lunchtime/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 lunchtime tests $ python setup.py test or py.test $ tox
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/robertopreste/lunchtime/pull_requests and make sure that the tests pass for all supported Python versions.
Deploying¶
A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:
$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags
Travis will then deploy to PyPI if tests pass.
Credits¶
Development Lead¶
- Roberto Preste <robertopreste@gmail.com>
Contributors¶
None yet. Why not be the first?