pyhoe - Top =========== :Authors: modocache :Version: |release| Overview ******** Like Ruby's `Hoe `_, pyhoe aims to help developers by providing a basic project skeleton. Projects created with pyhoe's default settings include the following: * A basic directory structure with templates for README, LICENSE, `setup.py `_, `.gitignore `_, and other ubiquitous project files. * A `virtualenv `_ for the new project. * Automated tests using `Nosy `_, which is built upon `nose `_. Mac OSX users will find a nose plugin called `Sneazr `_ to display Growl notifications on tests results. * `Tox `_, for testing across multiple Python environments. Quickstart ********** To create a new project directory with the default skeleton, install pyhoe and run the ``sow`` command. .. code-block:: bash $ pip install pyhoe $ pyhoe sow my_new_project See :ref:`commands` for details on all commands available). Report a Bug ************ Feel free to open an issue on `Github `_ if you notice something wrong with the program or this documentation, or if you think of a feature for pyhoe you think might be worth adding. I'll try to get back to you as quickly as possible. Contributions to the project are also very welcome! `Fork me! `_ Documentation Contents ********************** .. toctree:: :maxdepth: 2 :glob: installation commands Indices and tables ****************** * :ref:`genindex` * :ref:`search`