Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

A framework to create simple, interactive command line tools.

Project Description

A framework to create simple, interactive command line tools.

Example

A basic Hello World example

>>> import navigator
>>> nav = navigator.Navigator(intro="Welcome")
>>> @nav.route('Hello World', "A simple Hello World")
>>> def hello_world():
>>>     navigator.ui.text_success("Hello World!")
>>> nav.run()
Welcome
0 - quit
1 - Hello World - A simple Hello World
What do you want to do?

You can then select the option you would like to take. Entering ‘1’ call the hello_world function.

Navigator also includes prompts for user input

>>> @nav.route('Hello Name', "A more advanced Hello World")
>>> def hello_name():
>>>     name = navigator.ui.prompt("What is your name?")
>>>     navigator.ui.text_success("Hello {}!".format(name))

There are more complete examples in the examples directory.

How to Install

Navigator can be install from pypi using pip

pip install navigator

Python Support and Versioning

Navigator is currently tested against python 2.7, 3.2, 3.3, 3.4 and 3.5.

Navigator follows SemVar as such the Public API should not be considered stable until version 1.0.0.

Testing

You can run the test suite locally by running:

python test.py

This requires that ‘mock’ is installed. In addition all tests are run automatically on TravisCI.

To Do List

  • Complete README (examples, basic how to)
  • Better Comments
  • Add more Documentation (doc strings and documentation)
  • More complete test coverage and better tests
Release History

Release History

This version
History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
Navigator-0.2.2.tar.gz (5.5 kB) Copy SHA256 Checksum SHA256 Source Oct 22, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting