Skip to main content

Creates a new python package from basic template

Project description

Pypkg Generator

PyPI version CircleCI

Creates a simple template of a python package.

Creates a basic template of python package with a simple command line tool.


OS X & Linux:


$ pip3 install pypkg-generator

from the source

$ git clone
$ cd pypkg-generator
$ python3 install

Usage example

Open a terminal and type:

$ pkg-generator --help

And it'll display:

  -n, --name TEXT       The name of the package
  -p, --path TEXT       The path where the package will be created
  --tests / --no-tests  Create test suite directory or not, created by default
  --help                Show this message and exit.

There are many options for customization, you can decide what file will be created or not.

You must assign a name, or the project will be name forgotten_name.

$ pkg-generator --name my-awesome-project

You can explicitly pass a path, otherwise, the project will be created in the current directory.

$ pkg-generator --name my-awesome-project --path /home/user/Documents/

Development setup

This project uses pipenv for dependecy resolution. It's a kind of mix between pip and virtualenv. Follow the next instructions to setup the development enviroment.

$ git clone
$ cd pypkg-generator
$ pipenv shell
$ pip3 install -e .

To run the test-suite, inside the pypkg-generator directory:

$ pytest -vv test/


Daniel Omar Vergara Pérez –


  1. Fork it (
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

Project details

Download files

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

Files for pypkg-generator, version 0.5.0
Filename, size File type Python version Upload date Hashes
Filename, size pypkg_generator-0.5.0-py3-none-any.whl (6.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pypkg-generator-0.5.0.tar.gz (4.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page