Welcome to Lancet’s documentation!¶
Installation¶
TL;DR¶
brew update
brew install python3 libgit2 --with-libssh2
curl https://raw.githubusercontent.com/mitsuhiko/pipsi/master/get-pipsi.py | python
~/.local/venvs/pipsi/bin/pip install -U https://github.com/mitsuhiko/pipsi/archive/master.zip
pipsi install --python=$(which python3) lancet
Requirements¶
The following carefully crafted software packages are needed to install
lancet:
- Python 3 (
brew install python3) - libgit2 with libssh2 support (
brew install libgit2 --with-libssh2) - pipsi (optional, see below)
Required Python packages are automatically installed.
pipsi-dev¶
It is suggested to use pipsi to install lancet for production use.
pipsi creates and manages isolated virtual environments for specific
Python packages, and then exposes the provided binaries in the global
$PATH.
For more information about pipsi, please check out it’s homepage.
At the time of writing, the latest release of pipsi (0.8) does not support
Python 3. In order to install lancet, we need to install the development
version of pipsi. This can be achieved with the following commands:
Install the current stable release:
curl https://raw.githubusercontent.com/mitsuhiko/pipsi/master/get-pipsi.py | python
Upgrade to the latest development release:
~/.local/venvs/pipsi/bin/pip install -U https://github.com/mitsuhiko/pipsi/archive/master.zip
Installation¶
lancet can be installed as any other Python package (pip,
easy_install, …), but it is recommended to use pipsi.
If all the needed dependencies are installed on your system, and you have a
Python 3-compatible version of pipsi, then installing is just a matter of
running the following command:
pipsi install --python=$(which python3) lancet
Upgrading from a previous version¶
If you used pipsi to install lancet, you can upgrade to the latest
version of lancet by running:
pipsi upgrade lancet
Upgrading a package installed in editable mode¶
When installing the package in editable mode, using pip’s -e flag, the
distribution can be updated with the following command:
~/.local/venvs/lancet/bin/pip install -e path/to/the/project
Introduction¶
From http://en.wikipedia.org/wiki/Scalpel:
A scalpel, or lancet, is a small and extremely sharp bladed instrument used for surgery, anatomical dissection, and various arts and crafts (called a hobby knife).
Lancet is a command line utility to streamline the various activities related to the development and maintenance of a software package.
Features¶
- Start tasks (create branch, set correct issue status/assignee, start linked harvest timer);
- Suspend tasks (pause harvest timer, set issue status);
- Resume tasks (resume timer, set issue status);
- Rapidly open issue tracker task page.
See http://cl.ly/0u28140B1Y15 for a short visual demo.
TODOs¶
See the issue tracker for more details.