Metadata-Version: 2.0
Name: python-module-starter
Version: 1.0.0
Summary: This package creates a framework for python packages to be built.
Home-page: https://github.com/wuhaifengdhu/python-module-starter
Author: Wu Haifeng
Author-email: wuhaifengdhu@163.com
License: UNKNOWN
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Requires-Dist: six (>=1.11.0)

# pypi starter project

[![Build Status](https://travis-ci.org/wuhaifengdhu/python-module-starter.svg?branch=master)](https://travis-ci.org/wuhaifengdhu/python-module-starter)
[![codecov](https://codecov.io/gh/wuhaifengdhu/python-module-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/wuhaifengdhu/python-module-starter)

This is a template repository that you can use to quickly create a python application that can be built, tested, and released as an internal python module.

## Setting up a new repository from this template
**Create a directory and pull all the files in this template into it**

```bash
mkdir new_repo_name
cd new_repo_name
git init
git pull https://github.com/wuhaifengdhu/python-module-starter.git
```

## Build

*Linux*

```bash
virtualenv env
. env/bin/activate
pip install -e .
```

*Windows*
```bash
virtualenv env
env\Scripts\activate
pip install -e .
```

## Tox Tests and Build the Wheels

```
pip install -r requirements-build.txt
# run the python tests
tox -r
```

## upload to pypi
* Register your account in ![pypi](https://pypi.org/)
* Create file .pypirc in your home folder with 600.    
```[distutils]
index-servers =
  pypi
  pypitest

[pypi]
repository=https://upload.pypi.org/legacy/
username=your_username
password=your_password

[pypitest]
repository=https://test.pypi.org/legacy/
username=your_username
password=your_password
``` 
* Upload your repository
```
python setup.py bdist_wheel --universal
twine upload dist/*
```        





