mirror of
https://github.com/evroon/bracket.git
synced 2026-04-22 00:07:05 -04:00
9b06700af4
Updates the requirements on [click](https://github.com/pallets/click) to permit the latest version. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/pallets/click/releases">click's releases</a>.</em></p> <blockquote> <h2>8.2.0</h2> <p>This is the Click 8.2.0 feature release. A feature release may include new features, remove previously deprecated code, add new deprecation, or introduce potentially breaking changes.</p> <p>We encourage everyone to upgrade. You can read more about our <a href="https://palletsprojects.com/versions">Version Support Policy</a> on our website.</p> <p>PyPI: <a href="https://pypi.org/project/click/8.2.0/">https://pypi.org/project/click/8.2.0/</a> Changes: <a href="https://click.palletsprojects.com/en/stable/changes/">https://click.palletsprojects.com/en/stable/changes/</a> Milestone <a href="https://github.com/pallets/click/milestone/15">https://github.com/pallets/click/milestone/15</a></p> <ul> <li>Drop support for Python 3.7, 3.8,and 3.9. <a href="https://redirect.github.com/pallets/click/issues/2588">#2588</a>, <a href="https://redirect.github.com/pallets/click/issues/2893">#2893</a></li> <li>Use modern packaging metadata with <code>pyproject.toml</code> instead of <code>setup.cfg</code>. <a href="https://redirect.github.com/pallets/click/issues/2438">#2438</a></li> <li>Use <code>flit_core</code> instead of <code>setuptools</code> as build backend. <a href="https://redirect.github.com/pallets/click/issues/2543">#2543</a></li> <li>Deprecate the <code>__version__</code> attribute. Use feature detection, or <code>importlib.metadata.version("click")</code>, instead. <a href="https://redirect.github.com/pallets/click/issues/2598">#2598</a></li> <li><code>BaseCommand</code> is deprecated. <code>Command</code> is the base class for all commands. <a href="https://redirect.github.com/pallets/click/issues/2589">#2589</a></li> <li><code>MultiCommand</code> is deprecated. <code>Group</code> is the base class for all group commands. <a href="https://redirect.github.com/pallets/click/issues/2590">#2590</a></li> <li>The current parser and related classes and methods, are deprecated. <a href="https://redirect.github.com/pallets/click/issues/2205">#2205</a> <ul> <li><code>OptionParser</code> and the <code>parser</code> module, which is a modified copy of <code>optparse</code> in the standard library.</li> <li><code>Context.protected_args</code> is unneeded. <code>Context.args</code> contains any remaining arguments while parsing.</li> <li><code>Parameter.add_to_parser</code> (on both <code>Argument</code> and <code>Option</code>) is unneeded. Parsing works directly without building a separate parser.</li> <li><code>split_arg_string</code> is moved from <code>parser</code> to <code>shell_completion</code>.</li> </ul> </li> <li>Enable deferred evaluation of annotations with <code>from __future__ import annotations</code>. <a href="https://redirect.github.com/pallets/click/issues/2270">#2270</a></li> <li>When generating a command's name from a decorated function's name, the suffixes <code>_command</code>, <code>_cmd</code>, <code>_group</code>, and <code>_grp</code> are removed. <a href="https://redirect.github.com/pallets/click/issues/2322">#2322</a></li> <li>Show the <code>types.ParamType.name</code> for <code>types.Choice</code> options within <code>--help</code> message if <code>show_choices=False</code> is specified. <a href="https://redirect.github.com/pallets/click/issues/2356">#2356</a></li> <li>Do not display default values in prompts when <code>Option.show_default</code> is <code>False</code>. <a href="https://redirect.github.com/pallets/click/issues/2509">#2509</a></li> <li>Add <code>get_help_extra</code> method on <code>Option</code> to fetch the generated extra items used in <code>get_help_record</code> to render help text. <a href="https://redirect.github.com/pallets/click/issues/2516">#2516</a> <a href="https://redirect.github.com/pallets/click/issues/2517">#2517</a></li> <li>Keep stdout and stderr streams independent in <code>CliRunner</code>. Always collect stderr output and never raise an exception. Add a new output stream to simulate what the user sees in its terminal. Removes the <code>mix_stderr</code> parameter in <code>CliRunner</code>. <a href="https://redirect.github.com/pallets/click/issues/2522">#2522</a> <a href="https://redirect.github.com/pallets/click/issues/2523">#2523</a></li> <li><code>Option.show_envvar</code> now also shows environment variable in error messages. <a href="https://redirect.github.com/pallets/click/issues/2695">#2695</a> <a href="https://redirect.github.com/pallets/click/issues/2696">#2696</a></li> <li><code>Context.close</code> will be called on exit. This results in all <code>Context.call_on_close</code> callbacks and context managers added via <code>Context.with_resource</code> to be closed on exit as well. <a href="https://redirect.github.com/pallets/click/issues/2680">#2680</a></li> <li>Add <code>ProgressBar(hidden: bool)</code> to allow hiding the progressbar. <a href="https://redirect.github.com/pallets/click/issues/2609">#2609</a></li> <li>A <code>UserWarning</code> will be shown when multiple parameters attempt to use the same name. <a href="https://redirect.github.com/pallets/click/issues/2396">#2396</a></li> <li>When using <code>Option.envvar</code> with <code>Option.flag_value</code>, the <code>flag_value</code> will always be used instead of the value of the environment variable. <a href="https://redirect.github.com/pallets/click/issues/2746">#2746</a> <a href="https://redirect.github.com/pallets/click/issues/2788">#2788</a></li> <li>Add <code>Choice.get_invalid_choice_message</code> method for customizing the invalid choice message. <a href="https://redirect.github.com/pallets/click/issues/2621">#2621</a> <a href="https://redirect.github.com/pallets/click/issues/2622">#2622</a></li> <li>If help is shown because <code>no_args_is_help</code> is enabled (defaults to <code>True</code> for groups, <code>False</code> for commands), the exit code is 2 instead of 0. <a href="https://redirect.github.com/pallets/click/issues/1489">#1489</a> <a href="https://redirect.github.com/pallets/click/issues/1489">#1489</a></li> <li>Contexts created during shell completion are closed properly, fixing a <code>ResourceWarning</code> when using <code>click.File</code>. <a href="https://redirect.github.com/pallets/click/issues/2644">#2644</a> <a href="https://redirect.github.com/pallets/click/issues/2800">#2800</a> <a href="https://redirect.github.com/pallets/click/issues/2767">#2767</a></li> <li><code>click.edit(filename)</code> now supports passing an iterable of filenames in case the editor supports editing multiple files at once. Its return type is now also typed: <code>AnyStr</code> if <code>text</code> is passed, otherwise <code>None</code>. <a href="https://redirect.github.com/pallets/click/issues/2067">#2067</a> <a href="https://redirect.github.com/pallets/click/issues/2068">#2068</a></li> <li>Specialized typing of <code>progressbar(length=...)</code> as <code>ProgressBar[int]</code>. <a href="https://redirect.github.com/pallets/click/issues/2630">#2630</a></li> <li>Improve <code>echo_via_pager</code> behaviour in face of errors. <a href="https://redirect.github.com/pallets/click/issues/2674">#2674</a> <ul> <li>Terminate the pager in case a generator passed to <code>echo_via_pager</code> raises an exception.</li> <li>Ensure to always close the pipe to the pager process and wait for it to terminate.</li> <li><code>echo_via_pager</code> will not ignore <code>KeyboardInterrupt</code> anymore. This allows the user to search for future output of the generator when using less and then aborting the program using ctrl-c.</li> </ul> </li> <li><code>deprecated: bool | str</code> can now be used on options and arguments. This previously was only available for <code>Command</code>. The message can now also be customised by using a <code>str</code> instead of a <code>bool</code>. <a href="https://redirect.github.com/pallets/click/issues/2263">#2263</a> <a href="https://redirect.github.com/pallets/click/issues/2271">#2271</a> <ul> <li><code>Command.deprecated</code> formatting in <code>--help</code> changed from <code>(Deprecated) help</code> to <code>help (DEPRECATED)</code>.</li> <li>Parameters cannot be required nor prompted or an error is raised.</li> <li>A warning will be printed when something deprecated is used.</li> </ul> </li> <li>Add a <code>catch_exceptions</code> parameter to <code>CliRunner</code>. If <code>catch_exceptions</code> is not passed to <code>CliRunner.invoke</code>, the value from <code>CliRunner</code> is used. <a href="https://redirect.github.com/pallets/click/issues/2817">#2817</a> <a href="https://redirect.github.com/pallets/click/issues/2818">#2818</a></li> <li><code>Option.flag_value</code> will no longer have a default value set based on <code>Option.default</code> if <code>Option.is_flag</code> is <code>False</code>. This results in <code>Option.default</code> not needing to implement <code>__bool__</code>. <a href="https://redirect.github.com/pallets/click/issues/2829">#2829</a></li> <li>Incorrect <code>click.edit</code> typing has been corrected. <a href="https://redirect.github.com/pallets/click/issues/2804">#2804</a></li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/pallets/click/blob/main/CHANGES.rst">click's changelog</a>.</em></p> <blockquote> <h2>Version 8.2.0</h2> <p>Released 2025-05-10</p> <ul> <li> <p>Drop support for Python 3.7, 3.8, and 3.9. :pr:<code>2588</code> :pr:<code>2893</code></p> </li> <li> <p>Use modern packaging metadata with <code>pyproject.toml</code> instead of <code>setup.cfg</code>. :pr:<code>2438</code></p> </li> <li> <p>Use <code>flit_core</code> instead of <code>setuptools</code> as build backend. :pr:<code>2543</code></p> </li> <li> <p>Deprecate the <code>__version__</code> attribute. Use feature detection, or <code>importlib.metadata.version("click")</code>, instead. :issue:<code>2598</code></p> </li> <li> <p><code>BaseCommand</code> is deprecated. <code>Command</code> is the base class for all commands. :issue:<code>2589</code></p> </li> <li> <p><code>MultiCommand</code> is deprecated. <code>Group</code> is the base class for all group commands. :issue:<code>2590</code></p> </li> <li> <p>The current parser and related classes and methods, are deprecated. :issue:<code>2205</code></p> <ul> <li><code>OptionParser</code> and the <code>parser</code> module, which is a modified copy of <code>optparse</code> in the standard library.</li> <li><code>Context.protected_args</code> is unneeded. <code>Context.args</code> contains any remaining arguments while parsing.</li> <li><code>Parameter.add_to_parser</code> (on both <code>Argument</code> and <code>Option</code>) is unneeded. Parsing works directly without building a separate parser.</li> <li><code>split_arg_string</code> is moved from <code>parser</code> to <code>shell_completion</code>.</li> </ul> </li> <li> <p>Enable deferred evaluation of annotations with <code>from __future__ import annotations</code>. :pr:<code>2270</code></p> </li> <li> <p>When generating a command's name from a decorated function's name, the suffixes <code>_command</code>, <code>_cmd</code>, <code>_group</code>, and <code>_grp</code> are removed. :issue:<code>2322</code></p> </li> <li> <p>Show the <code>types.ParamType.name</code> for <code>types.Choice</code> options within <code>--help</code> message if <code>show_choices=False</code> is specified. :issue:<code>2356</code></p> </li> <li> <p>Do not display default values in prompts when <code>Option.show_default</code> is <code>False</code>. :pr:<code>2509</code></p> </li> <li> <p>Add <code>get_help_extra</code> method on <code>Option</code> to fetch the generated extra items used in <code>get_help_record</code> to render help text. :issue:<code>2516</code> :pr:<code>2517</code></p> </li> <li> <p>Keep stdout and stderr streams independent in <code>CliRunner</code>. Always collect stderr output and never raise an exception. Add a new output stream to simulate what the user sees in its terminal. Removes the <code>mix_stderr</code> parameter in <code>CliRunner</code>. :issue:<code>2522</code> :pr:<code>2523</code></p> </li> <li> <p><code>Option.show_envvar</code> now also shows environment variable in error messages. :issue:<code>2695</code> :pr:<code>2696</code></p> </li> <li> <p><code>Context.close</code> will be called on exit. This results in all <code>Context.call_on_close</code> callbacks and context managers added via <code>Context.with_resource</code> to be closed on exit as well. :pr:<code>2680</code></p> </li> <li> <p>Add <code>ProgressBar(hidden: bool)</code> to allow hiding the progressbar. :issue:<code>2609</code></p> </li> <li> <p>A <code>UserWarning</code> will be shown when multiple parameters attempt to use the</p> </li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="219206a186"><code>219206a</code></a> release version 8.2.0</li> <li><a href="498f882604"><code>498f882</code></a> drop end of life python versions (<a href="https://redirect.github.com/pallets/click/issues/2893">#2893</a>)</li> <li><a href="ba770cbc96"><code>ba770cb</code></a> drop end of life python versions</li> <li><a href="f14b75063f"><code>f14b750</code></a> update dev dependencies</li> <li><a href="9982faee85"><code>9982fae</code></a> Update CHANGES.rst</li> <li><a href="7318f5f11b"><code>7318f5f</code></a> Update CHANGES.rst</li> <li><a href="b7c0ab471c"><code>b7c0ab4</code></a> Merge <code>stable</code> into <code>main</code>; Release 8.2.0 (<a href="https://redirect.github.com/pallets/click/issues/2873">#2873</a>)</li> <li><a href="c9b96fe08d"><code>c9b96fe</code></a> Merge branch 'main' into main</li> <li><a href="ab21233fc8"><code>ab21233</code></a> Rewrite second half of options docs (<a href="https://redirect.github.com/pallets/click/issues/2848">#2848</a>)</li> <li><a href="8c89a14362"><code>8c89a14</code></a> Merge branch 'main' into options_docs_2</li> <li>Additional commits viewable in <a href="https://github.com/pallets/click/compare/8.1.8...8.2.0">compare view</a></li> </ul> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Demo · Documentation · Quickstart · GitHub · Releases
Tournament system meant to be easy to use. Bracket is written in async Python (with FastAPI) and Next.js as frontend using the Mantine library.
It has the following features:
- Supports single elimination, round-robin and swiss formats.
- Build your tournament structure with multiple stages that can have multiple groups/brackets in them.
- Drag-and-drop matches to different courts or reschedule them to another start time.
- Various dashboard pages are available that can be presented to the public, customized with a logo.
- Create/update teams, and add players to teams.
- Create multiple clubs, with multiple tournaments per club.
- Swiss tournaments can be handled dynamically, with automatic scheduling of matches.
Live Demo
A demo is available for free at https://www.bracketapp.nl/demo. The demo lasts for 30 minutes, after which your data will de deleted.
Quickstart
To quickly run bracket to see how it works, clone it and run docker compose up:
git clone git@github.com:evroon/bracket.git
cd bracket
sudo docker compose up -d
This will start the backend and frontend of Bracket, as well as a postgres instance. You should now be able to view bracket at http://localhost:3000. You can log in with the following credentials:
- Username:
test@example.org - Password:
aeGhoe1ahng2Aezai0Dei6Aih6dieHoo.
To insert dummy rows into the database, run:
sudo docker exec bracket-backend pipenv run ./cli.py create-dev-db
See also the quickstart docs.
Usage
Read the usage guide for how to organize a tournament in Bracket from start to finish.
Configuration
Read the configuration docs for how to configure Bracket.
Bracket's backend is configured using .env files (prod.env for production, dev.env for development etc.).
But you can also configure Bracket using environment variables directly, for example by specifying them in the docker-compose.yml.
The frontend doesn't can be configured by environment variables as well, as well as .env files using Next.js' way of loading environment variables.
Running Bracket in production
Read the deployment docs for how to deploy Bracket and run it in production.
Bracket can be run in Docker or by itself (using pipenv and yarn).
Development setup
Read the development docs for how to run Bracket for development.
Prerequisites are yarn, postgresql and pipenv to run the frontend, database and backend.
Translations
Based on your browser settings, your language should be automatically detected and loaded. For now, there's no manual way of choosing a different language.
Supported Languages
To add/refine translations, Crowdin is used. See the docs for more information.
More screenshots
Help
If you're having trouble getting Bracket up and running, or have a question about usage or configuration, feel free to ask. The best place to do this is by creating a Discussion.
Supporting Bracket
If you're using Bracket and would like to help support its development, that would be greatly appreciated!
Several areas that we need a bit of help with at the moment are:
- ⭐ Star Bracket on GitHub
- 🌐 Translating: Help make Bracket available to non-native English speakers by adding your language (via crowdin)
- 📣 Spread the word by sharing Bracket to help new users discover it
- 🖥️ Submit a PR to add a new feature, fix a bug, extend/update the docs or something else
See the contribution docs for more information on how to contribute
Contributors
Erik Vroon |
Null |
BachErik |
Danny Piper |
Sevi C |
Nicolas Vanheuverzwijn |
IzStriker |
Jon Miller |
Max Ricketts-Uy |
Raphael Le Goaller |
License
Bracket is licensed under AGPL-v3.0.
Please note that any contributions also fall under this license.
See LICENSE