From a28ab0e7a09fa48c0def79dab76e168df984bcf2 Mon Sep 17 00:00:00 2001 From: Groupr Date: Mon, 24 Feb 2025 10:04:24 +0000 Subject: [PATCH 1/5] Add requirements-wsl.txt for WSL users - This file contains the specific dependencies required for running the application in Windows Subsystem for Linux (WSL). - Adding this file ensures that developers working on WSL can easily set up their environment and install all necessary packages. - This improves consistency across development environments and reduces setup time for new contributors or team members. --- requirements-wsl.txt | 76 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 requirements-wsl.txt diff --git a/requirements-wsl.txt b/requirements-wsl.txt new file mode 100644 index 0000000..e25be7c --- /dev/null +++ b/requirements-wsl.txt @@ -0,0 +1,76 @@ +# 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 + +# MarkDown is a popular and familair WYSIWYM markup language. +# python 2. +markdown==2.6.11 +markupsafe==2.0.1 +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 From 7df786100b07afa4dfdabbb84a4d091213bb665b Mon Sep 17 00:00:00 2001 From: Groupr Date: Mon, 24 Feb 2025 10:08:39 +0000 Subject: [PATCH 2/5] Update requirements-wsl.txt --- requirements-wsl.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/requirements-wsl.txt b/requirements-wsl.txt index e25be7c..6afc8a9 100644 --- a/requirements-wsl.txt +++ b/requirements-wsl.txt @@ -32,10 +32,13 @@ psycopg2-binary # 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 -markupsafe==2.0.1 python-markdown-math html5lib BeautifulSoup4 From 5dcd60cab2552233e7c18f60a5e76b4a484664ce Mon Sep 17 00:00:00 2001 From: Groupr Date: Mon, 24 Feb 2025 10:48:52 +0000 Subject: [PATCH 3/5] Update README.rst for new environment setup - Added a step to activate the virtual environment before creating tables. --- README.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 69502a1..a8a94c7 100644 --- a/README.rst +++ b/README.rst @@ -96,7 +96,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 thse steps: + +Activate the virtual environment: + +.. code-block:: bash + + source env/bin/activate + +Create all the schemas & tables in your database .. code-block:: bash From 825305219f066b6d5662f82861a0f1b7314803c6 Mon Sep 17 00:00:00 2001 From: Groupr Date: Mon, 24 Feb 2025 11:11:44 +0000 Subject: [PATCH 4/5] Update README.rst --- README.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.rst b/README.rst index a8a94c7..46bcfd1 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 ------------------------------- From 4e40329ed316634bfc9783ff732c96251b31a6a1 Mon Sep 17 00:00:00 2001 From: Groupr Date: Fri, 28 Feb 2025 10:39:46 +0000 Subject: [PATCH 5/5] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 46bcfd1..6e676cc 100644 --- a/README.rst +++ b/README.rst @@ -130,7 +130,7 @@ 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 thse steps: +To create all the schemas & tables in your database, run these steps: Activate the virtual environment: