yehua 0.0.2

A command line tool to provide a default scaffolding for a python package.

Introduction

• Are you tired of writing up setup.py files by hand? Have you ever wondered why pypi displays raw rst file for your README?

• When you add a new library to the collection of your organization, how would you make sure the static information are the same as others?

• How would you update static information across all packages of your organisation? For example, one line change in your company’s profile. Copy and paste? If yes, you still live in 20th century.

yehua is a command line tool to provide a default scaffolding for a python package. It create a blank python package that is usable and ready to push to github.

Future updates on your organisation’s specific static information can be instantly applies the update accurately using moban . What’s more, the python package is github and travis-ci friendly.

What’s more, you can provide your own python package templates and your own yehua file to customize yehua to meet your own needs.

Installation

You can install it via pip:

$ pip install yehua

or clone it and install it:

$ git clone http://github.com/chfw/yehua.git
$ cd yehua
$ python setup.py install

Usage

Please note, since version 0.0.2, the command line is shortened. Due to time constaints, the demo video uses yehua still.

Simply type in and you are taken care of:

$ yh

It will do these for you:

1. Consult you on your project static information which can update as many as you want to.

2. Create the Python package folder structure

3. Initialize the package as git project

You will simply need to commit it after you will have reviewed the generated files.

Tutorial

Let’s make a python command line utility using yehua. The command will be hello and it prints world. You will need to issue:

$ pip install yehua

before proceeding.

Step 1 Let’s launch yehua

Step 2 Fill-in the meta data for your project

At the end, yehua generates a folder named ‘hello’, which contains all necessary files for

1. installing it as a package

2. testing via nose

3. sharing it on github

4. configuring travis via github

Step 3 Inflates the meta data

Let’s change to ‘hello’ directory

All meta data is inflated via `moban`_ automatically The templates come from setupmobans Run moban. It inflates the all meta data.

Why is moban involved here? It helps reduce duplicated meta data when your project grows. For example, yehua had this tutorial in README and in sphinx documentation. I wrote it in one file and moban copies it to both places. What’s more, it helps further when the number of your project grows. For example, pyexcel project has dozens of sub projects. I wrote most of the generic documentation in pyexcel commons and moban copies them across all sub projects.

Step 4 Start coding

Let’s write up the actual code in hello/main.py

Put in just a main() function and save it.

Why is it enough? yehua generates a command utility python and it has pre-wired to invoke hello.main.main() function. You can find it out in setup.py.

Step 5 Install it

Now all is done. Let’s install it

Step 6 Run it

Let’s run it

All done.

Step 7 push to github

Suppose you are happy with everything. Please do the following to push it to your github:

$ git init
$ git add *
$ git add .gitignore .moban.d/ .moban.yml .travis.yml
$ git commit -am ":sparkle: initial commit"

Then create your project repository in github and do these to push it out:

$ git remote add origin https://github.com/chfw/hello.git
$ git push origin master

You can find the hello project on github.

Step 8 enable travis

The generated project already has .travis.yml file. What you will need to do is to register with travis.org if you have not done so. And then go to travis and activate your project.

License

NEW BSD License

Change log

0.0.2 - 15/10/2017

Added

1. Automatically inflate project meta data. One yehua command and typing a few questions are required before a complete project scaffolding

2. Automatically obtain setupmobans repo for previous task.

3. Automatically initialize package as git project and add all project files for the user to commit

Removed

1. Built-in template files are off-loaded to setupmobans, which are more frequently updated.

0.0.1 - 02/07/2017

Initial release.