Changes between Initial Version and Version 1 of ProjectTemplates


Ignore:
Timestamp:
12/17/2013 04:17:07 PM (6 years ago)
Author:
carndt
Comment:

Created

Legend:

Unmodified
Added
Removed
Modified
  • ProjectTemplates

    v1 v1  
     1= !ProjectTemplates = 
     2 
     3This Python package provides project templates for use with [http://pythonpaste.org/script/ PasteScript]. 
     4Currently there is one template for a basic Python package project. A project created from this template  
     5will be ready to be distributed via [http://docs.python.org/2/distutils/index.html distutils] and  
     6[http://python.org/pypi/setuptools setuptools] to the [http://python.org/pypi/ Python Package Index (PyPI)]. 
     7 
     8== Quicklinks == 
     9 
     10 * [source:/projects/project-templates Browse Git source code repository] 
     11 * Clone Git repository: 
     12 
     13{{{ 
     14git clone https://chrisarndt.de/project-templates.git 
     15}}} 
     16 
     17== Installation == 
     18 
     19{{{ 
     20$ git clone https://chrisarndt.de/git/project-templates.git 
     21$ cd project-templates 
     22$ [sudo] python setup.py install 
     23}}} 
     24 
     25'''Note:''' Unfortunately, !PasteScript still only works with Python 2, so you'll need 
     26Python 2 installed to install & run it. The projects created with the template provided  
     27here, however, will be Python 3 compatible (unless your own code introduces incompatibilities). 
     28 
     29 
     30== How to use == 
     31 
     32{{{ 
     33$ paster create -t chrisarndt MyNewProject 
     34}}} 
     35 
     36This will prompt for some basic info about the project (version number, 
     37keywords author, email and license) and then will create a directory with the 
     38given project name in the current directory, which contains all the files for a 
     39setuptools-ready Python project. The package name will be derived from the 
     40project name by lowercasing it and replacing dashes with underscores. 
     41 
     42You can customize the distribution meta-data for your new project further by 
     43editing the file `release.py` in the package directory. The module docstring 
     44of this file will be the project description visible on its PyPI page after 
     45registering it. When you're ready to release the first version of your 
     46distribution, just run the following command within your project directory:: 
     47 
     48{{{ 
     49$ python setup.py release_upload 
     50}}} 
     51 
     52(you'll need an account on PyPI for registering and uploading your package) 
     53 
     54which will create source distribution packages of your project, register the 
     55release on PyPI and upload the source packages to it. The `release_upload` 
     56command is an alias defined in the `setup.cfg` file of your project. 
     57There is also an alias `release`, which will just create the source packages 
     58without registering the release, so you can test them locally first.