1+ [ ![ Build Status] ( https://travis-ci.org/essembeh/python-helloworld.svg?branch=master )] ( https://travis-ci.org/essembeh/python-helloworld )
2+ ![ Github] ( https://img.shields.io/github/tag/essembeh/python-helloworld.svg )
3+ ![ PyPi] ( https://img.shields.io/pypi/v/python-helloworld.svg )
4+ ![ Python] ( https://img.shields.io/pypi/pyversions/python-helloworld.svg )
5+
6+
17# helloworld
28
39This is just a sample helloworld project which aims to provide some good (at least not so bad) praticies to start a new project.
@@ -7,38 +13,48 @@ Basically, you can clone this repository and run `sed -i 's/helloworld/YOURPROJE
713
814# Install
915
10- This project uses [ Poetry] ( https://python-poetry.org ) , ensure you have * Poetry* installed
16+ Install the latest release from [ PyPI] ( https://pypi.org/python-helloworld )
17+ ``` sh
18+ $ pip3 install --user -U python-helloworld
19+ $ helloworld --help
20+ ```
21+
22+ Install the latest version from the sources:
23+
24+ > This project uses [ Poetry] ( https://python-poetry.org ) , ensure you have * Poetry* installed
1125
1226``` sh
1327$ pip3 install --user -U poetry
28+ $ pip3 install --user git+https://github.com/essembeh/python-helloworld
29+ $ helloworld --help
1430```
1531
32+ Install from the source
1633Clone the project
1734``` sh
35+ # ensure you have poetry installed
36+ $ pip3 install --user -U poetry
37+
38+ # clone the repository
1839$ git clone https://github.com/essembeh/python-helloworld
1940$ cd python-helloworld
20- ```
2141
22- To setup the * virtualenv* :
23- ``` sh
24- $ poetry install # to install app with dev dependencies
25- $ poetry install --no-dev # to install app without dev depdencies
26- $ poetry shell
27- (venv) $ helloworld --help
28- ```
42+ # create the virtualenv
43+ $ poetry install
2944
30- To run the app:
31- ``` sh
45+ # run the app
3246$ poetry run helloworld --help
33- ```
47+ # or
48+ $ poetry shell
49+ (.venv) $ helloworld --help
3450
35- To run the tests:
36- ``` sh
51+ # to run the tests:
3752$ poetry run pytest tests
38- $ poetry run pytest --cov=helloworld tests # To get the coverage
53+ # to get the coverage
54+ $ poetry run pytest --cov=helloworld tests
3955```
4056
41- ## Tools
57+ # Tools
4258
4359[ Poetry] ( https://python-poetry.org ) , a very useful tool to avoid boilerplate code (` setup.py ` , ` requirements.txt ` , ` requirements-dev.txt ` ...)
4460
0 commit comments