annotate website/www/code.txt @ 8519:19152fd94fcf

bug: move import findargspec out of Permission __init__ method We have a few places where imports are done inside a method/function. For methods that are called once it's not an issue but the Permissions __init__ method is called often and accounts for > 10% of the time in the __init__ function when looking at wsgi-lineprof output. So move it to the module level.
author John Rouillard <rouilj@ieee.org>
date Mon, 02 Feb 2026 23:41:36 -0500
parents 141225d2981e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7048
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 6370
diff changeset
1 .. meta::
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 6370
diff changeset
2 :description:
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 6370
diff changeset
3 Information for developers of Roundup. Including directions on
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 6370
diff changeset
4 checking code from repository, how to run demo mode and
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 6370
diff changeset
5 execute tests.
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 6370
diff changeset
6
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
7 Code
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
8 ====
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
9
5018
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
10 Project history is maintained in `CHANGES.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt>`_
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
11 file in code repository of Roundup, which can also be viewed online
6370
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 5058
diff changeset
12 through SourceForge `web interface <https://sourceforge.net/p/roundup/code/ci/default/tree/>`_.
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
13
5057
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
14 Get sources
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
15 -----------
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
16
5018
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
17 Official **read-only access** to Mercurial repository is provided through ::
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
18
5017
98344ba5e157 website: Update "getting code" documentation
anatoly techtonik <techtonik@gmail.com>
parents: 4829
diff changeset
19 hg clone http://hg.code.sf.net/p/roundup/code roundup
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
20
5018
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
21 **Read/write access** requires SSH password or SSH key
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
22 authorization (see `SourceForge.net docs for details
4775
d00a3ede67e4 Changing www/code.txt towards new SF paths.
Bernhard Reiter <bernhard@intevation.de>
parents: 4596
diff changeset
23 <https://sourceforge.net/p/forge/documentation/Mercurial/>`_) ::
4552
68d647848ffc nicer formatting
Richard Jones <richard@users.sourceforge.net>
parents: 4549
diff changeset
24
5017
98344ba5e157 website: Update "getting code" documentation
anatoly techtonik <techtonik@gmail.com>
parents: 4829
diff changeset
25 hg clone ssh://USERNAME@hg.code.sf.net/p/roundup/code roundup
4552
68d647848ffc nicer formatting
Richard Jones <richard@users.sourceforge.net>
parents: 4549
diff changeset
26
7924
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
27 You also need to be added as a Roundup developer for write access -
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
28 ask for it on the :doc:`roundup-devel list <contact>`.
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
29
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
30 You can also use the Roundup mirror on GitHub. It lags behind the
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
31 Mercurial repository, but is usually only a couple of weeks old. You
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
32 can clone it using::
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
33
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
34 git clone https://github.com/roundup-tracker/roundup.git
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
35
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
36 Note that even though we have a mirror on GitHub we don't use Issues
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
37 (use https://issues.roundup-tracker.org) or Pull requests. The GitHub
141225d2981e doc: add directions to get "current" development code from GitHub.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
38 mirror is used for CI.
5057
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
39
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
40 Run demo
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
41 --------
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
42
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
43 Roundup doesn't need any dependencies and works out of the box. Demo
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
44 is accessible at http://localhost:8917/demo/ by default ::
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
45
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
46 cd roundup
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
47 python demo.py
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
48
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
49 Execute tests
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
50 -------------
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
51 ::
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
52
7048
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 6370
diff changeset
53 python -m pytest test
5057
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
54
5058
c36ad0ba6aa3 www: Fix link to README.txt
anatoly techtonik <techtonik@gmail.com>
parents: 5057
diff changeset
55 See repository `README.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/README.txt>`_
5057
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
56 for more info.

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