Skip to content

Commit 28ec53a

Browse files
[FIX] Some Install Issues Fixed (#661)
* Some Install Issues Fixed * Update documentation to use virtualenv instead of pipenv Co-authored-by: Shivam Kumar Jha <[email protected]>
1 parent 67f1b9a commit 28ec53a

File tree

4 files changed

+11
-20
lines changed

4 files changed

+11
-20
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ gunicorn.pid
3838
coverage_report/
3939
.coverage
4040

41-
#virtualenv
41+
# virtualenv
4242
venv/
4343
.vscode/
4444
.idea/

README.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -90,31 +90,20 @@ Sample-platform is regularly tested via Travis CI.
9090

9191
We use `nosetests` to manage testing and it can be run locally as follows:
9292

93+
For creating a virtual environment, we use [virtualenv](https://pypi.org/project/virtualenv/).
94+
9395
```bash
94-
pipenv shell --three # make virtual environment
95-
pipenv install --dev # install development dependencies
96-
TESTING=True pipenv run nosetests --with-cov --cov-config .coveragerc
96+
virtualenv venv # create a virtual environment
97+
source venv/bin/activate # activate the virtual environment
98+
pip install -r requirements.txt # install dependencies
99+
pip install -r test-requirements.txt # install test dependencies
100+
TESTING=True nosetests --with-cov --cov-config .coveragerc
97101
```
98102

99103
## Etiquettes
100104

101105
We follow certain etiquettes which include docstrings, annotation, import sorting etc.
102106

103-
### Setup
104-
105-
The operations listed below are only for developers. The tools used below can be installed at once as,
106-
107-
```bash
108-
pipenv shell --three # if not inside pipenv shell already
109-
pipenv install --dev # if first time running dev-dependencies
110-
```
111-
112-
If you are adding a new module which will be required just by developers, use below commands.
113-
114-
```bash
115-
pipenv install --dev [MODULE_NAME]
116-
```
117-
118107
### DocStrings Testing
119108

120109
Sample-platform uses docstrings heavily to document modules and methods.

install/install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ echo ""
2727
echo "* Updating package list"
2828
apt-get update >> "$install_log" 2>&1
2929
echo "* Installing nginx, python, pip, kvm, libvirt and virt-manager"
30-
apt-get -q -y install nginx python python-dev python3-libvirt libxslt1-dev libxml2-dev python-pip qemu-kvm libvirt-bin virt-manager mediainfo >> "$install_log" 2>&1
30+
apt-get -q -y install nginx python3 python-is-python3 python3-libvirt libxslt1-dev python3-libxml2 python3-pip qemu-system-x86 libvirt-daemon-system libvirt-clients virt-manager mediainfo >> "$install_log" 2>&1
3131
for file in /etc/init.d/mysql*
3232
do
3333
if [ ! -f "$file" ]; then

requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,5 @@ gitdb==4.0.9
2222
Werkzeug==1.0.1
2323
WTForms==2.3.3
2424
MarkupSafe<=2.0.1
25+
jinja2==3.0.2
26+
itsdangerous==2.0.1

0 commit comments

Comments
 (0)