Commit 2695e310 authored by Bruno Morgado's avatar Bruno Morgado Committed by Bruno S. Morgado
Browse files

ST-49 ST-53 Add pipenv as the default package management and update... 


ST-49 ST-53 Add pipenv as the default package management and update documentation on how to install.

Signed-off-by: default avatarBruno S. Morgado <jb.morgado@gmail.com>
parent 9e2ca3ba

.gitignore

+2 −0
Original line number Original line Diff line number Diff line
@@ -8,6 +8,8 @@ dist 
.cache

.cache

__pycache__

__pycache__





Pipfile.lock



htmlcov

htmlcov

.coverage

.coverage

coverage.xml

coverage.xml

Pipfile

0 → 100644
+23 −0
Original line number Original line Diff line number Diff line 
[[source]]

url = "https://pypi.org/simple"

verify_ssl = true

name = "pypi"



[packages]

docutils = "*"

MarkupSafe = "*"

Pygments = "*"

pylint = "*"

pytest = "*"

pytest-cov = "*"

pytest-pylint = "*"

python-dotenv = ">=0.5.1"

Sphinx = "*"

sphinx_rtd_theme = "*"

sphinx-autobuild = "*"

sphinxcontrib-websupport = "*"



[dev-packages]



[requires]

python_version = "3.6"

README.md

+15 −2
Original line number Original line Diff line number Diff line
@@ -6,12 +6,25 @@ Briefly describe your project here 
Install 

Install 

-------

-------





How to install 

**Always** use a virtual environment. `Pipenv` is now Python's officially recommended method and the one used by

default in this repo. **WARNING:** `requirements.txt` will be deprecated and removed from this repo in the future.



Follow these steps at the project root:



```bash

pip install pipenv # if you don't have pipenv already installed on your system

pipenv install

pipenv shell

```



You will now be inside a pipenv shell with your virtual environment ready.



Use `pipenv exit` to exit the virtual environment.







Testing

Testing

-------

-------





* **Always** use a virtual environment like `virtualenv` or `anaconda`

* Put tests into the `tests` folder

* Put tests into the `tests` folder

* Use [PyTest](https://pytest.org) as the testing framework

* Use [PyTest](https://pytest.org) as the testing framework

  - Reference: [PyTest introduction](http://pythontesting.net/framework/pytest/pytest-introduction/)

  - Reference: [PyTest introduction](http://pythontesting.net/framework/pytest/pytest-introduction/)