Mercurial > p > roundup > code
view README.txt @ 7752:b2dbab2b34bc
fix(refactor): multiple fixups using ruff linter; more testing.
Converting to using the ruff linter and its rulesets. Fixed a number
of issues.
admin.py:
sort imports
use immutable tuples as default value markers for parameters where a
None value is valid.
reduced some loops to list comprehensions for performance
used ternary to simplify some if statements
named some variables to make them less magic
(e.g. _default_savepoint_setting = 1000)
fixed some tests for argument counts < 2 becomes != 2 so 3 is an
error.
moved exception handlers outside of loops for performance where
exception handler will abort loop anyway.
renamed variables called 'id' or 'dir' as they shadow builtin
commands.
fix translations of form _("string %s" % value) -> _("string %s") %
value so translation will be looked up with the key before
substitution.
end dicts, tuples with a trailing comma to reduce missing comma
errors if modified
simplified sorted(list(self.setting.keys())) to
sorted(self.setting.keys()) as sorted consumes whole list.
in if conditions put compared variable on left and threshold condition
on right. (no yoda conditions)
multiple noqa: suppression
removed unneeded noqa as lint rulesets are a bit different
do_get - refactor output printing logic: Use fast return if not
special formatting is requested; use isinstance with a tuple
rather than two isinstance calls; cleaned up flow and removed
comments on algorithm as it can be easily read from the code.
do_filter, do_find - refactor output printing logic. Reduce
duplicate code.
do_find - renamed variable 'value' that was set inside a loop. The
loop index variable was also named 'value'.
do_pragma - added hint to use list subcommand if setting was not
found. Replaced condition 'type(x) is bool' with 'isinstance(x,
bool)' for various types.
test_admin.py
added testing for do_list
better test coverage for do_get includes: -S and -d for multilinks,
error case for -d with non-link.
better testing for do_find including all output modes
better testing for do_filter including all output modes
fixed expected output for do_pragma that now includes hint to use
pragma list if setting not found.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Fri, 01 Mar 2024 14:53:18 -0500 |
| parents | ac487300590d |
| children | aedc1782a6af |
line wrap: on
line source
======================================================= Roundup: an Issue-Tracking System for Knowledge Workers ======================================================= Introduction ============ Roundup is a tool for creating issue trackers. This includes: * bug trackers, * help desk, * agile development trackers, * customer issue tracking, * fleet maintenance tracking, * GTD tool etc. It comes with predefined trackers meant to be customized for your workflow. Starting trackers include: * generic tracker, * development bug/feature tracker (3 variations), * bare bones minimal tracker. Your users interact with (create, read, update, close) issues using a web interface or by email. It can be programmaticly managed via REST or XMLRPC, CLI, or via local Python scripts. The user's guide is at https://www.roundup-tracker.org/docs/user_guide.html. INSTANT GRATIFICATION ===================== The impatient may try Roundup immediately by running demo.py from the source directory:: python demo.py This will create new tracker home in "demo" subdirectory and start a web server. To reset demo instance:: python demo.py nuke For details see the "For the Really Impatient" section of the installation document at: https://roundup-tracker.org/docs/installation.html#for-the-really-impatient for details on running demo mode or using the docker demo mode. Tracker Home ------------ "Tracker Home" is main concept when starting with Roundup. It is directory where all your tracker data is stored. This directory is created every time when new tracker is initialized and includes tracker configuration, database, template, schema and extensions. Using Roundup ============= Please see the user's guide at: https://roundup-tracker.org/docs/installation.html#for-the-really-impatient Installation ============ Please see "doc/installation.txt". For a basic tracker, only the Python standard library is required. It can be enhanced by adding other packages. A basic virtual environment install can be done using: python3 -m venv roundup . roundup/bin/activate python -m pip install roundup roundup-demo # to start a test demo instance See "doc/installation.txt" for details on deploying a production instance. Upgrading ========= Please see "doc/upgrading.txt". Security Issues =============== Please see "doc/security.txt" for directions on reporting security issues. Other Information ================= Start with the index.txt file in the "doc" directory. These documentation files are written in reStructedText, which can be converted into HTML format. If you have Sphinx installed, you can do this by running:: python setup.py build_doc Resulting HTML files will be in "share/doc/roundup/html" directory. Contributing Guidelines ======================= To get started on development or documentation work, read the file "doc/developers.txt". This documents the project rules, how to set up a development environment and submit patches and tests. Support/Contact =============== Please see https://www.roundup-tracker.org/contact.html for directions on using email or IRC to contact the developers. License ======= See COPYING.txt. tl;dr MIT, Zope version 2, Python Software Foundation version 2