pipenv for dependencies

.gitignore

@@ -0,0 +1,112 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+.static_storage/
+.media/
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+.idea
+
+node_modules/
+npm-debug.log
+.DS_Store
+
+_Dockerfile*

Pipfile

@@ -0,0 +1,20 @@
+[[source]]
+
+url = "https://pypi.python.org/simple"
+verify_ssl = true
+name = "pypi"
+
+
+[packages]
+
+discord = "*"
+mysqlclient = "*"
+
+
+[dev-packages]
+
+
+
+[requires]
+
+python_version = "3.6"

README.md

@@ -1,12 +1,18 @@
 # CSPM
 Crowd-Sourced PokeMap for Monocle
 
-1) Install discord.py using: `python3 -m pip install -U discord.py`
-2) Set up config.py
-3) Run with:
-    `python3 cspm.py`
+1. Install [pipenv](https://docs.pipenv.org/)
+2. Install mysql 
+    * `brew install mysql`
+3. Checkout repository
+    * `git clone ...`
+4. Setup dependencies
+    * `cd CSPM`
+    * `pipenv install`
+5. Run inside pipenv
+    * `pipenv run cspm.py`
 
-4) Error 2006: `SET GLOBAL max_allowed_packet=10485760;`
+**Error 2006: `SET GLOBAL max_allowed_packet=10485760;`
 
 **Spawns:
 Spawns are given a 15 minute timer since the timer is assumed to be unknown. (Your maps will likely have a spawnpoint option though)