Mercurial > p > roundup > code
annotate README.txt @ 8408:e882a5d52ae5
refactor: move RateLimitExceeded to roundup.cgi.exceptions
RateLimitExceeded is an HTTP exception that raises code 429. Move it
to roundup.cgi.exceptions where all the other exceptions that result
in http status codes are located. Also make it inherit from
HTTPException since it is one.
Also add docstrings for all HTTP exceptions and order HTTPExceptions
by status code.
BREAKING CHANGE: if somebody is importing RateLimitExceeded they will
need to change their import. I consider it unlikely anybody is using
RateLimitExceeded. Detectors and extensions are unlikely to raise
RateLimitExceeded. So I am leaving it out of the upgrading doc. Just
doc in change log.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 10 Aug 2025 21:27:06 -0400 |
| parents | aedc1782a6af |
| children |
| rev | line source |
|---|---|
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
1 ======================================================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
2 Roundup: an Issue-Tracking System for Knowledge Workers |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
3 ======================================================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
4 |
| 7708 | 5 Introduction |
| 6 ============ | |
| 7 | |
| 8 Roundup is a tool for creating issue trackers. This includes: | |
| 9 | |
| 10 * bug trackers, | |
| 11 * help desk, | |
| 12 * agile development trackers, | |
| 13 * customer issue tracking, | |
| 14 * fleet maintenance tracking, | |
| 15 * GTD tool etc. | |
| 16 | |
| 17 It comes with predefined trackers meant to be customized for your | |
| 18 workflow. Starting trackers include: | |
| 19 | |
| 20 * generic tracker, | |
| 21 * development bug/feature tracker (3 variations), | |
| 22 * bare bones minimal tracker. | |
| 23 | |
| 24 Your users interact with (create, read, update, close) issues using a | |
| 25 web interface or by email. It can be programmaticly managed via REST | |
| 26 or XMLRPC, CLI, or via local Python scripts. | |
| 27 | |
| 28 The user's guide is at https://www.roundup-tracker.org/docs/user_guide.html. | |
| 29 | |
| 30 | |
| 1639 | 31 INSTANT GRATIFICATION |
| 32 ===================== | |
| 33 | |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
34 The impatient may try Roundup immediately by running demo.py from |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
35 the source directory:: |
| 1639 | 36 |
|
1640
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
37 python demo.py |
| 1639 | 38 |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
39 This will create new tracker home in "demo" subdirectory and start |
| 7708 | 40 a web server. To reset demo instance:: |
|
1640
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
41 |
|
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
42 python demo.py nuke |
| 1639 | 43 |
|
7735
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
44 For details see the "For the Really Impatient" section of the |
|
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
45 installation document at: |
|
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
46 |
|
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
47 https://roundup-tracker.org/docs/installation.html#for-the-really-impatient |
|
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
48 |
|
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
49 for details on running demo mode or using the docker demo mode. |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
50 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
51 Tracker Home |
| 7708 | 52 ------------ |
| 53 | |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
54 "Tracker Home" is main concept when starting with Roundup. It is |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
55 directory where all your tracker data is stored. This directory is |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
56 created every time when new tracker is initialized and includes |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
57 tracker configuration, database, template, schema and extensions. |
|
3646
3a9a6b98c6e6
note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents:
1640
diff
changeset
|
58 |
|
7735
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
59 Using Roundup |
|
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
60 ============= |
|
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
61 |
|
7804
aedc1782a6af
doc: remove trailing whitespace.
John Rouillard <rouilj@ieee.org>
parents:
7735
diff
changeset
|
62 Please see the user's guide at: |
|
7735
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
63 |
|
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
64 https://roundup-tracker.org/docs/installation.html#for-the-really-impatient |
|
3646
3a9a6b98c6e6
note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents:
1640
diff
changeset
|
65 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
66 Installation |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
67 ============ |
| 7708 | 68 |
| 69 Please see "doc/installation.txt". For a basic tracker, only the | |
| 70 Python standard library is required. It can be enhanced by adding | |
| 71 other packages. A basic virtual environment install can be done using: | |
| 72 | |
|
94
9cf5229397fc
name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
73 |
| 7708 | 74 python3 -m venv roundup |
| 75 . roundup/bin/activate | |
| 76 python -m pip install roundup | |
| 77 roundup-demo # to start a test demo instance | |
| 78 | |
| 79 See "doc/installation.txt" for details on deploying a production | |
| 80 instance. | |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
81 |
|
796
5324a28060ab
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
791
diff
changeset
|
82 Upgrading |
|
5324a28060ab
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
791
diff
changeset
|
83 ========= |
| 7708 | 84 |
| 85 Please see "doc/upgrading.txt". | |
|
4092
4b0ddce43d08
migrate from MimeWriter to email
Richard Jones <richard@users.sourceforge.net>
parents:
3949
diff
changeset
|
86 |
|
7127
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
87 Security Issues |
|
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
88 =============== |
| 7708 | 89 |
|
7127
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
90 Please see "doc/security.txt" for directions on reporting security issues. |
|
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
91 |
| 7708 | 92 |
|
7735
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
93 Other Information |
|
ac487300590d
docs: update top level readme: user's guide; demo mode refs
John Rouillard <rouilj@ieee.org>
parents:
7708
diff
changeset
|
94 ================= |
| 7708 | 95 |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
96 Start with the index.txt file in the "doc" directory. These |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
97 documentation files are written in reStructedText, which can be |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
98 converted into HTML format. If you have Sphinx installed, you can |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
99 do this by running:: |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
100 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
101 python setup.py build_doc |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
102 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
103 Resulting HTML files will be in "share/doc/roundup/html" directory. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
104 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
105 |
| 7708 | 106 Contributing Guidelines |
| 107 ======================= | |
| 108 | |
| 109 To get started on development or documentation work, read the file | |
| 110 "doc/developers.txt". This documents the project rules, how to set up | |
| 111 a development environment and submit patches and tests. | |
| 112 | |
| 113 Support/Contact | |
| 114 =============== | |
| 115 | |
| 116 Please see https://www.roundup-tracker.org/contact.html for directions | |
| 117 on using email or IRC to contact the developers. | |
|
4563
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
118 |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
119 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
120 License |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
121 ======= |
| 7708 | 122 See COPYING.txt. |
| 123 | |
| 124 tl;dr MIT, Zope version 2, Python Software Foundation version 2 |