Skip to content

Commit

Permalink
switch to pipenv, update versions and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Petricpwnz committed Oct 6, 2018
1 parent 816e495 commit 6e99021
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 8 deletions.
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,8 @@ db.json
fafbot.conf
.coverage
config.ini
.idea
.idea
Pipfile.lock
/.pytest_cache
/.cache
log.txt
16 changes: 16 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
aiohttp = "==3.4.4"
"irc3" = "==1.1.1"
pytest = "==3.8"
slackclient = "==1.1.0"
pip = "==18.0"
pytest-asyncio = "==0.9.0"

[dev-packages]

[requires]
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,28 @@ This is the source code for the [Forged Alliance Forever](http://www.faforever.c

## Installation

Install Python 3.4 or a later 3.x version.
Install Python 3.6 or a later 3.x version.

Latest pip version (18.1) at the moment of writing this document breaks pipenv - https://github.com/pypa/pipenv/issues/2924,
so we will need to install version 18.0

Install pip version 18.0:

windows: pip install --upgrade pip==18.0
pip --version

linux: pip3 install --upgrade pip==18.0
pip3 --version


Install the package dependencies:

windows: pip install -r requirements.txt
linux: pip3 install -r requirements.txt
windows: pip install -r requirements.txt
pipenv install

linux: pip3 install -r requirements.txt
pipenv install


Create the config file and modify the settings as appropriate:

Expand All @@ -23,8 +39,10 @@ in [the server repo](https://github.com/FAForever/server).

## Usage

pipenv shell
python3 -m irc3 config.ini

## Running the tests

pipenv shell
py.test tests/
5 changes: 1 addition & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
aiohttp==2.3.9
irc3==1.0.2
pytest==3.3.2
slackclient==1.1.0
pipenv==2018.7.1

0 comments on commit 6e99021

Please sign in to comment.