Skip to main content

Python3 project layout generator

Project description

Generates the structure needed for a Python 3 project. Includes helpers for licenses and testing frameworks.

Installation

To install this software:

$ pip install lemming

Usage

The first time that you run lemming, you should execute the following:

$ lemming config

it’ll write .lemming.yml to your $HOME directory, which you can edit to automatically populate templates with your details for all future runs.

That file looks as follows:

---
lemming:
  author: Paul Stevens
  author_email: no-reply@xnode.co.za
  license:
    type: MIT

To use lemming to generate a project:

$ lemming <project_name>

This obviously means that you can never name a project config

The default license is the MIT license (rude, but this is the one that I use the most.) The other two choices are:

  • Apache 2.0

  • BSD 2-clause license

To select the APACHE license for your project:

$ lemming testprog --license apache

To select the BSD 2-clause license for your project:

$ lemming testprog --license bsd

Note

Currently supported licenses are:

  • MIT (default)

  • Apache 2.0

  • BSD 2-clause license

License

Licensed under the MIT License. See LICENSE for details.

Project details


Download files

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

Source Distribution

lemming-0.1.1.tar.gz (12.2 kB view hashes)

Uploaded Source

Built Distribution

lemming-0.1.1-py3-none-any.whl (21.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page