Skip to content

Commit aae321b

Browse files
authored
Align with master and fix dependencies (#561)
1 parent f24840b commit aae321b

5 files changed

Lines changed: 264 additions & 216 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
<!-- Please create/claim an issue before sending a PR -->
1+
<!-- Please create (if there is not one yet) a issue before sending a PR -->
22
<!-- Add issue number (Eg: fixes #123) -->
3+
<!-- Always provide changes in existing tests or new tests -->
34

45
Fixes #
56

67
### Checklist
78
- [ ] My branch is up-to-date with upstream/develop branch.
89
- [ ] Everything works and tested for Python 3.6.0 and above.
910

10-
### Description
11-
<!-- Describe about what this PR does, previous state and new state of the output -->
11+
### Current behaviour
12+
<!-- Describe the code you are going to change and its behaviour -->
13+
14+
### New expected behaviour
15+
<!-- Describe the new code and its expected behaviour -->
1216

1317
### Change logs
1418

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,30 @@ cd hydrus
6363
git checkout -b develop origin/develop
6464
```
6565

66+
Install a [*Python virtual environment*](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) using:
67+
```bash
68+
python3.7 -m venv .venv
69+
```
70+
or:
71+
```bash
72+
virtualenv -p python3.7 .venv
73+
```
74+
6675
Install hydrus using:
6776
```bash
68-
pip3 install -r requirements.txt
77+
source .venv/bin/activate
78+
pip install -r requirements.txt
79+
python setup.py install
80+
```
6981

70-
python3 setup.py install
82+
NOTE: there is an alternative way to install dependencies with `poetry`:
83+
```bash
84+
pip3 install poetry
85+
poetry install
7186
```
87+
This is mostly used to check dependencies conflicts among packages.
7288

73-
and run the server using:
74-
89+
After installation is successful, to run the server:
7590
```bash
7691
hydrus serve
7792
```

0 commit comments

Comments
 (0)