Skip to content

ulphidius/template_python_project

Repository files navigation

template_python_project

master Coverage Status

This is a sample application for test deployment on pypi. You can use it as reference but i don't recommend its use.

Install

For install this app you need to have setuptools in your python environment.

# We assume that pip is install and is connected to python 3
pip install --editable .
# OR
pip install template-python-project

# For install the project with development tool
pip install --editable ".[development]"

Use

For further information use --help option.

template-python-project compute --compute-type MUL --first 1 --second 2
template-python-project concat --first hello --second world

Linter

This application use the linter pylint. pylint is installed with development tools.

# For execute tests we assume that the development dependencies are install
pylint template_python_project

Test

This applciation use the test framework pytest. pytest is installed with development tools.

# For execute tests we assume that the development dependencies are install
pytest ./test

Deploy

You need to install twine for deploy on pypi. You need to install wheel to have a valid binary for deployment.

# We assume that pip is install and is connected to python 3
pip install twine
pip install wheel

After the installation of the dependencies. You need to use setup.py for build the project. You need to use the twine command for the deployment.

# We assume that pip is install and is connected to python 3
# We assume that python is install and is a symbolic link to python 3
python setup.py bdist_wheel
twine upload dist/*

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages