Mercurial > p > roundup > code

annotate scripts/README.txt @ 8266:43dc610bbd24

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: known issues with possible dependent tests When reversing the testing order, two blocks of tests fail. Document these. I spent time trying to fix them, but got nowhere. Obviously I am missing something. But this doc gives future me or somebody else a starting point.
author John Rouillard <rouilj@ieee.org>
date Thu, 09 Jan 2025 09:32:10 -0500
parents 8d9a6063cb22
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1647
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 Scripts in this directory:
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 add-issue
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 Add a single issue, as specified on the command line, to your tracker. The
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 initial message for the issue is taken from standard input.
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6
6473
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
7 copy-user.py
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
8 Copy one or more Roundup users from one tracker instance to another.
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
9
6571
cd408eb748dd Add small utility script for dumping dbm based databases.
John Rouillard <rouilj@ieee.org>
parents: 6553
diff changeset
10 dump_dbm_sessions_db.py
cd408eb748dd Add small utility script for dumping dbm based databases.
John Rouillard <rouilj@ieee.org>
parents: 6553
diff changeset
11 Simple script to dump a session style dbm database e.g. db/otks or
cd408eb748dd Add small utility script for dumping dbm based databases.
John Rouillard <rouilj@ieee.org>
parents: 6553
diff changeset
12 db/sessions in readable form.
cd408eb748dd Add small utility script for dumping dbm based databases.
John Rouillard <rouilj@ieee.org>
parents: 6553
diff changeset
13
6473
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
14 imapServer.py
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
15 This IMAP server script that runs in the background and checks for new
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
16 email from a variety of mailboxes.
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
17
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
18 import_sf.py
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
19 Import tracker data from Sourceforge.NET into a new roundup instance.
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
20
1647
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 roundup-reminder
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 Generate an email that lists outstanding issues. Send in both plain text
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 and HTML formats.
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24
6473
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
25 schema_diagram.py
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
26 Generate a schema diagram for a roundup tracker. It generates a 'dot file'
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
27 that is then fed into the 'dot' tool (http://www.graphviz.org) to generate
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
28 a graph.
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
29
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
30 schema-dump.py
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
31 Use recently documented XML-RPC API to dump Roundup data schema in
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
32 human readable form.
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
33
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
34 spam-remover
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
35 Remove file attachment spam from a tracker. (Warning destructive,
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
36 read script well.)
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
37
6553
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
38 stats.xmlrpc.py
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
39 Script using the xmlrpc interface to retrieve info. Generates report
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
40 on what values are used by the various issues on bugs.python.org.
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
41
3764
7f0c63868fa9 add new script
Richard Jones <richard@users.sourceforge.net>
parents: 3176
diff changeset
42 weekly-report
7f0c63868fa9 add new script
Richard Jones <richard@users.sourceforge.net>
parents: 3176
diff changeset
43 Generate a simple report outlining the activity in one tracker for the
7f0c63868fa9 add new script
Richard Jones <richard@users.sourceforge.net>
parents: 3176
diff changeset
44 most recent week.
7f0c63868fa9 add new script
Richard Jones <richard@users.sourceforge.net>
parents: 3176
diff changeset
45
6473
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
46 ----
1647
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 server-ctl
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 Control the roundup-server daemon from the command line with start, stop,
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 restart, condstart (conditional start - only if server is stopped) and
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51 status commands.
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52
1841
24fb163ddece added Debian rc script
Richard Jones <richard@users.sourceforge.net>
parents: 1647
diff changeset
53 roundup.rc-debian
24fb163ddece added Debian rc script
Richard Jones <richard@users.sourceforge.net>
parents: 1647
diff changeset
54 An control script that may be installed in /etc/init.d on Debian systems.
24fb163ddece added Debian rc script
Richard Jones <richard@users.sourceforge.net>
parents: 1647
diff changeset
55 Offers start, stop and restart commands and integrates with the Debian
24fb163ddece added Debian rc script
Richard Jones <richard@users.sourceforge.net>
parents: 1647
diff changeset
56 init process.
24fb163ddece added Debian rc script
Richard Jones <richard@users.sourceforge.net>
parents: 1647
diff changeset
57
6473
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
58
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
59 systemd.gunicorn
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
60 A systemd unit file for running roundup under gnuicorn WSGI server.
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
61
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
62 ----
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents: 1841
diff changeset
63
4828
64daaa4bf816 contributors.py: Exclude robots and change sorting so that
anatoly techtonik <techtonik@gmail.com>
parents: 3764
diff changeset
64 contributors.py
64daaa4bf816 contributors.py: Exclude robots and change sorting so that
anatoly techtonik <techtonik@gmail.com>
parents: 3764
diff changeset
65 Analyzes Mercurial log, filters and compiles list of committers with years
64daaa4bf816 contributors.py: Exclude robots and change sorting so that
anatoly techtonik <techtonik@gmail.com>
parents: 3764
diff changeset
66 of contribution. Can be useful for updating COPYING.txt
6553
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
67
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
68 ----
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
69
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
70 Docker
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
71 Directory for docker setup. More info on how to use it is in
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
72 doc/installation.txt.
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
73
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
74 Docker/Dockerfile - Create roundup docker.
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
75
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
76 Docker/requirements.txt - Python requirements built into docker.
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
77
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
78 Docker/roundup-start - Startup script for roundup in docker.
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
79
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
80 Docker/docker-compose.yml - Manage two docker containers for roundup
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
81 and mysql.
7084
8d9a6063cb22 Add oauth-get-token.py script
Ralf Schlatterbeck <rsc@runtux.com>
parents: 6571
diff changeset
82
8d9a6063cb22 Add oauth-get-token.py script
Ralf Schlatterbeck <rsc@runtux.com>
parents: 6571
diff changeset
83 ----
8d9a6063cb22 Add oauth-get-token.py script
Ralf Schlatterbeck <rsc@runtux.com>
parents: 6571
diff changeset
84
8d9a6063cb22 Add oauth-get-token.py script
Ralf Schlatterbeck <rsc@runtux.com>
parents: 6571
diff changeset
85 oauth-get-token.py
8d9a6063cb22 Add oauth-get-token.py script
Ralf Schlatterbeck <rsc@runtux.com>
parents: 6571
diff changeset
86 Retrieve necessary credentials from MS cloud for OAuth authentication
8d9a6063cb22 Add oauth-get-token.py script
Ralf Schlatterbeck <rsc@runtux.com>
parents: 6571
diff changeset
87 with IMAP. This has an extensive help text so you want to call this
8d9a6063cb22 Add oauth-get-token.py script
Ralf Schlatterbeck <rsc@runtux.com>
parents: 6571
diff changeset
88 script with --help first.
8d9a6063cb22 Add oauth-get-token.py script
Ralf Schlatterbeck <rsc@runtux.com>
parents: 6571
diff changeset
89
Roundup Issue Tracker: http://roundup-tracker.org/