Mercurial > p > roundup > code

annotate scripts/README.txt @ 6553:75da037d1c54

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add another xmlrpc example script and update readme. Also added basic description of Docker files in Docker subdirectory (to be added).
author John Rouillard <rouilj@ieee.org>
date Sat, 11 Dec 2021 21:26:46 -0500
parents 7655dae061b8
children cd408eb748dd
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
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
10 imapServer.py
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
11 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
12 email from a variety of mailboxes.
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
13
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
14 import_sf.py
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
15 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
16
1647
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 roundup-reminder
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18 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
19 and HTML formats.
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20
6473
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
21 schema_diagram.py
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
22 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
23 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
24 a graph.
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
25
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
26 schema-dump.py
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
27 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
28 human readable form.
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 spam-remover
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
31 Remove file attachment spam from a tracker. (Warning destructive,
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
32 read script well.)
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
33
6553
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
34 stats.xmlrpc.py
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
35 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
36 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
37
3764
7f0c63868fa9 add new script
Richard Jones <richard@users.sourceforge.net>
parents: 3176
diff changeset
38 weekly-report
7f0c63868fa9 add new script
Richard Jones <richard@users.sourceforge.net>
parents: 3176
diff changeset
39 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
40 most recent week.
7f0c63868fa9 add new script
Richard Jones <richard@users.sourceforge.net>
parents: 3176
diff changeset
41
6473
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
42 ----
1647
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 server-ctl
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45 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
46 restart, condstart (conditional start - only if server is stopped) and
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 status commands.
73bf927091c7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48
1841
24fb163ddece added Debian rc script
Richard Jones <richard@users.sourceforge.net>
parents: 1647
diff changeset
49 roundup.rc-debian
24fb163ddece added Debian rc script
Richard Jones <richard@users.sourceforge.net>
parents: 1647
diff changeset
50 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
51 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
52 init process.
24fb163ddece added Debian rc script
Richard Jones <richard@users.sourceforge.net>
parents: 1647
diff changeset
53
6473
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
54
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
55 systemd.gunicorn
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
56 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
57
7655dae061b8 Document missing files. Alphabetize.
John Rouillard <rouilj@ieee.org>
parents: 4828
diff changeset
58 ----
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents: 1841
diff changeset
59
4828
64daaa4bf816 contributors.py: Exclude robots and change sorting so that
anatoly techtonik <techtonik@gmail.com>
parents: 3764
diff changeset
60 contributors.py
64daaa4bf816 contributors.py: Exclude robots and change sorting so that
anatoly techtonik <techtonik@gmail.com>
parents: 3764
diff changeset
61 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
62 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
63
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
64 ----
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
65
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
66 Docker
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
67 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
68 doc/installation.txt.
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/Dockerfile - Create roundup docker.
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
71
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
72 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
73
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
74 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
75
75da037d1c54 Add another xmlrpc example script and update readme.
John Rouillard <rouilj@ieee.org>
parents: 6473
diff changeset
76 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
77 and mysql.
Roundup Issue Tracker: http://roundup-tracker.org/