remarkbox 0.0.1__tar.gz

remarkbox-0.0.1/MANIFEST.in

@@ -0,0 +1,2 @@
+include *.txt *.ini *.cfg *.rst
+recursive-include remarkbox *.ico *.png *.css *.gif *.jpg *.pt *.txt *.mak *.mako *.js *.html *.xml *.j2 *.map

remarkbox-0.0.1/PKG-INFO

@@ -0,0 +1,290 @@
+Metadata-Version: 2.1
+Name: remarkbox
+Version: 0.0.1
+Summary: remarkbox
+Home-page: https://russell.ballestrini.net
+Author: Russell Ballestrini
+Author-email: russell@ballestrini.net
+Keywords: remarkbox question answer forum embed comments reviews
+Classifier: Programming Language :: Python
+Classifier: Framework :: Pyramid
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
+
+Remarkbox
+#########
+
+What is RemarkBox?:
+  A stand alone question and answer site (forum) or an embedded comments or product reviews service.
+  Works anywhere that supports HTML.
+
+Original Developer:
+  Russell Ballestrini (https://russell.ballestrini.net)
+
+Project Goals
+=============
+
+Note:
+  These goals are not in priority order.
+
+#. To be a suitable for:
+
+   * question and answer sites (StackOverflow)
+   * embedded comment system for static sites
+   * forums
+   * product review sections of e-commerce sites
+
+   |
+
+#. To choose popular libraries instead of proper libraries, for example:
+
+   * Github over Bitbucket (seriously considering GitLab)
+   * Git over HG Mercurial
+   * Jinja2 templates over Mako templates
+   * Markdown over ReStructuredText
+   * etc
+
+   |
+
+   Basically I have been burned too many times trying to pick the proper
+   library or tool for the job, so this time around, I will make effort
+   to choose solutions that the majority uses.
+
+#. To be popular
+
+#. To be safe from spammers
+
+#. To be easy to manage and clean up spam if it happens
+
+#. To be passwordless. Registration, verification and authentication happen via one-time-password codes sent via email.
+
+#. To scale horizontally
+
+#. To be multitenant
+
+#. To have low friction for new users to join (posters and commenters)
+
+#. To be engaging for users (posters and commenters)
+
+#. To be search engine optimized
+
+#. To have great test coverage
+
+
+Local Installation
+==================
+
+We utilize a ``Makefile`` to capture targets for building a local Remarkbox environment. Please make sure you have ``make`` installed.
+
+#. ``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
+-------------------------------
+
+To setup a "functional testing" environment on your personal workstation, open two terminal shells.
+
+In the first shell, run a copy of Remarkbox using:
+
+.. code-block:: bash
+
+ make serve
+
+In the second shell, run a "mock" simple HTTP web server to serve index.html:
+
+.. code-block:: bash
+
+ make http
+
+Now browse to http://127.0.0.1:8000 and index.html will load.
+This has an embedded copy of Remarkbox which is also running on localhost.
+
+If you attempt to log in, a verification one-time-password code will be sent over SMTP to log in!
+If you do not have an SMTP server the socket error will log email to console when in development.
+
+
+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 these steps:
+
+Activate the virtual environment:
+
+.. code-block:: bash
+
+ source env/bin/activate
+   
+Create all the schemas & tables in your database
+
+.. code-block:: bash
+
+ env/bin/remarkbox_init_db development.ini
+
+You should however run this to stamp the database as ready:
+
+.. code-block:: bash
+
+ alembic -c development.ini stamp head
+
+
+SQL Migrations
+===============
+
+Otherwise, it should be safe to run this at anytime to catch your database up:
+
+.. code-block:: bash
+
+ alembic -c development.ini upgrade head
+
+To look at the current revision and the history run these:
+
+.. code-block:: bash
+
+ alembic -c development.ini history
+ alembic -c development.ini current
+
+If you ever want to cut a new migration script, you can run this:
+
+.. code-block:: bash
+
+ alembic -c development.ini revision -m "Added email_id column to User table."
+
+Then you can edit / modify the generated ``.py`` file with your changes.
+
+You can also autogenerate a new migration script using `--autogenerate`.
+Alembic will prepare a migration script by comparing the state of the
+database with the state of the model:
+
+.. code-block:: bash
+
+  alembic -c development.ini revision --autogenerate -m "autogenerated indices."
+
+You should review the recommended migration script before `upgrade`.
+
+
+Cleaning the homepage
+========================
+
+Sometimes (all the times) it's nice to clear all the test comments from
+the homepage of our marketing site. Use this query.
+
+.. code-block:: sql
+
+  sqlite> UPDATE rb_uri SET data = "https://www.remarkbox.com/?cleaned=2018-09-28" WHERE data = "https://www.remarkbox.com/";
+  
+  sqlite> SELECT * FROM rb_uri WHERE data LIKE "%https://www.remarkbox.com/?cleaned%";
+  1e631dd85d104555b41b300961d2f909|82008b2b178f4daab64c35ab5c5f9b56|https://www.remarkbox.com/?cleaned=2017-11-01
+  6b2a4772679611e8ad95040140774501|6b2a42ae679611e8ad95040140774501|https://www.remarkbox.com/?cleaned=2018-09-28
+
+
+
+Looking up paying customers
+==============================
+
+.. code-block:: sql
+
+
+ SELECT * FROM rb_pay_what_you_can
+     INNER JOIN rb_user ON rb_user.id = rb_pay_what_you_can.user_id
+     WHERE amount > 0 and rb_user.stripe_id is not null;
+
+
+
+Python Pyramid Shell
+==========================
+
+If you want to use an interactive Python interpreter to interact with the Remarkbox app/models and database:
+
+.. code-block:: bash
+
+ pshell development.ini
+
+Here is a full `pshell` script to modify every `Node` who has a `Uri`:
+
+.. code-block:: python
+
+ # begin the database transaction.
+ request.tm.begin()
+
+ # get all Uri objects.
+ uris = m.uri.get_all_uris(request.dbsession)
+
+ # iterate over all Uri objects.
+ for uri in uris:
+     # modify the Uri's related Node.
+     uri.node.has_uri = True
+     # add the related Node object to the sqlalchemy session.
+     request.dbsession.add(uri.node)
+
+ # flush / commit all changes stored the sqlalchemy session.
+ request.dbsession.flush()
+
+ # commit/close the database transaction to really make changes.
+ request.tm.commit()
+
+Contributing
+===================
+
+* Establish communication with Russell or another admin to bless your git.unturf.com gitlab account & put you into the proper roles.
+* Russell should see your account request but due to spam you have to ask him directly for approval via email or some other means of comms.
+* Clone repo & make commits
+* Create merge requests, we automatically run the unit & headless functional tests on each commit
+* On merge we release to the production site & see the change across users.
+
+Optionally, format your code.
+
+This is not set in stone, but if you want to use a formatter this is the path for now!
+
+**Python**
+  black (manual)
+
+**Jinja2**
+  None (not needed, neither is an HTML formatter)
+
+**JavaScript**
+  Prettier or biome (manual)
+
+**CSS**
+  Prettier or biome (manual)
+
+Licence
+=====================
+
+All code contributed goes into the public domain.

remarkbox-0.0.1/README.rst

@@ -0,0 +1,277 @@
+Remarkbox
+#########
+
+What is RemarkBox?:
+  A stand alone question and answer site (forum) or an embedded comments or product reviews service.
+  Works anywhere that supports HTML.
+
+Original Developer:
+  Russell Ballestrini (https://russell.ballestrini.net)
+
+Project Goals
+=============
+
+Note:
+  These goals are not in priority order.
+
+#. To be a suitable for:
+
+   * question and answer sites (StackOverflow)
+   * embedded comment system for static sites
+   * forums
+   * product review sections of e-commerce sites
+
+   |
+
+#. To choose popular libraries instead of proper libraries, for example:
+
+   * Github over Bitbucket (seriously considering GitLab)
+   * Git over HG Mercurial
+   * Jinja2 templates over Mako templates
+   * Markdown over ReStructuredText
+   * etc
+
+   |
+
+   Basically I have been burned too many times trying to pick the proper
+   library or tool for the job, so this time around, I will make effort
+   to choose solutions that the majority uses.
+
+#. To be popular
+
+#. To be safe from spammers
+
+#. To be easy to manage and clean up spam if it happens
+
+#. To be passwordless. Registration, verification and authentication happen via one-time-password codes sent via email.
+
+#. To scale horizontally
+
+#. To be multitenant
+
+#. To have low friction for new users to join (posters and commenters)
+
+#. To be engaging for users (posters and commenters)
+
+#. To be search engine optimized
+
+#. To have great test coverage
+
+
+Local Installation
+==================
+
+We utilize a ``Makefile`` to capture targets for building a local Remarkbox environment. Please make sure you have ``make`` installed.
+
+#. ``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
+-------------------------------
+
+To setup a "functional testing" environment on your personal workstation, open two terminal shells.
+
+In the first shell, run a copy of Remarkbox using:
+
+.. code-block:: bash
+
+ make serve
+
+In the second shell, run a "mock" simple HTTP web server to serve index.html:
+
+.. code-block:: bash
+
+ make http
+
+Now browse to http://127.0.0.1:8000 and index.html will load.
+This has an embedded copy of Remarkbox which is also running on localhost.
+
+If you attempt to log in, a verification one-time-password code will be sent over SMTP to log in!
+If you do not have an SMTP server the socket error will log email to console when in development.
+
+
+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 these steps:
+
+Activate the virtual environment:
+
+.. code-block:: bash
+
+ source env/bin/activate
+   
+Create all the schemas & tables in your database
+
+.. code-block:: bash
+
+ env/bin/remarkbox_init_db development.ini
+
+You should however run this to stamp the database as ready:
+
+.. code-block:: bash
+
+ alembic -c development.ini stamp head
+
+
+SQL Migrations
+===============
+
+Otherwise, it should be safe to run this at anytime to catch your database up:
+
+.. code-block:: bash
+
+ alembic -c development.ini upgrade head
+
+To look at the current revision and the history run these:
+
+.. code-block:: bash
+
+ alembic -c development.ini history
+ alembic -c development.ini current
+
+If you ever want to cut a new migration script, you can run this:
+
+.. code-block:: bash
+
+ alembic -c development.ini revision -m "Added email_id column to User table."
+
+Then you can edit / modify the generated ``.py`` file with your changes.
+
+You can also autogenerate a new migration script using `--autogenerate`.
+Alembic will prepare a migration script by comparing the state of the
+database with the state of the model:
+
+.. code-block:: bash
+
+  alembic -c development.ini revision --autogenerate -m "autogenerated indices."
+
+You should review the recommended migration script before `upgrade`.
+
+
+Cleaning the homepage
+========================
+
+Sometimes (all the times) it's nice to clear all the test comments from
+the homepage of our marketing site. Use this query.
+
+.. code-block:: sql
+
+  sqlite> UPDATE rb_uri SET data = "https://www.remarkbox.com/?cleaned=2018-09-28" WHERE data = "https://www.remarkbox.com/";
+  
+  sqlite> SELECT * FROM rb_uri WHERE data LIKE "%https://www.remarkbox.com/?cleaned%";
+  1e631dd85d104555b41b300961d2f909|82008b2b178f4daab64c35ab5c5f9b56|https://www.remarkbox.com/?cleaned=2017-11-01
+  6b2a4772679611e8ad95040140774501|6b2a42ae679611e8ad95040140774501|https://www.remarkbox.com/?cleaned=2018-09-28
+
+
+
+Looking up paying customers
+==============================
+
+.. code-block:: sql
+
+
+ SELECT * FROM rb_pay_what_you_can
+     INNER JOIN rb_user ON rb_user.id = rb_pay_what_you_can.user_id
+     WHERE amount > 0 and rb_user.stripe_id is not null;
+
+
+
+Python Pyramid Shell
+==========================
+
+If you want to use an interactive Python interpreter to interact with the Remarkbox app/models and database:
+
+.. code-block:: bash
+
+ pshell development.ini
+
+Here is a full `pshell` script to modify every `Node` who has a `Uri`:
+
+.. code-block:: python
+
+ # begin the database transaction.
+ request.tm.begin()
+
+ # get all Uri objects.
+ uris = m.uri.get_all_uris(request.dbsession)
+
+ # iterate over all Uri objects.
+ for uri in uris:
+     # modify the Uri's related Node.
+     uri.node.has_uri = True
+     # add the related Node object to the sqlalchemy session.
+     request.dbsession.add(uri.node)
+
+ # flush / commit all changes stored the sqlalchemy session.
+ request.dbsession.flush()
+
+ # commit/close the database transaction to really make changes.
+ request.tm.commit()
+
+Contributing
+===================
+
+* Establish communication with Russell or another admin to bless your git.unturf.com gitlab account & put you into the proper roles.
+* Russell should see your account request but due to spam you have to ask him directly for approval via email or some other means of comms.
+* Clone repo & make commits
+* Create merge requests, we automatically run the unit & headless functional tests on each commit
+* On merge we release to the production site & see the change across users.
+
+Optionally, format your code.
+
+This is not set in stone, but if you want to use a formatter this is the path for now!
+
+**Python**
+  black (manual)
+
+**Jinja2**
+  None (not needed, neither is an HTML formatter)
+
+**JavaScript**
+  Prettier or biome (manual)
+
+**CSS**
+  Prettier or biome (manual)
+
+Licence
+=====================
+
+All code contributed goes into the public domain.

remarkbox-0.0.1/development.ini

@@ -0,0 +1,155 @@
+# Config File Reference:
+# http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/environment.html
+
+[alembic]
+script_location = remarkbox:scripts/alembic
+sqlalchemy.url = sqlite:///%(here)s/remarkbox.sqlite
+
+[app:main]
+use = egg:remarkbox
+
+#sqlalchemy.url = postgres://localhost/remarkbox
+sqlalchemy.url = sqlite:///%(here)s/remarkbox.sqlite
+
+###
+# Pyramid configuration.
+###
+pyramid.reload_templates = true
+pyramid.debug_authorization = false
+pyramid.debug_notfound = false
+pyramid.debug_routematch = false
+pyramid.default_locale_name = en
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_tm
+
+# By default, the toolbar only appears for clients from IP addresses
+# '127.0.0.1' and '::1'.
+# debugtoolbar.hosts = 127.0.0.1 ::1
+
+###
+# session / cookie configuration.
+# http://docs.pylonsproject.org/docs/pyramid/en/latest/api/session.html
+###
+session.hashalg = sha512
+session.secret  = test-secret
+session.timeout = 31104000
+session.max_age = 31104000
+session.reissue_time = 15552000
+session.samesite = none
+session.secure = False
+
+###
+# custom app configuration.
+###
+app.avatar.size = 35
+
+# In prod I set this to: remarkbox.com (default = "")
+#app.root_domain =
+app.root_domain = ${REMARKBOX_APP_ROOT_DOMAIN}
+
+# If set we force all links related to `join or log in` to this base url 
+# and use this url for links in email notifications.
+# Also useful when multiple subdomains point at the same Remarkbox cluster.
+# In prod I set this to: https://my.remarkbox.com (default = request.host_url)
+#app.app_url =
+app.app_url = ${REMARKBOX_APP_URL}
+
+# if your marketing / main landing page base url is different then app url.
+# In prod I set this to: https://www.remarkbox.com (default = request.app_url)
+#app.marketing_url =
+
+# if Node is None, we may safely redirect to this uri. optional.
+#app.safe_redirect = https://www.remarkbox.com
+
+app.email.relay = localhost
+app.email.sender = no-reply@remarkbox.com
+
+# set this to the path of your private DKIM key.
+# reference: https://russell.ballestrini.net/quickstart-to-dkim-signed-email-with-python/
+#app.email.dkim_private_key_path =
+#app.email.dkim_selector =
+
+# The app name in the email subject (default = request.app_domain)
+# In production I set this to "Remarkbox".
+app.email.subject_postfix = Remarkbox
+
+# optional theme plugin name.
+#app.theme = westworld
+app.theme = meta
+
+# optional theme plugin name for embed mode.
+#app.theme_embed = meta
+
+# stand-alone mode disables a bunch of views and templates
+# related to billing and registering Namespaces.
+# choices enabled or disabled. defaults to disabled.
+#app.stand_alone_mode = disabled
+
+# stripe: credit card storage and processing.
+# This syntax will automatically expand an ENV var of the same name.
+app.stripe.secret = ${REMARKBOX_APP_STRIPE_SECRET}
+app.stripe.public = ${REMARKBOX_APP_STRIPE_PUBLIC}
+
+# slack: bot notifications.
+app.slack.secret = ${REMARKBOX_APP_SLACK_SECRET}
+app.slack.public = ${REMARKBOX_APP_SLACK_PUBLIC}
+app.slack.oauth_scope = channels:read,chat:write:bot
+
+# feature flag for email notifications.
+#app.deliver_email_notifications = true
+
+# robots.txt contents.
+#app.robots_dot_txt =
+#    User-agent: *
+#    Disallow:
+
+###
+# wsgi server configuration
+###
+[server:main]
+use = egg:waitress#main
+host = 0.0.0.0
+port = 6543
+
+###
+# logging configuration
+# http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/logging.html
+###
+[loggers]
+keys = root, remarkbox, sqlalchemy
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = INFO
+handlers = console
+
+[logger_remarkbox]
+level = DEBUG
+handlers =
+qualname = remarkbox
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+# "level = INFO" logs SQL queries.
+# "level = DEBUG" logs SQL queries and results.
+# "level = WARN" logs neither.  (Recommended for production systems.)
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(asctime)s %(levelname)-5.5s [%(name)s][%(threadName)s] %(message)s
+
+[pshell]
+m = remarkbox.models