Skip to main content

This package creates a framework for python packages to be built.

Project description

# 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/*
```





Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

python_module_starter-1.0.0-py2.py3-none-any.whl (6.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file python_module_starter-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for python_module_starter-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f2a2a20c4fcb5bbb5243b9072b58b7f8969d6a5bd332951ca765b22d57a4cc4f
MD5 21c397bd66254a3084911f91fd33c344
BLAKE2b-256 67ef2384a187a467713c2841edd5d3bf322647911d20c0be040cd5214f71cfdc

See more details on using hashes here.

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