badele / python-project-template

A Python project template

Since one year, i create more and more python projects. That for this reason i have decided create a Python template. This template is ready for create a Python project with:

• Setuptools for push python code to Pypi site
• Unittest for unit testing
• Pep8 for source code checking
• Coverage for test coverage sources

Howto use

Here the steps for create a new python project

1. Clone the python-project-template and replace projectname by your project name you want:

   cd your_root_projects_directories
   git clone https://github.com/badele/python-project-template.git projectname
   cd projectname
   

2. Edit the PROJECT variables in the initproject.py and run:

   ./initproject.py
   rm ./initproject.py
   

3. Verify the personal text in this files:

   README.rst
   LICENSE
   CHANGELOG.txt
   setup.py
   

4. Reinit git repository:

   rm -rf .git && git init
   

5. (Optional) install virtualenv:

   mkvirtualenv --no-site-packages -p /usr/bin/python2.7 env_projectname
   

6. (Optional) Run the minimal test:

   pip install -r requirements/test.txt
   make test
   

7. (Optional) Test minimal application:

   make install
   projectname -h