Code Monkey home page Code Monkey logo

modern-package-template's Introduction

modern-package-template

modern-package-template is a PasteScript template to create an initial layout for your Python projects using modern tools and practices followed in the Python community. Thus, your projects will have the following characteristics:

  1. Use Distribute instead of setuptools as the BDFL himself supports it.
  2. Buildout support, though you are not required to make use of it.
  3. README.rst and NEWS.rst automatically included in your package metadata as long_description, thus making them appear in the PyPI page for your project (example).
  4. Automatic script (or .exe) creation using Distribute's "entry points".

Here is a sample project created using modern-package-template.

Getting started

First install modern-package-template using PyPM or pip:

$ pypm install modern-package-template

OR

$ pip install modern-package-template

To create a Python project called "helloworld", run the following command in your terminal:

$ paster create -t modern_package helloworld

You can also, optionally, create namespace packages:

$ paster create -t modern_package my.new.package package=my.new.package

Once you create the project layout, the very first thing you must do is to review the contents of README.rst and edit it accordingly.

Credits

Source code is derived from the advanced_package template - which is also licensed under GPLv3.

modern-package-template's People

Contributors

alanfranz avatar

Stargazers

 avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.