-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
32 changed files
with
2,240 additions
and
24 deletions.
There are no files selected for viewing
61 changes: 61 additions & 0 deletions
61
docsrc/apidocs/cookie_composer/cookie_composer.authentication.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| :py:mod:`cookie_composer.authentication` | ||
| ======================================== | ||
|
|
||
| .. py:module:: cookie_composer.authentication | ||
| .. autodoc2-docstring:: cookie_composer.authentication | ||
| :allowtitles: | ||
|
|
||
| Module Contents | ||
| --------------- | ||
|
|
||
| Functions | ||
| ~~~~~~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`get_hosts_file <cookie_composer.authentication.get_hosts_file>` | ||
| - .. autodoc2-docstring:: cookie_composer.authentication.get_hosts_file | ||
| :summary: | ||
| * - :py:obj:`login_to_svc <cookie_composer.authentication.login_to_svc>` | ||
| - .. autodoc2-docstring:: cookie_composer.authentication.login_to_svc | ||
| :summary: | ||
| * - :py:obj:`get_cached_token <cookie_composer.authentication.get_cached_token>` | ||
| - .. autodoc2-docstring:: cookie_composer.authentication.get_cached_token | ||
| :summary: | ||
| * - :py:obj:`add_auth_to_url <cookie_composer.authentication.add_auth_to_url>` | ||
| - .. autodoc2-docstring:: cookie_composer.authentication.add_auth_to_url | ||
| :summary: | ||
| * - :py:obj:`github_auth_device <cookie_composer.authentication.github_auth_device>` | ||
| - .. autodoc2-docstring:: cookie_composer.authentication.github_auth_device | ||
| :summary: | ||
|
|
||
| API | ||
| ~~~ | ||
|
|
||
| .. py:function:: get_hosts_file() -> pathlib.Path | ||
| :canonical: cookie_composer.authentication.get_hosts_file | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.authentication.get_hosts_file | ||
|
|
||
| .. py:function:: login_to_svc(service: typing.Optional[str] = None, protocol: typing.Optional[str] = None, scopes: typing.Optional[str] = None, token: typing.Optional[str] = None) -> str | ||
| :canonical: cookie_composer.authentication.login_to_svc | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.authentication.login_to_svc | ||
|
|
||
| .. py:function:: get_cached_token(account_name: str) -> typing.Optional[str] | ||
| :canonical: cookie_composer.authentication.get_cached_token | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.authentication.get_cached_token | ||
|
|
||
| .. py:function:: add_auth_to_url(url: str) -> str | ||
| :canonical: cookie_composer.authentication.add_auth_to_url | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.authentication.add_auth_to_url | ||
|
|
||
| .. py:function:: github_auth_device(n_polls: int = 9999) -> typing.Optional[str] | ||
| :canonical: cookie_composer.authentication.github_auth_device | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.authentication.github_auth_device |
102 changes: 102 additions & 0 deletions
102
docsrc/apidocs/cookie_composer/cookie_composer.cc_overrides.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| :py:mod:`cookie_composer.cc_overrides` | ||
| ====================================== | ||
|
|
||
| .. py:module:: cookie_composer.cc_overrides | ||
| .. autodoc2-docstring:: cookie_composer.cc_overrides | ||
| :allowtitles: | ||
|
|
||
| Module Contents | ||
| --------------- | ||
|
|
||
| Classes | ||
| ~~~~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`JsonifyContextExtension <cookie_composer.cc_overrides.JsonifyContextExtension>` | ||
| - .. autodoc2-docstring:: cookie_composer.cc_overrides.JsonifyContextExtension | ||
| :summary: | ||
| * - :py:obj:`CustomStrictEnvironment <cookie_composer.cc_overrides.CustomStrictEnvironment>` | ||
| - .. autodoc2-docstring:: cookie_composer.cc_overrides.CustomStrictEnvironment | ||
| :summary: | ||
|
|
||
| Functions | ||
| ~~~~~~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`jsonify_context <cookie_composer.cc_overrides.jsonify_context>` | ||
| - .. autodoc2-docstring:: cookie_composer.cc_overrides.jsonify_context | ||
| :summary: | ||
| * - :py:obj:`update_extensions <cookie_composer.cc_overrides.update_extensions>` | ||
| - .. autodoc2-docstring:: cookie_composer.cc_overrides.update_extensions | ||
| :summary: | ||
| * - :py:obj:`prompt_for_config <cookie_composer.cc_overrides.prompt_for_config>` | ||
| - .. autodoc2-docstring:: cookie_composer.cc_overrides.prompt_for_config | ||
| :summary: | ||
| * - :py:obj:`_render_dicts <cookie_composer.cc_overrides._render_dicts>` | ||
| - .. autodoc2-docstring:: cookie_composer.cc_overrides._render_dicts | ||
| :summary: | ||
| * - :py:obj:`_render_simple <cookie_composer.cc_overrides._render_simple>` | ||
| - .. autodoc2-docstring:: cookie_composer.cc_overrides._render_simple | ||
| :summary: | ||
|
|
||
| API | ||
| ~~~ | ||
|
|
||
| .. py:function:: jsonify_context(value: typing.Any) -> typing.MutableMapping | ||
| :canonical: cookie_composer.cc_overrides.jsonify_context | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cc_overrides.jsonify_context | ||
|
|
||
| .. py:class:: JsonifyContextExtension(environment: jinja2.Environment) | ||
| :canonical: cookie_composer.cc_overrides.JsonifyContextExtension | ||
|
|
||
| Bases: :py:obj:`jinja2.ext.Extension` | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cc_overrides.JsonifyContextExtension | ||
|
|
||
| .. rubric:: Initialization | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cc_overrides.JsonifyContextExtension.__init__ | ||
|
|
||
| .. py:class:: CustomStrictEnvironment(**kwargs) | ||
| :canonical: cookie_composer.cc_overrides.CustomStrictEnvironment | ||
|
|
||
| Bases: :py:obj:`cookiecutter.environment.StrictEnvironment` | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cc_overrides.CustomStrictEnvironment | ||
|
|
||
| .. rubric:: Initialization | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cc_overrides.CustomStrictEnvironment.__init__ | ||
|
|
||
| .. py:method:: _read_extensions(context: typing.MutableMapping[str, typing.Any]) -> typing.List[str] | ||
| :canonical: cookie_composer.cc_overrides.CustomStrictEnvironment._read_extensions | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cc_overrides.CustomStrictEnvironment._read_extensions | ||
|
|
||
| .. py:function:: update_extensions(existing_config: typing.MutableMapping[str, typing.Any], prompts: typing.MutableMapping[str, typing.Any]) -> typing.List[str] | ||
| :canonical: cookie_composer.cc_overrides.update_extensions | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cc_overrides.update_extensions | ||
|
|
||
| .. py:function:: prompt_for_config(prompts: dict, aggregated_context: cookie_composer.data_merge.Context, layer_context: typing.Optional[typing.MutableMapping[str, typing.Any]] = None, no_input: bool = False) -> typing.MutableMapping[str, typing.Any] | ||
| :canonical: cookie_composer.cc_overrides.prompt_for_config | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cc_overrides.prompt_for_config | ||
|
|
||
| .. py:function:: _render_dicts(context: typing.MutableMapping, env: jinja2.Environment, no_input: bool, prompts: dict) -> None | ||
| :canonical: cookie_composer.cc_overrides._render_dicts | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cc_overrides._render_dicts | ||
|
|
||
| .. py:function:: _render_simple(context: typing.MutableMapping, context_prompts: dict, env: jinja2.Environment, no_input: bool, prompts: dict) -> None | ||
| :canonical: cookie_composer.cc_overrides._render_simple | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cc_overrides._render_simple |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| :py:mod:`cookie_composer.cli` | ||
| ============================= | ||
|
|
||
| .. py:module:: cookie_composer.cli | ||
| .. autodoc2-docstring:: cookie_composer.cli | ||
| :allowtitles: | ||
|
|
||
| Module Contents | ||
| --------------- | ||
|
|
||
| Functions | ||
| ~~~~~~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`cli <cookie_composer.cli.cli>` | ||
| - .. autodoc2-docstring:: cookie_composer.cli.cli | ||
| :summary: | ||
| * - :py:obj:`validate_context_params <cookie_composer.cli.validate_context_params>` | ||
| - .. autodoc2-docstring:: cookie_composer.cli.validate_context_params | ||
| :summary: | ||
| * - :py:obj:`create <cookie_composer.cli.create>` | ||
| - .. autodoc2-docstring:: cookie_composer.cli.create | ||
| :summary: | ||
| * - :py:obj:`add <cookie_composer.cli.add>` | ||
| - .. autodoc2-docstring:: cookie_composer.cli.add | ||
| :summary: | ||
| * - :py:obj:`update <cookie_composer.cli.update>` | ||
| - .. autodoc2-docstring:: cookie_composer.cli.update | ||
| :summary: | ||
| * - :py:obj:`link <cookie_composer.cli.link>` | ||
| - .. autodoc2-docstring:: cookie_composer.cli.link | ||
| :summary: | ||
|
|
||
| Data | ||
| ~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`logger <cookie_composer.cli.logger>` | ||
| - .. autodoc2-docstring:: cookie_composer.cli.logger | ||
| :summary: | ||
|
|
||
| API | ||
| ~~~ | ||
|
|
||
| .. py:data:: logger | ||
| :canonical: cookie_composer.cli.logger | ||
| :value: None | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cli.logger | ||
|
|
||
| .. py:function:: cli() -> None | ||
| :canonical: cookie_composer.cli.cli | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cli.cli | ||
|
|
||
| .. py:function:: validate_context_params(ctx: typing.Any, param: typing.Any, value: list) -> typing.Optional[collections.OrderedDict] | ||
| :canonical: cookie_composer.cli.validate_context_params | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cli.validate_context_params | ||
|
|
||
| .. py:function:: create(no_input: bool, checkout: str, directory: str, overwrite_if_exists: bool, skip_if_file_exists: bool, default_config: bool, destination: pathlib.Path, accept_hooks: str, path_or_url: str, context_params: typing.Optional[typing.MutableMapping[str, typing.Any]] = None) -> None | ||
| :canonical: cookie_composer.cli.create | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cli.create | ||
|
|
||
| .. py:function:: add(no_input: bool, checkout: str, directory: str, overwrite_if_exists: bool, skip_if_file_exists: bool, default_config: bool, destination: pathlib.Path, accept_hooks: str, path_or_url: str, context_params: typing.Optional[typing.MutableMapping[str, typing.Any]] = None) -> None | ||
| :canonical: cookie_composer.cli.add | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cli.add | ||
|
|
||
| .. py:function:: update(no_input: bool, destination: pathlib.Path, context_params: typing.Optional[collections.OrderedDict] = None) -> None | ||
| :canonical: cookie_composer.cli.update | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cli.update | ||
|
|
||
| .. py:function:: link(no_input: bool, checkout: str, directory: str, overwrite_if_exists: bool, skip_if_file_exists: bool, default_config: bool, destination: typing.Optional[pathlib.Path], path_or_url: str, context_params: typing.Optional[typing.MutableMapping[str, typing.Any]] = None) -> None | ||
| :canonical: cookie_composer.cli.link | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.cli.link |
46 changes: 46 additions & 0 deletions
46
docsrc/apidocs/cookie_composer/cookie_composer.commands.add.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| :py:mod:`cookie_composer.commands.add` | ||
| ====================================== | ||
|
|
||
| .. py:module:: cookie_composer.commands.add | ||
| .. autodoc2-docstring:: cookie_composer.commands.add | ||
| :allowtitles: | ||
|
|
||
| Module Contents | ||
| --------------- | ||
|
|
||
| Functions | ||
| ~~~~~~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`add_cmd <cookie_composer.commands.add.add_cmd>` | ||
| - .. autodoc2-docstring:: cookie_composer.commands.add.add_cmd | ||
| :summary: | ||
|
|
||
| Data | ||
| ~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`logger <cookie_composer.commands.add.logger>` | ||
| - .. autodoc2-docstring:: cookie_composer.commands.add.logger | ||
| :summary: | ||
|
|
||
| API | ||
| ~~~ | ||
|
|
||
| .. py:data:: logger | ||
| :canonical: cookie_composer.commands.add.logger | ||
| :value: None | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.commands.add.logger | ||
|
|
||
| .. py:function:: add_cmd(path_or_url: str, destination_dir: typing.Optional[pathlib.Path] = None, no_input: bool = False, checkout: typing.Optional[str] = None, directory: typing.Optional[str] = None, overwrite_if_exists: bool = False, skip_if_file_exists: bool = False, default_config: bool = False, accept_hooks: str = 'all', initial_context: typing.Optional[typing.MutableMapping[str, typing.Any]] = None) -> None | ||
| :canonical: cookie_composer.commands.add.add_cmd | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.commands.add.add_cmd |
45 changes: 45 additions & 0 deletions
45
docsrc/apidocs/cookie_composer/cookie_composer.commands.authn.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| :py:mod:`cookie_composer.commands.authn` | ||
| ======================================== | ||
|
|
||
| .. py:module:: cookie_composer.commands.authn | ||
| .. autodoc2-docstring:: cookie_composer.commands.authn | ||
| :allowtitles: | ||
|
|
||
| Module Contents | ||
| --------------- | ||
|
|
||
| Functions | ||
| ~~~~~~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`auth <cookie_composer.commands.authn.auth>` | ||
| - .. autodoc2-docstring:: cookie_composer.commands.authn.auth | ||
| :summary: | ||
| * - :py:obj:`login <cookie_composer.commands.authn.login>` | ||
| - .. autodoc2-docstring:: cookie_composer.commands.authn.login | ||
| :summary: | ||
| * - :py:obj:`token <cookie_composer.commands.authn.token>` | ||
| - .. autodoc2-docstring:: cookie_composer.commands.authn.token | ||
| :summary: | ||
|
|
||
| API | ||
| ~~~ | ||
|
|
||
| .. py:function:: auth() -> None | ||
| :canonical: cookie_composer.commands.authn.auth | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.commands.authn.auth | ||
|
|
||
| .. py:function:: login(git_protocol: str, service: str, scopes: str, with_token: rich_click.File) -> None | ||
| :canonical: cookie_composer.commands.authn.login | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.commands.authn.login | ||
|
|
||
| .. py:function:: token(service: str) -> None | ||
| :canonical: cookie_composer.commands.authn.token | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.commands.authn.token |
46 changes: 46 additions & 0 deletions
46
docsrc/apidocs/cookie_composer/cookie_composer.commands.create.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| :py:mod:`cookie_composer.commands.create` | ||
| ========================================= | ||
|
|
||
| .. py:module:: cookie_composer.commands.create | ||
| .. autodoc2-docstring:: cookie_composer.commands.create | ||
| :allowtitles: | ||
|
|
||
| Module Contents | ||
| --------------- | ||
|
|
||
| Functions | ||
| ~~~~~~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`create_cmd <cookie_composer.commands.create.create_cmd>` | ||
| - .. autodoc2-docstring:: cookie_composer.commands.create.create_cmd | ||
| :summary: | ||
|
|
||
| Data | ||
| ~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`logger <cookie_composer.commands.create.logger>` | ||
| - .. autodoc2-docstring:: cookie_composer.commands.create.logger | ||
| :summary: | ||
|
|
||
| API | ||
| ~~~ | ||
|
|
||
| .. py:data:: logger | ||
| :canonical: cookie_composer.commands.create.logger | ||
| :value: None | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.commands.create.logger | ||
|
|
||
| .. py:function:: create_cmd(path_or_url: str, output_dir: typing.Optional[pathlib.Path] = None, no_input: bool = False, checkout: typing.Optional[str] = None, directory: typing.Optional[str] = None, overwrite_if_exists: bool = False, skip_if_file_exists: bool = False, default_config: bool = False, accept_hooks: str = 'all', initial_context: typing.Optional[typing.MutableMapping[str, typing.Any]] = None) -> pathlib.Path | ||
| :canonical: cookie_composer.commands.create.create_cmd | ||
|
|
||
| .. autodoc2-docstring:: cookie_composer.commands.create.create_cmd |
Oops, something went wrong.