view scripts/README.txt @ 6823:fe0091279f50

Refactor session db logging and key generation for sessions/otks While I was working on the redis sessiondb stuff, I noticed that log_wanrning, get_logger ... was duplicated. Also there was code to generate a unique key for otks that was duplicated. Changes: creating new sessions_common.py and SessionsCommon class to provide methods: log_warning, log_info, log_debug, get_logger, getUniqueKey getUniqueKey method is closer to the method used to make session keys in client.py. sessions_common.py now report when random_.py chooses a weak random number generator. Removed same from rest.py. get_logger reconciles all logging under roundup.hyperdb.backends.<name of BasicDatabase class> some backends used to log to root logger. have BasicDatabase in other sessions_*.py modules inherit from SessionCommon. change logging to use log_* methods. In addition: remove unused imports reported by flake8 and other formatting changes modify actions.py, rest.py, templating.py to use getUniqueKey method. add tests for new methods test_redis_session.py swap out ModuleNotFoundError for ImportError to prevent crash in python2 when redis is not present. allow injection of username:password or just password into redis connection URL. set pytest_redis_pw envirnment variable to password or user:password when running test.
author John Rouillard <rouilj@ieee.org>
date Sun, 07 Aug 2022 01:51:11 -0400
parents cd408eb748dd
children 8d9a6063cb22
line wrap: on
line source

Scripts in this directory:

add-issue
 Add a single issue, as specified on the command line, to your tracker. The
 initial message for the issue is taken from standard input.

copy-user.py
 Copy one or more Roundup users from one tracker instance to another. 

dump_dbm_sessions_db.py
 Simple script to dump a session style dbm database e.g. db/otks or
 db/sessions in readable form.
 
imapServer.py
 This IMAP server script that runs in the background and checks for new
 email from a variety of mailboxes.

import_sf.py
 Import tracker data from Sourceforge.NET into a new roundup instance.

roundup-reminder
 Generate an email that lists outstanding issues. Send in both plain text
 and HTML formats.

schema_diagram.py
 Generate a schema diagram for a roundup tracker. It generates a 'dot file'
 that is then fed into the 'dot' tool (http://www.graphviz.org) to generate
 a graph.

schema-dump.py
 Use recently documented XML-RPC API to dump Roundup data schema in
 human readable form.

spam-remover
 Remove file attachment spam from a tracker. (Warning destructive,
 read script well.)

stats.xmlrpc.py
 Script using the xmlrpc interface to retrieve info. Generates report
 on what values are used by the various issues on bugs.python.org.

weekly-report
 Generate a simple report outlining the activity in one tracker for the
 most recent week.

----

server-ctl
 Control the roundup-server daemon from the command line with start, stop,
 restart, condstart (conditional start - only if server is stopped) and
 status commands.

roundup.rc-debian
 An control script that may be installed in /etc/init.d on Debian systems.
 Offers start, stop and restart commands and integrates with the Debian
 init process.


systemd.gunicorn
 A systemd unit file for running roundup under gnuicorn WSGI server.

----

contributors.py
 Analyzes Mercurial log, filters and compiles list of committers with years
 of contribution. Can be useful for updating COPYING.txt

----

Docker
  Directory for docker setup. More info on how to use it is in
  doc/installation.txt.

Docker/Dockerfile - Create roundup docker.

Docker/requirements.txt - Python requirements built into docker.

Docker/roundup-start - Startup script for roundup in docker.

Docker/docker-compose.yml - Manage two docker containers for roundup
      and mysql.

Roundup Issue Tracker: http://roundup-tracker.org/