diff --git a/README.rst b/README.rst index 69502a1..6e676cc 100644 --- a/README.rst +++ b/README.rst @@ -66,6 +66,40 @@ We utilize a ``Makefile`` to capture targets for building a local Remarkbox envi #. ``make dev`` #. ``make test`` +## For WSL Users + +If you are using Windows Subsystem for Linux (WSL), follow these steps to set up your environment: + +Activate the virtual environment + +.. code-block:: bash + + source env/bin/activate + +Install dependencies: + +.. code-block:: bash + + pip install -r requirements-wsl.txt + + +### For Other Users + +For users on other platforms, follow these steps: + +Activate the virtual environment: + +.. code-block:: bash + + source env/bin/activate + +Install dependencies: + +.. code-block:: bash + + pip install -r requirements.txt + + Functional testing environment ------------------------------- @@ -96,7 +130,15 @@ New Environments If your deployment is brand new, you don't need to run any migrations. -To create all the schemas & tables in your database, run: +To create all the schemas & tables in your database, run these steps: + +Activate the virtual environment: + +.. code-block:: bash + + source env/bin/activate + +Create all the schemas & tables in your database .. code-block:: bash diff --git a/requirements-wsl.txt b/requirements-wsl.txt new file mode 100644 index 0000000..6afc8a9 --- /dev/null +++ b/requirements-wsl.txt @@ -0,0 +1,79 @@ +# python 2 -> 3 compat. +six + +# Pyramid. +plaster_pastedeploy +pyramid +pyramid_jinja2 +pyramid_debugtoolbar +pyramid_retry +pyramid_tm + +# python 2. +venusian==2.1.0 + +# python 2. +soupsieve==1.9.5 + +# Model. +SQLAlchemy==1.3.24 +SQLAlchemy-Utils==0.36.3 +transaction +zope.sqlalchemy +alembic + +# PostgreSQL database connections. +# requires postgresql-devel on Fedora for `pg_config` binary. +psycopg2-binary + +# Template renderer. +# python 3. +#jinja2 +# python 2. +jinja2==3.0.3 + +# MarkupSafe is a Python library designed to provide a safe way of handling strings that contain data from untrusted sources. +# compatible with jinja2 +markupsafe==2.0.1 + +# MarkDown is a popular and familair WYSIWYM markup language. +# python 2. +markdown==2.6.11 +python-markdown-math +html5lib +BeautifulSoup4 + +# Bleach sanitizes MarkDown (removes HTML/Javascript) to prevent XSS. +bleach>=2.1.4 +bleach-allowlist + +# codehilite. +pygments + +# Human readable time deltas. +ago + +# light weight URI attribute parser. +miniuri + +# Create URI slugs from titles. +python-slugify + +# Future proof, computationally complex password hashes. +bcrypt + +# reach out to verify public rb_owner_key. +requests[security] +# request library pins this dependency too low. +# idna==2.6 + +# credit card storage and processing. +stripe==3.5.0 + +# slack: bot notifications. +slacker + +# DKIM Signed Email from Python. +#dkimpy +# python 2. +dkimpy==1.0.2