# packages

pkgId: b97168bcea15a41350a3a32e7ff55a156a2519c9c2d3487438d869b6160f46c7
name: python-bigeye-cli
arch: src
version: 0.3.67
epoch: 0
release: 1
summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
url: https://docs.bigeye.com/docs
rpm_license: Proprietary
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigeye-cli-0.3.67-1.src.rpm
checksum_type: sha256
description:
  Version: 0.3.67


  **Setting up your local/build environment**
  Mac with Pyenv

  1. Install [brew](https://brew.sh/)
  2. Install [pyenv](https://formulae.brew.sh/formula/pyenv)
  3. Install python and define a default global:

  ```text
  pyenv install 3.9.13
  pyenv global 3.9.13
  ```

  Conda
  Install [conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html)
  Create environment with python3.9 or greater

  ```text
  conda create -n bigeye_env python=3.9
  conda activate bigeye_env
  ```

  Linux
  Most linux distributes include a default python distribution and we recommend using that default.

  **Installing Bigeye-CLI**

  You can install the Bigeye-CLI from your command line with the following command:

  ```text
  pip3 install bigeye-cli
  ```



  Before using the Bigeye CLI, you will need to configure your Bigeye credentials and workspaces. You can do this in the following ways:

  - Configuration Command
  - Environment Variables
  - Credentials and Configuration Files


  The quickest way to get started using the Bigeye CLI is to run the `bigeye configure` command. This command will walk you through the options to establish default credentials and configurations for the Bigeye CLI.


  ```console
  $ bigeye configure
  ```

  Using the bigeye configure command, there are two ways to authenticate: basic authentication and browser authentication.



  If you select basic authentication, the CLI will prompt you to enter your Bigeye username and password. This will create a default credential file at ~/.bigeye/credentials. This credential will be used for all CLI commands
  unless an environment variable is explicitly provided.



  Alternatively, you can use browser authentication (Linux/Mac OS only). Login to your bigeye workspace on a Chrome, Chromium or
  Firefox browser. Run **bigeye configure** and select browser_auth when prompted in the CLI and follow the
  instructions. If you use Chrome profiles, make sure to specify the profile email address you are logged into.

  Note: Your authentication will only be valid so long as your browser session is active. Not supported with SSO enabled.



  You can create an environment variable for your workspace credential and configuration files, this is helpful if you would like to store your credential and configuration files some place other than their default locations (~/.bigeye). You can do this by adding the following to your ~/.bashrc or ~/.zshrc file. Please review the format of these files in the below sections.

  ```shell
  export BIGEYE_API_CRED_FILE=/some/path/to/credentials.ini
  export BIGEYE_API_CONFIG_FILE=/some/path/to/config.ini
  ```



  Lastly, if you want to specify the credential per command, you can always pass a -b parameter with the file path for the desired credential. You can pass a -c parameter with the file path for the desired configuration.

  _Sample credentials file:_

  ```ini Text
  [DEFAULT]
  base_url = https://app.bigeye.com
  user = some_user@bigeye.com
  password = fakepassword1234
  ```

  _Sample configuration file:_

  ```ini
  [DEFAULT]
  workspace_id = 123
  ```



  The configuration files can help to simplify other CLI commands by defining common options in one file. See
  the table below for the complete list of configuration options.

  | **Key**                | **Description**                                                                                     | **Type**      | **Example**                            |
  | ---------------------- | --------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------- |
  | workspace_id           | The id for the workspace [Required]                                                                 | Int           | 123                                    |
  | use_default_credential | Whether or not a unique credential is required for this workspace. Default: True                    | Bool          | True                                   |
  | bigconfig_input_path   | The path(s) to bigconfig files that are used for the given workspace.                               | List[strings] | path/bigconfig.yml,path2/bigconfig.yml |
  | bigconfig_output_path  | The path used to output bigconfig PLAN reports and FIXME files.                                     | String        | output/bigconfig_reports/              |
  | bigconfig_strict_mode  | API errors cause an exception if True. (Validation errors still cause an exception). Default: False | Bool          | False                                  |
  | bigconfig_auto_approve | Bigconfig applies should be allowed to run without excplit plan approvals. Default: False           | Bool          | False                                  |


  The configuration options above can be manually set directly in your config.ini files or you can utilize the below command to set the config values.

  ```console
  $ bigeye configure set <setting_key> <value> [OPTIONAL WORKSPACE]
  $ bigeye configure set bigconfig_input_path path/bigconfig.yml,path2/bigconfig -w data-science
  ```

  To view the current value of any specific configuration you can either open the config.ini file or utilize the below command.

  ```console
  $ bigeye configure get <setting_key> [OPTIONAL WORKSPACE]
  $ bigeye configure get bigconfig_input_path -w data-science
  ```



  The credential and configuration files are designed to allow Bigeye CLI users to easily switch between their Bigeye workspaces. Each file enforces the idea of a `DEFAULT` section. All subsequent CLI commands will inherit the properties defined in the `DEFAULT`section unless they are directed otherwise. Every command in the Bigeye CLI has the ability to provide a `--workspace` (`-w`) option to override the use of the default workspace.

  To setup a non-default workspace, run the following command:

  ```console
  $ bigeye configure -w data-science
  ```

  Or, open up the files and manually edit them based on your setup. Here are some samples.

  _Sample configuration file with multiple workspaces:_

  ```ini
  [DEFAULT]
  workspace_id = 123
  bigconfig_input_path = absolute_path/bigconfig.yml,absolute_path2/bigconfig.yml
  bigconfig_output_path = absolute_path/output/

  [workspace data-science]
  workspace_id = 234
  use_default_credential = True
  bigconfig_input_path = absolute_path/ds/bigconfig.yml,absolute_path2/ds/bigconfig.yml

  [workspace dev]
  workspace_id = 100
  use_default_credential = False
  bigconfig_auto_approve = True
  bigconfig_input_path = absolute_path/bigconfig.yml,absolute_path2/bigconfig.yml
  ```

  _Sample credentials file with multiple workspaces:_

  ```ini
  [DEFAULT]
  base_url = https://app.bigeye.com
  user = some_user@bigeye.com
  password = fakepassword1234

  [dev]
  base_url = https://app.bigeye.com
  user = some_user@bigeye.com
  password = fakepassword1234
  ```

  **Note:** Most use cases will only require you to have a single `DEFAULT` credential that all workspaces can utilize. Running the `bigeye configure -w <workspace-name>` command for a non-default workspace will prompt you to inherit the credentials from default or create a new set of credentials. A workspace credential is only required if the `use_default_credential` setting is set to False in the configuration of the corresponding workspace.



  Configuration Commands for Bigeye CLI

  **Usage**:

  ```console
  $ bigeye configure [OPTIONS] COMMAND [ARGS]...
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `--install-completion`: Install completion for the current shell.
  * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
  * `--help`: Show this message and exit.

  **Commands**:

  * `set`: Set any specific configuration settings.
  * `get`: Get any specific configuration settings.
  * `list`: List all configured workspaces.



  Set any specific configuration settings.

  **Usage**:

  ```console
  $ bigeye configure set [OPTIONS] [SETTING_KEY] [SETTING_VALUE]
  ```

  **Arguments**:

  * `[SETTING_KEY]`: The name of the configuration setting.
  * `[SETTING_VALUE]`: The value of the configuration setting.

  **Options**:

  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `--help`: Show this message and exit.



  Get any specific configuration settings.

  **Usage**:

  ```console
  $ bigeye configure get [OPTIONS] [SETTING_KEY]
  ```

  **Arguments**:

  * `[SETTING_KEY]`: The name of the configuration setting.

  **Options**:

  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `--help`: Show this message and exit.



  List all configured workspaces.

  **Usage**:

  ```console
  $ bigeye configure list [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `--help`: Show this message and exit.



  Workspace Commands for Bigeye CLI

  **Usage**:

  ```console
  $ bigeye workspace [OPTIONS] COMMAND [ARGS]...
  ```

  **Options**:

  * `--install-completion`: Install completion for the current shell.
  * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
  * `--help`: Show this message and exit.

  **Commands**:

  * `unschedule-all-metrics`: Unschedule all metrics in a workspace.
  * `schedule-all-metrics`: Schedule all metrics in a workspace.
  * `create-named-schedule`: Create a named, cron based schedule
  * `upsert-named-schedule`: Create a named, cron based schedule.
  * `delete-named-schedule`: Delete a named schedule.
  * `export-named-schedule`: Export cron schedule to yaml file
  * `invite-user`: Invite a user to a workspace.
  * `edit-user`: Edit an existing user's access to groups.
  * `delete-user`: Deletes a users account.
  * `upsert-workspace`: Create or update a workspace.
  * `delete-workspace`: Delete a workspace.
  * `upsert-group`: Create or update a group.
  * `edit-group-access`: Edit the workspaces that a group can access.
  * `delete-group`: Delete a group.



  Unschedule all metrics in a workspace.

  **Usage**:

  ```console
  $ bigeye workspace unschedule-all-metrics [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `--help`: Show this message and exit.



  Schedule all metrics in a workspace.

  **Usage**:

  ```console
  $ bigeye workspace schedule-all-metrics [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-type, --time_interval_type INTEGER`: Time interval type.
   UNDEFINED_TIME_INTERVAL_TYPE:0
  HOURS_TIME_INTERVAL_TYPE:1
  MINUTES_TIME_INTERVAL_TYPE:2
  SECONDS_TIME_INTERVAL_TYPE:3
  DAYS_TIME_INTERVAL_TYPE:4
  WEEKDAYS_TIME_INTERVAL_TYPE:5
  MARKET_DAYS_TIME_INTERVAL_TYPE:6
  MONTHS_TIME_INTERVAL_TYPE:7  [default: 1]
  * `-value, --interval_value INTEGER`: Number of intervals to set on all metric schedules.  If 0 use unschedule all metrics.  [required]
  * `--help`: Show this message and exit.



  Create a named, cron based schedule

  **Usage**:

  ```console
  $ bigeye workspace create-named-schedule [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-sn, --name TEXT`: The user defined name of the schedule  [required]
  * `-c, --cron TEXT`: The cron string to define the schedule  [required]
  * `--help`: Show this message and exit.



  Create a named, cron based schedule. Files have priority over arguments

  **Usage**:

  ```console
  $ bigeye workspace upsert-named-schedule [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-sn, --name TEXT`: The user defined name of the schedule
  * `-c, --cron TEXT`: The cron string to define the schedule
  * `-sf, --schedule_file TEXT`: A yaml file containing a schedule definition.
  * `--help`: Show this message and exit.



  Delete a named schedule.

  **Usage**:

  ```console
  $ bigeye workspace delete-named-schedule [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-sn, --name TEXT`: The user defined name of the schedule  [required]
  * `--help`: Show this message and exit.



  Export cron schedule to yaml file

  **Usage**:

  ```console
  $ bigeye workspace export-named-schedule [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-sn, --name TEXT`: The name of the schedule(s) to export. None means all
  * `-op, --output_path TEXT`: Path to output files. None means current directory
  * `--help`: Show this message and exit.



  Invite a user to a workspace.

  **Usage**:

  ```console
  $ bigeye workspace invite-user [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-name, --user_name TEXT`: User name.  [required]
  * `-email, --user_email TEXT`: Email where invite will be sent.  [required]
  * `-group, --group_name TEXT`: The names of the groups that the user should belong to. E.g. -group team1 -group team2
  * `--help`: Show this message and exit.



  Edit an existing user's access to groups.

  **Usage**:

  ```console
  $ bigeye workspace edit-user [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-name, --user_name TEXT`: User name.
  * `-email, --user_email TEXT`: User email.
  * `-group, --group_name TEXT`: The names of the groups that should be edited for this users access. E.g. -group team1 -group team2  [required]
  * `-op, --operation INTEGER`: Operation type.
   GROUP_USER_OPERATION_UNSPECIFIED:0
  GROUP_USER_OPERATION_ADD:1
  GROUP_USER_OPERATION_REMOVE:2  [default: 1]
  * `--help`: Show this message and exit.



  Deletes a users account.

  **Usage**:

  ```console
  $ bigeye workspace delete-user [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-name, --user_name TEXT`: User name.
  * `-email, --user_email TEXT`: User email.
  * `--help`: Show this message and exit.



  Create or update a workspace.

  **Usage**:

  ```console
  $ bigeye workspace upsert-workspace [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-name, --workspace_name TEXT`: Workspace name.  [required]
  * `-id, --workspace_id INTEGER`: Workspace ID.
  * `--help`: Show this message and exit.



  Delete a workspace.

  **Usage**:

  ```console
  $ bigeye workspace delete-workspace [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-name, --workspace_name TEXT`: Workspace name.  [required]
  * `--help`: Show this message and exit.



  Create or update a group.

  **Usage**:

  ```console
  $ bigeye workspace upsert-group [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-name, --group_name TEXT`: Group name.  [required]
  * `-id, --group_id INTEGER`: Group ID.
  * `--help`: Show this message and exit.



  Edit the workspaces that a group can access.

  **Usage**:

  ```console
  $ bigeye workspace edit-group-access [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-name, --group-name TEXT`: Group name.  [required]
  * `-id, --group-id INTEGER`: Group ID.
  * `-wn, --workspace-name TEXT`: List of workspace names to edit access. E.g. -wn workspace1 -wn workspace2  [required]
  * `-access, --access-level TEXT`: The access this group should have to the workspaces provided. Must be either `Edit` or `Manage`  [default: Edit]
  * `-op, --operation INTEGER`: Operation type.
   ROLE_OPERATION_UNSPECIFIED:0
  ROLE_OPERATION_GRANT:1
  ROLE_OPERATION_REVOKE:2  [default: 1]
  * `--help`: Show this message and exit.



  Delete a group.

  **Usage**:

  ```console
  $ bigeye workspace delete-group [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-name, --group_name TEXT`: Group name.  [required]
  * `--help`: Show this message and exit.



  Bigconfig Commands for Bigeye CLI

  **Usage**:

  ```console
  $ bigeye bigconfig [OPTIONS] COMMAND [ARGS]...
  ```

  **Options**:

  * `--install-completion`: Install completion for the current shell.
  * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
  * `--help`: Show this message and exit.

  **Commands**:

  * `plan`: Executes a plan for purging sources or...
  * `apply`: Applies a purge of deployed metrics or...
  * `export`: Exports existing metrics into a valid...



  Executes a plan for purging sources or processing bigconfig files in the input path/current
  working directory.

  **Usage**:

  ```console
  $ bigeye bigconfig plan [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-ip, --input_path TEXT`: List of paths containing Bigconfig files or pointing to a Bigconfig file. E.g. -ip path1 -ip path2. If no input path is defined then current working directory will be used.
  * `-op, --output_path TEXT`: Output path where reports and fixme files will be saved. If no output path is defined then current working directory will be used.
  * `-psn, --purge_source_name TEXT`: List of source names to purge  E.g. -psn source_1 -psn source_2.
  * `-purge_all, --purge_all_sources`: Purge all sources: True or False.
  * `-nq, --no_queue`: Don't submit to queue: True or False.
  * `-r, --recursive`: Search all input directories recursively.
  * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
  * `-cicd, --cicd_report`: Add the report to a pull request. (Github only)
  * `--help`: Show this message and exit.



  Applies a purge of deployed metrics or applies Bigconfig files from the input path/current working directory to
  the Bigeye workspace.

  **Usage**:

  ```console
  $ bigeye bigconfig apply [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-ip, --input_path TEXT`: List of paths containing Bigconfig files or pointing to a Bigconfig file. E.g. -ip path1 -ip path2. If no input path is defined then current working directory will be used.
  * `-op, --output_path TEXT`: Output path where reports and fixme files will be saved. If no output path is defined then current working directory will be used.
  * `-psn, --purge_source_name TEXT`: List of source names to purge  E.g. -psn source_1 -psn source_2.
  * `-purge_all, --purge_all_sources`: Purge all sources: True or False.
  * `-nq, --no_queue`: Don't submit to queue: True or False.
  * `-r, --recursive`: Search all input directories recursively.
  * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
  * `-auto_approve, --auto_approve`: Explicit plan approval is not needed prior to execution.
  * `--help`: Show this message and exit.



  Exports existing metrics into a valid Bigconfig file.

  **Usage**:

  ```console
  $ bigeye bigconfig export [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-op, --output_path TEXT`: Output path where reports and fixme files will be saved. If no output path is defined then current working directory will be used.
  * `-cid, --collection_id INTEGER`: Collection ID of metrics to be exported.
  * `-tid, --table_id INTEGER`: Table ID of metrics to be exported.
  * `-mid, --metric_id INTEGER`: Metric ID of metrics to be exported.
  * `--help`: Show this message and exit.



  Catalog Commands for Bigeye CLI

  **Usage**:

  ```console
  $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
  ```

  **Options**:

  * `--install-completion`: Install completion for the current shell.
  * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
  * `--help`: Show this message and exit.

  **Commands**:

  * `regen-autometrics`: Regenerates Autometrics by warehouse id OR...
  * `delete-metrics`: Delete metrics in a warehouse id, by...
  * `rebuild`: Rebuilds/Reprofiles a source by warehouse...
  * `get-table-info`: Outputs table info to a file for an entire...
  * `get-metric-info`: Outputs metric info to a file.
  * `run-metrics`: Runs metrics by warehouse id, schema...
  * `add-source`: Adds a source to specified Bigeye workspace.
  * `delete-source`: Delete a source from specified Bigeye...
  * `backfill-autothresholds`: Backfills autothresholds by warehouse id,...
  * `backfill-metrics`: Backfills metrics by warehouse id, schema...
  * `schedule-all-metrics`: Updates schedule for all metrics in a...
  * `unschedule-all-metrics`: Unschedule all metrics by warehouse,...
  * `set-metric-time`: Sets metric times from a list of possible...
  * `unset-metric-time`: Unsets metric times for whole warehouse or...
  * `get-metric-queries`: Gets the debug queries for all metrics by...
  * `upsert-template`: Create or update a template for a source.
  * `export-metric-template`: Export metric templates to yaml files
  * `get-all-metric-templates`: Retrieve all metric templates and output...
  * `delete-template`: Delete a template.
  * `upsert-virtual-table`: Create or update a virtual table.
  * `delete-virtual-table`: Delete a virtual table.
  * `export-virtual-table`: Export virtual table to yaml file
  * `ingest-owners-from-dbt`: Ingest table owners from dbt manifest.json...
  * `ingest-dbt-core-run-info`: Ingest manifest.json and run_results.json...
  * `track-schema-changes`: Track schema changes for sources on demand...



  Regenerates Autometrics by warehouse id OR warehouse id and list of schema names OR list of table ids.

  **Usage**:

  ```console
  $ bigeye catalog regen-autometrics [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID.  If none will look for Table IDs.  If value then will pull all table ids for warehouse
  * `-sn, --schema_name TEXT`: List of Schema Names  E.g. -sn schema_1 -sn schema_2.  Do not include warehouse name -- GREENE_HOMES_DEMO_STANDARD.CONFORMED is fully qualified and CONFORMED is the schema name.
  * `-tid, --table_id INTEGER`: List of Table IDs.  E.g. -tid 123 -tid 124
  * `--help`: Show this message and exit.



  Delete metrics in a warehouse id, by schema names, or by table_ids.  Also, can filter by multipe
  metric types.

  **Usage**:

  ```console
  $ bigeye catalog delete-metrics [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
  * `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
  * `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
  * `-m, --metric_type TEXT`: Delete by name of the metric type.UNDEFINED_PREDEFINED_METRIC_NAME, PERCENT_NULL, COUNT_NULL, PERCENT_EMPTY_STRING, COUNT_EMPTY_STRING, PERCENT_UNIQUE, PERCENT_VALUE_IN_LIST, AVERAGE, MIN, MAX, SUM, COUNT_ROWS, COUNT_DISTINCT, HOURS_SINCE_MAX_DATE, HOURS_SINCE_MAX_TIMESTAMP, COUNT_TRUE, PERCENT_TRUE, COUNT_FALSE, PERCENT_FALSE, COUNT_USA_PHONE, PERCENT_USA_PHONE, COUNT_USA_ZIP_CODE, PERCENT_USA_ZIP_CODE, PERCENT_UUID, COUNT_TIMESTAMP_STRING, PERCENT_TIMESTAMP_STRING, COUNT_DUPLICATES, COUNT_USA_STATE_CODE, PERCENT_USA_STATE_CODE, VARIANCE, SKEW, KURTOSIS, GEOMETRIC_MEAN, HARMONIC_MEAN, COUNT_UUID, COUNT_CUSIP, PERCENT_CUSIP, COUNT_SEDOL, PERCENT_SEDOL, COUNT_ISIN, PERCENT_ISIN, COUNT_LEI, PERCENT_LEI, COUNT_FIGI, PERCENT_FIGI, COUNT_PERM_ID, PERCENT_PERM_ID, COUNT_NAN, PERCENT_NAN, COUNT_LONGITUDE, PERCENT_LONGITUDE, COUNT_LATITUDE, PERCENT_LATITUDE, COUNT_NOT_IN_FUTURE, PERCENT_NOT_IN_FUTURE, COUNT_DATE_NOT_IN_FUTURE, PERCENT_DATE_NOT_IN_FUTURE, MEDIAN, PERCENTILE, COUNT_NOT_NULL, STRING_LENGTH_AVERAGE, STRING_LENGTH_MIN, STRING_LENGTH_MAX, COUNT_SSN, PERCENT_SSN, COUNT_EMAIL, PERCENT_EMAIL, ROWS_INSERTED, HOURS_SINCE_LAST_LOAD, COUNT_READ_QUERIES, PERCENT_NOT_NULL, FRESHNESS, VOLUME, FRESHNESS_DATA, VOLUME_DATA, COUNT_VALUE_IN_LIST
  * `--help`: Show this message and exit.



  Rebuilds/Reprofiles a source by warehouse id or a schema by warehouse id and schema name.

  **Usage**:

  ```console
  $ bigeye catalog rebuild [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID  [required]
  * `-sn, --schema_name TEXT`: Schema Name
  * `--help`: Show this message and exit.



  Outputs table info to a file for an entire warehouse, certain schemas, or certain tables.

  **Usage**:

  ```console
  $ bigeye catalog get-table-info [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
  * `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
  * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124
  * `-tn, --table_name TEXT`: Table Namess. E.g. -tn some_table -tn some_other_table
  * `-op, --output_path TEXT`: File to write the failed metric configurations to.  [required]
  * `--help`: Show this message and exit.



  Outputs metric info to a file.  Includes metric configuration and details about recent runs.

  **Usage**:

  ```console
  $ bigeye catalog get-metric-info [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
  * `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
  * `-tid, --table_id INTEGER`: Table IDs. E.g. -tid 123 -tid 124or schema names.
  * `-ms, --metric_status [HEALTHY|ALERTING|FAILED|UNKNOWN]`: Used to query metric of particular status.
  * `-op, --output_path TEXT`: File to write the failed metric configurations to.  [required]
  * `--conf_only`: Output only the metric configuration.
  * `--help`: Show this message and exit.



  Runs metrics by warehouse id, schema names, and/or table ids

  **Usage**:

  ```console
  $ bigeye catalog run-metrics [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
  * `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
  * `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
  * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
  * `--help`: Show this message and exit.



  Adds a source to specified Bigeye workspace.  Supports either source configs stored in AWS Secrets manager OR
  locally in file.

  **Usage**:

  ```console
  $ bigeye catalog add-source [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-sn, --secret_name TEXT`: The name of the secret to retrieve from AWS Secrets Manager
  * `-srn, --secret_region_name TEXT`: AWS Secret Manager Region Name  [default: us-west-2]
  * `-sccf, --source_catalog_config_file TEXT`: The file containing the necessary parameters for adding a source to Bigeye.
  * `--help`: Show this message and exit.



  Delete a source from specified Bigeye workspace.

  **Usage**:

  ```console
  $ bigeye catalog delete-source [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: The ID of the warehouse to delete.
  * `--help`: Show this message and exit.



  Backfills autothresholds by warehouse id, schema names, and/or table ids.

  **Usage**:

  ```console
  $ bigeye catalog backfill-autothresholds [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
  * `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
  * `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
  * `--help`: Show this message and exit.



  Backfills metrics by warehouse id, schema names, and/or table ids.

  **Usage**:

  ```console
  $ bigeye catalog backfill-metrics [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
  * `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
  * `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
  * `--delete_history`: Delete metric run history
  * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
  * `--help`: Show this message and exit.



  Updates schedule for all metrics in a warehouse.

  **Usage**:

  ```console
  $ bigeye catalog schedule-all-metrics [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
  * `-type, --time_interval_type INTEGER`: Time interval type.
   UNDEFINED_TIME_INTERVAL_TYPE:0
  HOURS_TIME_INTERVAL_TYPE:1
  MINUTES_TIME_INTERVAL_TYPE:2
  SECONDS_TIME_INTERVAL_TYPE:3
  DAYS_TIME_INTERVAL_TYPE:4
  WEEKDAYS_TIME_INTERVAL_TYPE:5
  MARKET_DAYS_TIME_INTERVAL_TYPE:6
  MONTHS_TIME_INTERVAL_TYPE:7  [default: 1]
  * `-value, --interval_value INTEGER`: Number of intervals to set on all metric schedules.  If 0 use unschedule all metrics.  [required]
  * `--help`: Show this message and exit.



  Unschedule all metrics by warehouse, schema or tables.

  **Usage**:

  ```console
  $ bigeye catalog unschedule-all-metrics [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
  * `-sn, --schema_name TEXT`: List of Schema Name.  E.g. -sn schema_1.
  * `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
  * `--help`: Show this message and exit.



  Sets metric times from a list of possible metric column names.  Can set for whole warehouse or for a list of
  table IDs.

  **Usage**:

  ```console
  $ bigeye catalog set-metric-time [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
  * `-sid, --schema_id INTEGER`: Schema ID
  * `-tid, --table_id INTEGER`: List of table IDs.
  * `-cn, --metric_column_name TEXT`: Possible metric column names.  [required]
  * `-r, --replace`: replace metric times if already present on tables?  Default is false.
  * `--help`: Show this message and exit.



  Unsets metric times for whole warehouse or for a list og table IDs.

  **Usage**:

  ```console
  $ bigeye catalog unset-metric-time [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
  * `-tid, --table_id INTEGER`: List of table IDs.
  * `--help`: Show this message and exit.



  Gets the debug queries for all metrics by warehouse id, schema names, or table ids.

  **Usage**:

  ```console
  $ bigeye catalog get-metric-queries [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse ID
  * `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
  * `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
  * `-op, --output_path TEXT`: File to write the failed metric configurations to.  [required]
  * `--help`: Show this message and exit.



  Create or update a template for a source. Files have priority over arguments

  **Usage**:

  ```console
  $ bigeye catalog upsert-template [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-sn, --source_name TEXT`: The name of the source where the template will be defined
  * `-tn, --name TEXT`: The user defined name of the template
  * `-tb, --body TEXT`: The string to define the template
  * `-rt, --returns [BOOLEAN|NUMERIC]`: The data type returned by the template; i.e. NUMERIC, BOOLEAN
  * `-p, --params TEXT`: A list of key/value pairs for parameters; ex. -p column=COLUMN_REFERENCE -p table=STRING
  * `-tf, --template_file TEXT`: A file containing a template definition.
  * `--help`: Show this message and exit.



  Export metric templates to yaml files

  **Usage**:

  ```console
  $ bigeye catalog export-metric-template [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-tn, --name TEXT`: The name of the template(s) to export. None means all
  * `-op, --output_path TEXT`: Path to output files. None means current directory
  * `--help`: Show this message and exit.



  Retrieve all metric templates and output to a file.

  **Usage**:

  ```console
  $ bigeye catalog get-all-metric-templates [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-ps, --page_size INTEGER`: How many results to return per page  [default: 0]
  * `-s, --search TEXT`: A search string to narrow results
  * `-op, --output_path TEXT`: The path to output templates
  * `-fn, --file_name TEXT`: User defined file name
  * `--help`: Show this message and exit.



  Delete a template.

  **Usage**:

  ```console
  $ bigeye catalog delete-template [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-tid, --template_id INTEGER`: The ID of the metric template
  * `-tn, --name TEXT`: The name of the metric template
  * `--help`: Show this message and exit.



  Create or update a virtual table. Files have priority over arguments

  **Usage**:

  ```console
  $ bigeye catalog upsert-virtual-table [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-vtn, --table_name TEXT`: The name of the virtual table
  * `-s, --sql TEXT`: The SQL to define the table
  * `-sn, --source_name TEXT`: The name of the source where the virtual table will be defined
  * `-u, --update`: Create if false. Update if true.
  * `-tf, --table_file TEXT`: A yaml file containing a template definition.
  * `--help`: Show this message and exit.



  Delete a virtual table.

  **Usage**:

  ```console
  $ bigeye catalog delete-virtual-table [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-vtn, --table_name TEXT`: The name of the virtual table  [required]
  * `-sn, --source_name TEXT`: The name of the source that contains the virtual table  [required]
  * `--help`: Show this message and exit.



  Export virtual table to yaml file

  **Usage**:

  ```console
  $ bigeye catalog export-virtual-table [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-vtn, --name TEXT`: The name of the virtual table(s) to export. None means all
  * `-op, --output_path TEXT`: Path to output files. None means current directory
  * `--help`: Show this message and exit.



  Ingest table owners from dbt manifest.json file.

  **Usage**:

  ```console
  $ bigeye catalog ingest-owners-from-dbt [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-mf, --manifest_file TEXT`: The path to the dbt manifest file.
  * `-sn, --source_name TEXT`: The name of the source in Bigeye where owners will be ingested.
  * `-sid, --source_id INTEGER`: The id of the source in Bigeye where owners will be ingested.
  * `--help`: Show this message and exit.



  Ingest manifest.json and run_results.json from different dbt commands.

  **Usage**:

  ```console
  $ bigeye catalog ingest-dbt-core-run-info [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-tp, --target_path TEXT`: The path to the target directory created with dbt run, build, and test commands.  [default: ./target]
  * `-pn, --project_name TEXT`: The name of the dbt project. Will attempt to parse from metadata section of manifest.json, if not present
  * `-jn, --job_name TEXT`: The name of the dbt job.
  * `-jid, --job_run_id TEXT`: The ID of the dbt job run.
  * `-purl, --project_url TEXT`: The URL of the project.
  * `-jurl, --job_url TEXT`: The URL of the job.
  * `-jrurl, --job_run_url TEXT`: The URL of the job run.
  * `--help`: Show this message and exit.



  Track schema changes for sources on demand or every n hour(s) and notify specified channels.
  Environment variables SMTP_USER and SMTP_PASSWORD MUST be set if using email notification.

  **Usage**:

  ```console
  $ bigeye catalog track-schema-changes [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-src, --source TEXT`: A list of source names to track. (None will track changes from all sources)
  * `-s, --since TEXT`: Track schema changes from this date. (Formatted as yyyy-MM-dd)  [default: 1970-01-01]
  * `-f, --frequency INTEGER`: Every n hours to check for schema changes. (None will only run the check once)  [default: 0]
  * `-ct, --change_type [CREATED|DELETED|TYPE_CHANGED]`: The types of changes to track; i.e additions, changes, deletions. (None will track all types)  [default: DELETED, CREATED, TYPE_CHANGED]
  * `-nc, --channel TEXT`: A list of notification channels; e.g. -nc email@mydomain.com -nc #slack_channel -nc https://www.webhook.com
  * `-smtp, --server TEXT`: The server to send emails.
  * `-p, --port INTEGER`: The server port to send emails.  [default: 587]
  * `-t, --token TEXT`: The token to utilize the Slack web client. (Will attempt to use environment variable SLACK_BOT_TOKEN, if not set)
  * `--help`: Show this message and exit.



  Metric Commands for Bigeye CLI

  **Usage**:

  ```console
  $ bigeye metric [OPTIONS] COMMAND [ARGS]...
  ```

  **Options**:

  * `--install-completion`: Install completion for the current shell.
  * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
  * `--help`: Show this message and exit.

  **Commands**:

  * `run`: Run metric by id(s)
  * `get-info`: Outputs metric info to a file.
  * `upsert-from-path`: Upsert multiple metrics from files stored...
  * `upsert`: Upsert single metric from file.
  * `get-metric-queries`: Gets the debug queries for all metrics by...
  * `dbt-tests-to-metrics`: Convert tests in a dbt schema.yml to...



  Run metric by id(s)

  **Usage**:

  ```console
  $ bigeye metric run [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-mid, --metric_id INTEGER`: Metric Ids.  [required]
  * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
  * `--help`: Show this message and exit.



  Outputs metric info to a file.  Includes metric configuration and details about recent runs.

  **Usage**:

  ```console
  $ bigeye metric get-info [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-mid, --metric_id INTEGER`: Metric Ids.  [required]
  * `-ms, --metric_status [HEALTHY|ALERTING|FAILED|UNKNOWN]`: Used to query metric of particular status.
  * `-op, --output_path TEXT`: File to write the failed metric configurations to.  [required]
  * `--conf_only`: Output only the metric configuration.
  * `--help`: Show this message and exit.



  Upsert multiple metrics from files stored in path.

  **Usage**:

  ```console
  $ bigeye metric upsert-from-path [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-twid, --target_warehouse_id INTEGER`: Deploy Metrics to target Warehouse ID.  [required]
  * `-sp, --source_path TEXT`: Source path file containing the metrics to migrate.  [required]
  * `-srct, --set_row_creation_time`: Set the row creation time in target warehouse for tables found in source path.
  * `-uc, --update_collections`: Update existing collections to include new metrics from target warehouse.
  * `--help`: Show this message and exit.



  Upsert single metric from file.

  **Usage**:

  ```console
  $ bigeye metric upsert [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-f, --file TEXT`: File containing SimpleUpsedrtMetricRequest or MetricConfiguration  [required]
  * `-t, --file_type [SIMPLE|FULL]`: Metric File Type.  Simple conforms to SimpleUpsertMetricRequest and Full conforms to MetricConfiguration  [required]
  * `-wid, --warehouse_id INTEGER`: (Optional) Warehouse ID.  If specified it will reduce the text based search for the table.warehouse
  * `-mid, --metric_id INTEGER`: (Optional) Metric Id.  If specified it will reduce the text based search for existing metric.
  * `--help`: Show this message and exit.



  Gets the debug queries for all metrics by warehouse id, schema names, or table ids.

  **Usage**:

  ```console
  $ bigeye metric get-metric-queries [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-mid, --metric_id INTEGER`: Metric Ids.  [required]
  * `-op, --output_path TEXT`: File to write the failed metric configurations to.  [required]
  * `--help`: Show this message and exit.



  Convert tests in a dbt schema.yml to metrics in Bigeye

  **Usage**:

  ```console
  $ bigeye metric dbt-tests-to-metrics [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wn, --warehouse_name TEXT`: The name of the source to deploy metrics  [required]
  * `-sn, --schema_name TEXT`: The name of the schema to deploy metrics  [required]
  * `-sf, --schema_file TEXT`: The path to the dbt schema file  [required]
  * `-auto, --use_auto`: Use autothresholds over default constant
  * `-bigconfig, --to_bigconfig`: Convert the dbt tests to bigconfig.
  * `-op, --output_path TEXT`: Output path where bigconfig file will be saved. If no output path is defined then current working directory will be used. Requires --to_bigconfig to be true.  [default: /home/runner/work/semantic-data-platform/semantic-data-platform/bigeye-integrations/bigeye-cli]
  * `--help`: Show this message and exit.



  Issues Commands for Bigeye CLI

  **Usage**:

  ```console
  $ bigeye issues [OPTIONS] COMMAND [ARGS]...
  ```

  **Options**:

  * `--install-completion`: Install completion for the current shell.
  * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
  * `--help`: Show this message and exit.

  **Commands**:

  * `get-issues`: Gets issues and writes info to files.
  * `update-issue`: Updates an issue in Bigeye and returns the...



  Gets issues and writes info to files.

  **Usage**:

  ```console
  $ bigeye issues get-issues [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-wid, --warehouse_id INTEGER`: Warehouse IDs.
  * `-sn, --schema_name TEXT`: Schema names
  * `-mid, --metric_id INTEGER`: Metric IDs.
  * `-cid, --collection_id INTEGER`: Collection IDs
  * `-iid, --issue_id INTEGER`: Issue IDs
  * `-op, --output_path TEXT`: File to write the failed metric configurations to.  [required]
  * `--help`: Show this message and exit.



  Updates an issue in Bigeye and returns the Issue object from the protobuff.

  **Usage**:

  ```console
  $ bigeye issues update-issue [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-iid, --issue_id INTEGER`: Issue ID  [required]
  * `-status, --issue_status TEXT`: The status update. Options are ACKNOWLEDGED or CLOSED.
  * `-by, --updated_by TEXT`: The user providing the update.
  * `-m, --message TEXT`: The message to attach to the issue.
  * `-cl, --closing_label TEXT`: Used to train Bigeye when closing an issue. Options are TRUE_POSITIVE, FALSE_POSITIVE, EXPECTED.
  * `--help`: Show this message and exit.



  Deltas Commands for Bigeye CLI

  **Usage**:

  ```console
  $ bigeye deltas [OPTIONS] COMMAND [ARGS]...
  ```

  **Options**:

  * `--install-completion`: Install completion for the current shell.
  * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
  * `--help`: Show this message and exit.

  **Commands**:

  * `suggest-deltas`: Suggests and creates Deltas with default...
  * `create-delta`: Creates deltas between tables from a...
  * `run-delta`: Runs a delta by Delta ID.
  * `create-template`: Create a template delta configuration file...
  * `cicd`: Creates a delta based on...



  Suggests and creates Deltas with default behavior and outputs all Simple Delta Configurations to a file.

  **Usage**:

  ```console
  $ bigeye deltas suggest-deltas [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-source, --source_selector TEXT`: The pattern of tables in the source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_1.*.* would be all schemas in source_1.  [required]
  * `-target, --target_selector TEXT`: The pattern of tables in the target to select. Wildcard (*) indicates all tables or all schemas, e.g. source_2.*.* would be all schemas in source_2.  [required]
  * `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match.  [default: strict]
  * `-op, --output_path TEXT`: File to write the delta configuration.  [required]
  * `--help`: Show this message and exit.



  Creates deltas between tables from a Simple Delta configuration file that contains multiple delta configurations.
  Enforces 1:1 column comparisons by case-insensitive column names if no column mappings are declared in
  configuration.

  **Usage**:

  ```console
  $ bigeye deltas create-delta [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-dc, --delta_conf TEXT`: Simple Delta configuration file.  [required]
  * `-ul, --update_lineage`: Should lineage between source and target be checked/created if doesn't exist.
  * `--help`: Show this message and exit.



  Runs a delta by Delta ID.

  **Usage**:

  ```console
  $ bigeye deltas run-delta [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-did, --delta_id INTEGER`: Id of delta.  [required]
  * `-ar, --await_results`: Should command wait for delta run to complete, default False.
  * `--help`: Show this message and exit.



  Create a template delta configuration file based on table names.

  **Usage**:

  ```console
  $ bigeye deltas create-template [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-stn, --source_table_name TEXT`: The fully qualified name of the source table  [required]
  * `-ttn, --target_table_name TEXT`: The fully qualified name of the target table  [required]
  * `-op, --output_path TEXT`: Path to write the template.  [required]
  * `--help`: Show this message and exit.



  Creates a delta based on SimpleDeltaConfiguration and integrates the results with the provided VCS vendor.

  **Usage**:

  ```console
  $ bigeye deltas cicd [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-dcc, --delta_cicd_config TEXT`: The yaml file containing the parameters for the DeltaCICDConfig class  [required]
  * `--help`: Show this message and exit.



  Collections Commands for Bigeye CLI

  **Usage**:

  ```console
  $ bigeye collections [OPTIONS] COMMAND [ARGS]...
  ```

  **Options**:

  * `--install-completion`: Install completion for the current shell.
  * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
  * `--help`: Show this message and exit.

  **Commands**:

  * `add-metric`: Add metric to a Collection.
  * `get-metric-info`: Get metric info for all metrics in...
  * `migrate-from-json`: Loads metrics from Collection oriented...
  * `backfill-metrics`: Backfill all metrics in a Collection.
  * `run-metrics`: Run all metrics in a Collection.
  * `get-metric-queries`: Gets the debug queries for all metrics by...



  Add metric to a Collection.

  **Usage**:

  ```console
  $ bigeye collections add-metric [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-mid, --metric_id INTEGER`: Metric ID  [required]
  * `-cid, --collection_id INTEGER`: Collection ID  [required]
  * `--help`: Show this message and exit.



  Get metric info for all metrics in Collection.

  **Usage**:

  ```console
  $ bigeye collections get-metric-info [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `--from_collections`: Scrapes all Collections in customer workspace for Metric Info.
  * `--collection_ids INTEGER`: Collection IDs.  Scrape certain Collections for Metric Info.
  * `-op, --output_path TEXT`: File to write the failed metric configurations to.  [required]
  * `--help`: Show this message and exit.



  Loads metrics from Collection oriented metric info output.  Used to migrate metrics from one warehouse to
  another, identical, warehouse

  **Usage**:

  ```console
  $ bigeye collections migrate-from-json [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-twid, --target_warehouse_id INTEGER`: Deploy Metrics to target Warehouse ID.  [required]
  * `-ip, --input_path TEXT`: Path to read from.  [required]
  * `-kn, --keep_notifications`: Keep Notifications from versioned or templated metric configuration.
  * `-kid, --keep_ids`: Keep Metric and Collection IDs from versioned or templated metric configuration.  If kept this would update existing metrics and collections.  If not kept it would create new.
  * `--help`: Show this message and exit.



  Backfill all metrics in a Collection.

  **Usage**:

  ```console
  $ bigeye collections backfill-metrics [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `--from_collections`: Scrapes all Collections in customer workspace for Metric Info.
  * `--collection_ids INTEGER`: Collection IDs.  Scrape certain Collections for Metric Info.
  * `--delete_history`: Delete metric run history
  * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
  * `--help`: Show this message and exit.



  Run all metrics in a Collection.

  **Usage**:

  ```console
  $ bigeye collections run-metrics [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-cid, --collection_id INTEGER`: Collection ID  [required]
  * `-q, --queue`: Submit the batch to a queue. (Recommended for larger batches)
  * `--help`: Show this message and exit.



  Gets the debug queries for all metrics by warehouse id, schema names, or table ids.

  **Usage**:

  ```console
  $ bigeye collections get-metric-queries [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-cid, --collection_id INTEGER`: Collection ID  [required]
  * `-op, --output_path TEXT`: File to write the failed metric configurations to.  [required]
  * `--help`: Show this message and exit.



  Lineage Commands for Bigeye CLI

  **Usage**:

  ```console
  $ bigeye lineage [OPTIONS] COMMAND [ARGS]...
  ```

  **Options**:

  * `--install-completion`: Install completion for the current shell.
  * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
  * `--help`: Show this message and exit.

  **Commands**:

  * `create-node`: Create a lineage node for an entity
  * `delete-node`: Delete a lineage node for an entity
  * `create-relation`: Create a lineage relationship for 2 entities
  * `delete-relation`: Deletes a single relationship based on...
  * `infer-relations`: Given an upstream and downstream path,...



  Create a lineage node for an entity

  **Usage**:

  ```console
  $ bigeye lineage create-node [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-en, --entity_name TEXT`: The fully qualified table name or name of the tableau workbook  [required]
  * `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
  * `--help`: Show this message and exit.



  Delete a lineage node for an entity

  **Usage**:

  ```console
  $ bigeye lineage delete-node [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-en, --entity_name TEXT`: The fully qualified table name or name of the tableau workbook  [required]
  * `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
  * `--help`: Show this message and exit.



  Create a lineage relationship for 2 entities

  **Usage**:

  ```console
  $ bigeye lineage create-relation [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-up, --upstream TEXT`: The fully qualified table name  [required]
  * `-down, --downstream TEXT`: The fully qualified table name  [required]
  * `-co, --column_overrides TEXT`: The list of column overrides, formatted as upstream_column_name:downstream_column_name
  * `--help`: Show this message and exit.



  Deletes a single relationship based on relation ID or all relationships for a node by name.

  **Usage**:

  ```console
  $ bigeye lineage delete-relation [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-en, --entity_name TEXT`: The fully qualified table name or name of the tableau workbook
  * `-rid, --relation_id INTEGER`: The relationship ID to delete  [default: 0]
  * `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
  * `--help`: Show this message and exit.



  Given an upstream and downstream path, infers lineage based on table/column names and creates the edges.

  **Usage**:

  ```console
  $ bigeye lineage infer-relations [OPTIONS]
  ```

  **Options**:

  * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
  * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
  * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
  * `-upstream, --upstream_selector TEXT`: The pattern of tables in the upstream source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_1.*.* would be all schemas in source_1.
  * `-downstream, --downstream_selector TEXT`: The pattern of tables in the downstream source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_2.*.* would be all schemas in source_2.
  * `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match.  [default: strict]
  * `-lc, --lineage_conf TEXT`: The path to a Simple Lineage configuration file.
  * `-purge, --purge_lineage`: Purge all lineage edges.
  * `--help`: Show this message and exit.


pkgId: 2c6287817de27b9b049ce66af64806bfbc4bf99f7fb03778542e30c5a5da544c
name: python-bigeye-sdk
arch: src
version: 0.4.90
epoch: 0
release: 1
summary: Bigeye SDK offers developer tools and clients to interact with Bigeye programmatically.
url: https://docs.bigeye.com/docs
rpm_license: Proprietary
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigeye-sdk-0.4.90-1.src.rpm
checksum_type: sha256
description:
  Bigeye SDK is a collection of protobuf generated code, functions, and models used to interact programmatically
  with the Bigeye API.  Bigeye currently supports a Python SDK.  The main entry point is the DatawatchClient
  abstraction and, in this core package, a basic auth client has been implemented.  The abstract base class
  includes core functionality (methods to interact with the API) and each implementation should enable a
  different authorization methods.



  ```shell
  pip install bigeye_sdk
  ```



  Basic authorization credentials can be stored as Json either on disk or in a secrets/credentials manager.  This
  format will be marshalled into an instance of [BasicAuthRequestLibApiConf](bigeye_sdk/authentication/api_authentication.py).

  ```json
  {
      "base_url": "https://app.bigeye.com",
      "user": "",
      "password": ""
  }
  ```


pkgId: bd7ed2a9f656a67d5ec842fe0296af9bddb2cff005e3aa907f79594ee85755c1
name: python-bigframes
arch: src
version: 1.25.0
epoch: 0
release: 1
summary: BigQuery DataFrames -- scalable analytics and machine learning with BigQuery
url: https://github.com/googleapis/python-bigquery-dataframes
rpm_license: Apache 2.0
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigframes-1.25.0-1.src.rpm
checksum_type: sha256
description:
  |GA| |pypi| |versions|
  BigQuery DataFrames provides a Pythonic DataFrame and machine learning (ML) API
  powered by the BigQuery engine.
  * ``bigframes.pandas`` provides a pandas-compatible API for analytics.
  * ``bigframes.ml`` provides a scikit-learn-like API for ML.
  BigQuery DataFrames is an open-source package. You can run
  ``pip install --upgrade bigframes`` to install the latest version.


pkgId: 930593025b6c1dc5d052b1ee64566316ec4d43b966ca5f7900195abc498aeddc
name: python-biggraphite
arch: src
version: 0.14.20
epoch: 0
release: 1
summary: Simple Scalable Time Series Database.
url: https://github.com/criteo/biggraphite
rpm_license: Apache Software License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-biggraphite-0.14.20-1.src.rpm
checksum_type: sha256
description:
  BigGraphite is a storage layer for timeseries data. It integrates with Graphite as a plugin.
  For usage information and how to contribute, please see [CONTRIBUTING.md](CONTRIBUTING.md).


pkgId: 442864c8ed8c3cdc79098a66c60bd36fd2d4e299d968413c1efba4173e15dbb2
name: python-biglist
arch: src
version: 0.9.6
epoch: 0
release: 1
url: https://pypi.org/project/biglist/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-biglist-0.9.6-1.src.rpm
checksum_type: sha256
summary:
  The package `biglist <https://github.com/zpz/biglist>`_ provides persisted, out-of-memory Python data structures

description:
  The package ``biglist`` provides persisted, out-of-memory Python data structures
  that implement the ``Sequence`` and ``Iterable`` interfaces with the capabilities of
  concurrent and distributed reading and writing.
  The main use case is sequentially processing large amounts of data that can not fit in memory.
  Persistence can be on local disk or in cloud storage.
  Read the `documentation <https://biglist.readthedocs.io/en/latest/>`_.


pkgId: 12fa710f9810e174c7e96c4dce3b9837b96d790ed334469c4f5145fd5be2fa70
name: python-bigmcl
arch: src
version: 0.2b2
epoch: 0
release: 1
summary: Large scale Markov clustering (MCL) via subgraph extraction
url: https://gitlab.com/xonq/bigmcl
rpm_license: BSD License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigmcl-0.2b2-1.src.rpm
checksum_type: sha256
description:
  `bigmcl` will isolate disconnected subgraphs from a large graph file and execute
  MCL on the subgraphs. bigmcl enables MCL on large, highly disconnected graphs,
  such as those used in orthogroup inference. Not recommended for graphs that are
  manageable with typical MCL.

  Important to note that the inflation parameter is affected by this approach -
  I have noted clusters are more granular if anything. In the future, I plan on
  implementing a systematic approach option for identifying ideal inflations for
  each subgraph.

  Please cite this git repository and MCL when this software contributes to your analysis.



  `bigmcl` is currently in a beta state, and while I appreciate bringing issues to
  my attention, I am currently focused on getting things working well for my own
  research, so I cannot guarantee timely issue resolution. My hope is `bigmcl` will
  be in a longterm stable state by publication 2022.


  <br />



  ```
  pip install bigmcl
  ```

  Clone `mcl` [from here](https://github.com/micans/mcl), compile, and add to your path.

  <br />



  Input and go:
  ```
  bigmcl -i <GRAPH.imx> -I 1.5
  ```

  More elaborate options:
  ```
  usage: bigmcl.py [-h] -i INPUT -I INFLATION [-s] [-r ROW_FILE] [-m] [-o OUTPUT] [-c CORES]
                   [-v]

  Isolates disconnected graphs and runs MCL on the subgraphs. Input data must be numerical.

  optional arguments:
    -h, --help            show this help message and exit
    -i INPUT, --input INPUT
                          MCL graph file in imx format
    -I INFLATION, --inflation INFLATION
    -s, --symmetric       Matrix is symmetric (throughput increase)
    -r ROW_FILE, --row_file ROW_FILE
                          Continue from finished row.txt
    -m, --mcl_format      Output clusters in MCL format
    -o OUTPUT, --output OUTPUT
                          Alternative output directory
    -c CORES, --cores CORES
    -v, --verbose
  ```


pkgId: 0f70ab3b8361ddd528c7a0b4f7e7b12652222eebceaad345e2f09e8cad6a0127
name: python-bigplanet
arch: src
version: 3.0.1
epoch: 0
release: 1
summary: VPLANET Data Analysis Tools
url: https://github.com/VirtualPlanetaryLaboratory/BigPlanet
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigplanet-3.0.1-1.src.rpm
checksum_type: sha256
description:
  <p align="center">
    <img width = "250" src="docs/VPLanetLogo.png?raw=true"/>
  </p>

  <h1 align="center">BigPlanet: Big Data with VPLanet</h1>

  <p align="center">
    <a href="https://VirtualPlanetaryLaboratory.github.io/bigplanet/">
      <img src="https://img.shields.io/badge/read-the_docs-blue.svg?style=flat">
    </a>
    <a href="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/docs.yml">
      <img src="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/docs.yml/badge.svg">
    </a>
    <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-purple.svg"></a>
    <a href="https://VirtualPlanetaryLaboratory.github.io/vplanet/conduct.html">
      <img src="https://img.shields.io/badge/Code%20of-Conduct-7d93c7.svg">
    </a>
    <br>
    <img src="https://img.shields.io/badge/Unit%20Tests-10-darkblue.svg">
    <a href="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/tests.yml">
      <img src="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/tests.yml/badge.svg">
    </a>
    <img src="https://img.shields.io/badge/Python-3.6--3.9-orange.svg">
    <br>
    <a href="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/pip-install.yml">
      <img src="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/pip-install.yml/badge.svg">
    </a>
    <img src="https://img.shields.io/badge/Python-3.6--3.9-orange.svg">
    <img src = "https://img.shields.io/badge/Platforms-Linux_|%20macOS-darkgreen.svg?style=flat">
  </p>

  A suite of data analysis and extraction routines for [VPLanet](https://github.com/VirtualPlanetaryLaboratory/vplanet) and designed to be used with [VSPACE](https://github.com/VirtualPlanetaryLaboratory/vspace) and [MultiPlanet](https://github.com/VirtualPlanetaryLaboratory/multi-planet) scripts. It can also generate files for use with the free version of the [VR Ulysses data explorer](https://www.vrulysses.com/download-ulysses). [Read the docs](https://VirtualPlanetaryLaboratory.github.io/bigplanet/) to learn how to get the most out of your `VPLanet` parameter sweeps.


pkgId: 90790c53ed760f6e1ca0f4d460d99b0479af6678c3d61449a8f81247cfd3fcdf
name: python-bigquery-advanced-utils
arch: src
version: 0.0.1.dev1
epoch: 0
release: 1
url: https://pypi.org/project/bigquery-advanced-utils/
rpm_license: GPL-3.0
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigquery-advanced-utils-0.0.1.dev1-1.src.rpm
checksum_type: sha256
summary:
  A utility library that enhances the official BigQuery Python client by providing additional tools for efficient query management, data processing, and automation. Designed for developers and data scientists, `bigquery-utils` simplifies working with Google BigQuery.

description:
  A utility library that enhances the official BigQuery Python client by providing additional tools for efficient query management, data processing, and automation. Designed for developers and data scientists, `bigquery-utils` simplifies working with Google BigQuery.


  - A new query builder.
  - Custom data transformation and processing functions.
  - Exclusive features with datatransfer.
  - Utility functions to manipulate strings and query.


  Install `bigquery-utils` via pip:
  ```bash
  pip install bigquery-utils
  ```


  - Python 3.10+
  - Google Cloud BigQuery client library


  Contributions are welcome! Please fork the repository and submit a pull request with your change, let's improve this library together!


  This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.


  For questions or feedback, feel free to open an issue or reach out to the maintainer.


pkgId: d742204723cddcf2ad3678eb557c11d8058180fd43218155601ed07d08f311ad
name: python-bigquery-etl-tools
arch: src
version: 0.0.3
epoch: 0
release: 1
summary: BigQuery ETL Tools
url: https://github.com/Mattanalytix/bigquery-etl-tools
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigquery-etl-tools-0.0.3-1.src.rpm
checksum_type: sha256
description:
  This package contains helper utilities to make it easier to ingest data into BigQuery. The main functionality is to help ingest data from local dataframes or files. The main assumption of this package is that your data can be loaded into a `polars` dataframe and uploaded from there into bigquery, either directly or via cloud storage.

  **Note:** This package is biased towards certain data structures and file configurations, at the benefit of saved time to get something working.



  To use the package locally, authenticate with GCP using OAuth:

  ```cmd
  gcloud auth application-default login
  gcloud config set project YOUR_PROJECT_ID
  ```

  Setup environment for local development:

  ```
  conda create -n bigquery_etl_tools pip
  conda activate bigquery_etl_tools
  pip install -r requirements.txt
  ```

  Optionally, install `ipykernel` if developing in jupyter notebooks:

  ```
  pip install ipykernel
  ```



  The tests for this package are created using [pytest](https://docs.pytest.org/), for some of the tests you will need to specifiy variables which are specfic to your GCP environment. To do that create a `.env` file in the root of the repository and set the following values:

  ```.env
  BUCKET='bucketname'
  DATASET='datasetname'
  ```

  To run pytest run the following command on the command line:

  ```cmd
  pytest # full run

  pytest tests/MODULE_NAME.py # module run
  ```



  See the package here: https://pypi.org/project/bigquery-etl-tools/

  To build the package using `twine` run the following on the command line in the root directory:

  ```cmd
  python setup.py sdist bdist_wheel # build the distribution
  twine check dist/* # check everything has built correctly
  twine upload dist/* # upload to pypi
  ```

  To install the package into an environment run:

  ```cmd
  pip install bigquery-etl-tools
  ```

  @TODO turn this into github action



  See `notebook.ipynb` for example use cases.


pkgId: bad66681a544a15149a745fe88d0c062bea3b69b8602c3e425665f548a272ff1
name: python-bigquery-fdw
arch: src
version: 2.1.2
epoch: 0
release: 1
summary: BigQuery Foreign Data Wrapper for PostgreSQL
url: https://github.com/gabfl/bigquery_fdw
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigquery-fdw-2.1.2-1.src.rpm
checksum_type: sha256
description:
  |Pypi| |Build Status| |codecov| |MIT licensed|
  bigquery_fdw is a BigQuery foreign data wrapper for PostgreSQL using
  `Multicorn <https://github.com/Segfault-Inc/Multicorn>`__.
  It allows to write queries in PostgreSQL SQL syntax using a foreign
  table. It supports most of BigQuery’s `data
  types <docs/data_types.md>`__ and `operators <docs/operators.md>`__.


pkgId: 22d7c57b61254d6dad46310eeca2af9dc7b390dd30b523b7349661e451679dce
name: python-bigquery-magics
arch: src
version: 0.4.0
epoch: 0
release: 1
summary: Google BigQuery magics for Jupyter and IPython
url: https://github.com/googleapis/python-bigquery-magics
rpm_license: Apache 2.0
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigquery-magics-0.4.0-1.src.rpm
checksum_type: sha256
description:
  |GA| |pypi| |versions|
  Querying massive datasets can be time consuming and expensive without the
  right hardware and infrastructure. Google `BigQuery`_ solves this problem by
  enabling super-fast, SQL queries against append-mostly tables, using the
  processing power of Google's infrastructure.
  -  `Library Documentation`_
  -  `Product Documentation`_


pkgId: 25b50d3428b2ebb4774449d81e4413f8b7c1631a9a4050e21afc91e8227cf90e
name: python-bigquery-schema-generator
arch: src
version: 1.6.1
epoch: 0
release: 1
summary: BigQuery schema generator from JSON or CSV data
url: https://github.com/bxparks/bigquery-schema-generator
rpm_license: Apache 2.0
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigquery-schema-generator-1.6.1-1.src.rpm
checksum_type: sha256
description:
  [![BigQuery Schema Generator CI](https://github.com/bxparks/bigquery-schema-generator/actions/workflows/pythonpackage.yml/badge.svg)](https://github.com/bxparks/bigquery-schema-generator/actions/workflows/pythonpackage.yml)

  This script generates the BigQuery schema from the newline-delimited data
  records on the STDIN. The records can be in JSON format or CSV format. The
  BigQuery data importer (`bq load`) uses only the
  [first 500 records](https://cloud.google.com/bigquery/docs/schema-detect)
  when the schema auto-detection feature is enabled. In contrast, this script uses
  all data records to generate the schema.

  Usage:
  ```
  $ generate-schema < file.data.json > file.schema.json
  $ generate-schema --input_format csv < file.data.csv > file.schema.json
  ```

  **Version**: 1.6.1 (2024-01-12)

  **Changelog**: [CHANGELOG.md](CHANGELOG.md)



  * [Background](#Background)
  * [Installation](#Installation)
      * [Ubuntu Linux](#UbuntuLinux)
      * [MacOS](#MacOS)
          * [MacOS 12 (Monterey)](#MacOS12)
          * [MacOS 11 (Big Sur)](#MacOS11)
          * [MacOS 10.14 (Mojave)](#MacOS1014)
  * [Usage](#Usage)
      * [Command Line](#CommandLine)
      * [Schema Output](#SchemaOutput)
      * [Command Line Flag Options](#FlagOptions)
          * [Help (`--help`)](#Help)
          * [Input Format (`--input_format`)](#InputFormat)
          * [Keep Nulls (`--keep_nulls`)](#KeepNulls)
          * [Quoted Values Are Strings(`--quoted_values_are_strings`)](#QuotedValuesAreStrings)
          * [Infer Mode (`--infer_mode`)](#InferMode)
          * [Debugging Interval (`--debugging_interval`)](#DebuggingInterval)
          * [Debugging Map (`--debugging_map`)](#DebuggingMap)
          * [Sanitize Names (`--sanitize_names`)](#SanitizedNames)
          * [Ignore Invalid Lines (`--ignore_invalid_lines`)](#IgnoreInvalidLines)
          * [Existing Schema Path (`--existing_schema_path`)](#ExistingSchemaPath)
          * [Preserve Input Sort Order
            (`--preserve_input_sort_order`)](#PreserveInputSortOrder)
      * [Using as a Library](#UsingAsLibrary)
          * [`SchemaGenerator.run()`](#SchemaGeneratorRun)
          * [`SchemaGenerator.deduce_schema()` from
            File](#SchemaGeneratorDeduceSchemaFromFile)
          * [`SchemaGenerator.deduce_schema()` from
            Dict](#SchemaGeneratorDeduceSchemaFromDict)
          * [`SchemaGenerator.deduce_schema()` from
            DictReader](#SchemaGeneratorDeduceSchemaFromCsvDictReader)
  * [Schema Types](#SchemaTypes)
      * [Supported Types](#SupportedTypes)
      * [Type Inference](#TypeInference)
  * [Examples](#Examples)
  * [Benchmarks](#Benchmarks)
  * [System Requirements](#SystemRequirements)
  * [License](#License)
  * [Feedback and Support](#Feedback)
  * [Authors](#Authors)

  <a name="Background"></a>


  Data can be imported into [BigQuery](https://cloud.google.com/bigquery/) using
  the [bq](https://cloud.google.com/bigquery/bq-command-line-tool) command line
  tool. It accepts a number of data formats including CSV or newline-delimited
  JSON. The data can be loaded into an existing table or a new table can be
  created during the loading process. The structure of the table is defined by
  its [schema](https://cloud.google.com/bigquery/docs/schemas). The table's
  schema can be defined manually or the schema can be
  [auto-detected](https://cloud.google.com/bigquery/docs/schema-detect#auto-detect).

  When the auto-detect feature is used, the BigQuery data importer examines only
  the [first 500 records](https://cloud.google.com/bigquery/docs/schema-detect)
  of the input data. In many cases, this is sufficient
  because the data records were dumped from another database and the exact schema
  of the source table was known. However, for data extracted from a service
  (e.g. using a REST API) the record fields could have been organically added
  at later dates. In this case, the first 500 records do not contain fields which
  are present in later records. The **bq load** auto-detection fails and the data
  fails to load.

  The **bq load** tool does not support the ability to process the entire dataset
  to determine a more accurate schema. This script fills in that gap. It
  processes the entire dataset given in the STDIN and outputs the BigQuery schema
  in JSON format on the STDOUT. This schema file can be fed back into the **bq
  load** tool to create a table that is more compatible with the data fields in
  the input dataset.

  <a name="Installation"></a>


  **Prerequisite**: You need have Python 3.6 or higher.

  Install from [PyPI](https://pypi.python.org/pypi) repository using `pip3`. There
  are too many ways to install packages in Python. The following are in order
  highest to lowest recommendation:

  1) If you are using a virtual environment (such as
  [venv](https://docs.python.org/3/library/venv.html)), then use:
  ```
  $ pip3 install bigquery_schema_generator
  ```

  2) If you aren't using a virtual environment you can install into
  your local Python directory:

  ```
  $ pip3 install --user bigquery_schema_generator
  ```

  3) If you want to install the package for your entire system globally, use
  ```
  $ sudo -H pip3 install bigquery_schema_generator
  ```
  but realize that you will be running code from PyPI as `root` so this has
  security implications.

  Sometimes, your Python environment gets into a complete mess and the `pip3`
  command won't work. Try typing `python3 -m pip` instead.

  A successful install should print out something like the following (the version
  number may be different):
  ```
  Collecting bigquery-schema-generator
  Installing collected packages: bigquery-schema-generator
  Successfully installed bigquery-schema-generator-1.1
  ```

  The shell script `generate-schema` will be installed somewhere in your system,
  depending on how your Python environment is configured. See below for
  some notes for Ubuntu Linux and MacOS.

  <a name="UbuntuLinux"></a>


  After running `pip3 install bigquery_schema_generator`, the `generate-schema`
  script may be installed in one the following locations:

  * `/usr/bin/generate-schema`
  * `/usr/local/bin/generate-schema`
  * `$HOME/.local/bin/generate-schema`
  * `$HOME/.virtualenvs/{your_virtual_env}/bin/generate-schema`

  <a name="MacOS"></a>


  I don't have any Macs which are able to run the latest macOS, and I don't use
  them much for software development these days, but here are some notes on older
  versions of macOS in case they help.

  <a name="MacOS12"></a>


  Python 2 or 3 is not installed by default on Monterey. If you try to run
  `python3` on the command line, a dialog box asks you to install the
  [Xcode](https://developer.apple.com/support/xcode/) development package. It
  apparently takes over an hour at 10 MB/s.

  You can instead install Python 3 using
  [Homebrew](https://docs.brew.sh/Homebrew-and-Python), by installing `brew`, and
  typing `$ brew install python`. Currently, it downloads Python 3.10 in about 1-2
  minutes and installs the `python3` and `pip3` binaries into
  `/usr/local/bin/python3` and `/usr/local/bin/pip3`. Using `brew` seems to be
  easiest option, so let's assume that Python 3 was installed through that.

  If you run:
  ```
  $ pip3 install bigquery_schema_generator
  ```
  the package will be installed at `/usr/local/lib/python3.10/site-packages/`, and
  the `generate-schema` script will be installed at
  `/usr/local/bin/generate-schema`.

  If you use the `--user` flag:
  ```
  $ pip3 install --user bigquery_schema_generator
  ```
  the package will be installed at
  `$HOME/Library/Python/3.10/lib/python/site-packages/`, and the `generate-schema`
  script will be installed at `$HOME/Library/Python/3.10/bin/generate-schema`.

  You may need to add the `$HOME/Library/Python/3.10/bin` directory to your
  `$PATH` variable in your `$HOME/.bashrc` file.

  <a name="MacOS11"></a>


  Python 2.7.16 is installed by default on Big Sur as `/usr/bin/python`. If you
  try to run `python3` on the command line, a dialog box asks you to install
  the [Xcode](https://developer.apple.com/support/xcode/) development package will
  be installed, which I think installs Python 3.8 as `/usr/bin/python3` (I can't
  remember, it was installed a long time ago.)

  You can instead install Python 3 using
  [Homebrew](https://docs.brew.sh/Homebrew-and-Python), by installing `brew`, and
  typing `$ brew install python`. Currently, it downloads Python 3.10 in about 1-2
  minutes and installs the `python3` and `pip3` binaries into
  `/usr/local/bin/python3` and `/usr/local/bin/pip3`. Using `brew` seems to be
  easiest option, so let's assume that Python 3 was installed through that.

  If you run:
  ```
  $ pip3 install bigquery_schema_generator
  ```
  the package will be installed at `/usr/local/lib/python3.10/site-packages/`, and
  the `generate-schema` script will be installed at
  `/usr/local/bin/generate-schema`.

  If you use the `--user` flag:
  ```
  $ pip3 install --user bigquery_schema_generator
  ```
  the package will be installed at
  `$HOME/Library/Python/3.10/lib/python/site-packages/`, and the `generate-schema`
  script will be installed at `$HOME/Library/Python/3.10/bin/generate-schema`.

  You may need to add the `$HOME/Library/Python/3.10/bin` directory to your
  `$PATH` variable in your `$HOME/.bashrc` file.

  <a name="MacOS1014"></a>


  This MacOS version comes with Python 2.7 only. To install Python 3, you can
  install using:

  1)) Downloading the [macos installer directly from
     Python.org](https://www.python.org/downloads/macos/).

  The python3 binary will be located at `/usr/local/bin/python3`, and the
  `/usr/local/bin/pip3` is a symlink to
  `/Library/Frameworks/Python.framework/Versions/3.6/bin/pip3`.

  So running

  ```
  $ pip3 install --user bigquery_schema_generator
  ```

  will install `generate-schema` at
  `/Library/Frameworks/Python.framework/Versions/3.6/bin/generate-schema`.

  The Python installer updates `$HOME/.bash_profile` to add
  `/Library/Frameworks/Python.framework/Versions/3.6/bin` to the `$PATH`
  environment variable. So you should be able to run the `generate-schema`
  command without typing in the full path.

  2)) Using [Homebrew](https://docs.brew.sh/Homebrew-and-Python).

  In this environment, the `generate-schema` script will probably be installed in
  `/usr/local/bin` but I'm not completely certain.

  <a name="Usage"></a>


  <a name="CommandLine"></a>


  The `generate_schema.py` script accepts a newline-delimited JSON or
  CSV data file on the STDIN. JSON input format has been tested extensively.
  CSV input format was added more recently (in v0.4) using the `--input_format
  csv` flag. The support is not as robust as JSON file. For example, CSV format
  supports only the comma-separator, and does not support the pipe (`|`) or tab
  (`\t`) character.

  **Side Note**: The `input_format` parameter now supports (v1.6.0) the
  `csvdictreader` option which allows using the
  [csv.DictReader](https://docs.python.org/3/library/csv.html) class that can be
  customized to handle different delimiters such as tabs. But this requires
  creating a custom Python script using `bigquery_schema_generator` as a library.
  See [SchemaGenerator.deduce_schema() from
  csv.DictReader](#SchemaGeneratorDeduceSchemaFromCsvDictReader) section below. It
  is probably possible to enable this functionality through the command line
  script, but it was not obvious how to expose the various options of
  `csv.DictReader` through the command line flags. I didn't spend any time on this
  problem because this is not a feature that I use personally.)

  Unlike `bq load`, the `generate_schema.py` script reads every record in the
  input data file to deduce the table's schema. It prints the JSON formatted
  schema file on the STDOUT.

  There are at least 3 ways to run this script:

  **1) Shell script**

  If you installed using `pip3`, then it should have installed a small helper
  script named `generate-schema` in your local `./bin` directory of your current
  environment (depending on whether you are using a virtual environment).

  ```
  $ generate-schema < file.data.json > file.schema.json
  ```

  **2) Python module**

  You can invoke the module directly using:
  ```
  $ python3 -m bigquery_schema_generator.generate_schema < file.data.json > file.schema.json
  ```
  This is essentially what the `generate-schema` command does.

  **3) Python script**

  If you retrieved this code from its
  [GitHub repository](https://github.com/bxparks/bigquery-schema-generator),
  then you can invoke the Python script directly:
  ```
  $ ./generate_schema.py < file.data.json > file.schema.json
  ```

  <a name="SchemaOutput"></a>


  The resulting schema file can be given to the **bq load** command using the
  `--schema` flag:
  ```

  $ bq load --source_format NEWLINE_DELIMITED_JSON \
      --ignore_unknown_values \
      --schema file.schema.json \
      mydataset.mytable \
      file.data.json
  ```
  where `mydataset.mytable` is the target table in BigQuery.

  For debugging purposes, here is the equivalent `bq load` command using schema
  autodetection:

  ```
  $ bq load --source_format NEWLINE_DELIMITED_JSON \
      --autodetect \
      mydataset.mytable \
      file.data.json
  ```

  If the input file is in CSV format, the first line will be the header line which
  enumerates the names of the columns. But this header line must be skipped when
  importing the file into the BigQuery table. We accomplish this using
  `--skip_leading_rows` flag:
  ```
  $ bq load --source_format CSV \
      --schema file.schema.json \
      --skip_leading_rows 1 \
      mydataset.mytable \
      file.data.csv
  ```

  Here is the equivalent `bq load` command for CSV files using autodetection:
  ```
  $ bq load --source_format CSV \
      --autodetect \
      mydataset.mytable \
      file.data.csv
  ```

  A useful flag for `bq load`, particularly for JSON files,  is
  `--ignore_unknown_values`, which causes `bq load` to ignore fields in the input
  data which are not defined in the schema. When `generate_schema.py` detects an
  inconsistency in the definition of a particular field in the input data, it
  removes the field from the schema definition. Without the
  `--ignore_unknown_values`, the `bq load` fails when the inconsistent data record
  is read.

  Another useful flag during development and debugging is `--replace` which
  replaces any existing BigQuery table.

  After the BigQuery table is loaded, the schema can be retrieved using:

  ```
  $ bq show --schema mydataset.mytable | python3 -m json.tool
  ```

  (The `python -m json.tool` command will pretty-print the JSON formatted schema
  file. An alternative is the [jq command](https://stedolan.github.io/jq/).)
  The resulting schema file should be identical to `file.schema.json`.

  <a name="FlagOptions"></a>


  The `generate_schema.py` script supports a handful of command line flags
  as shown by the `--help` flag below.

  <a name="Help"></a>


  Print the built-in help strings:

  ```bash
  $ generate-schema --help
  usage: generate-schema [-h] [--input_format INPUT_FORMAT] [--keep_nulls]
                         [--quoted_values_are_strings] [--infer_mode]
                         [--debugging_interval DEBUGGING_INTERVAL]
                         [--debugging_map] [--sanitize_names]
                         [--ignore_invalid_lines]
                         [--existing_schema_path EXISTING_SCHEMA_PATH]
                         [--preserve_input_sort_order]

  Generate BigQuery schema from JSON or CSV file.

  optional arguments:
    -h, --help            show this help message and exit
    --input_format INPUT_FORMAT
                          Specify an alternative input format ('csv', 'json',
                          'dict')
    --keep_nulls          Print the schema for null values, empty arrays or
                          empty records
    --quoted_values_are_strings
                          Quoted values should be interpreted as strings
    --infer_mode          Determine if mode can be 'NULLABLE' or 'REQUIRED'
    --debugging_interval DEBUGGING_INTERVAL
                          Number of lines between heartbeat debugging messages
    --debugging_map       Print the metadata schema_map instead of the schema
    --sanitize_names      Forces schema name to comply with BigQuery naming
                          standard
    --ignore_invalid_lines
                          Ignore lines that cannot be parsed instead of stopping
    --existing_schema_path EXISTING_SCHEMA_PATH
                          File that contains the existing BigQuery schema for a
                          table. This can be fetched with: `bq show --schema
                          <project_id>:<dataset>:<table_name>
    --preserve_input_sort_order
                          Preserve the original ordering of columns from input
                          instead of sorting alphabetically. This only impacts
                          `input_format` of json or dict

  ```

  <a name="InputFormat"></a>


  Specifies the format of the input file as a string. It must be one of `json`
  (default), `csv`, or `dict`:

  * `json`
      * a "file-like" object containing newline-delimited JSON
  * `csv`
      * a "file-like" object containing newline-delimited CSV
  * `dict`
      * a `list` of Python `dict` objects corresponding to list of
        newline-delimited JSON, in other words `List[Dict[str, Any]]`
      * applies only if `SchemaGenerator` is used as a library through the
        `run()` or `deduce_schema()` method
      * useful if the input data (usually JSON) has already been read into memory
        and parsed from newline-delimited JSON into native Python dict objects.

  If `csv` file is specified, the `--keep_nulls` flag is automatically activated.
  This is required because CSV columns are defined positionally, so the schema
  file must contain all the columns specified by the CSV file, in the same
  order, even if the column contains an empty value for every record.

  See [Issue #26](https://github.com/bxparks/bigquery-schema-generator/issues/26)
  for implementation details.

  <a name="KeepNulls"></a>


  Normally when the input data file contains a field which has a null, empty
  array or empty record as its value, the field is suppressed in the schema file.
  This flag enables this field to be included in the schema file.

  In other words, using a data file containing just nulls and empty values:
  ```bash
  $ generate_schema
  { "s": null, "a": [], "m": {} }
  ^D
  INFO:root:Processed 1 lines
  []
  ```

  With the `keep_nulls` flag, we get:
  ```bash
  $ generate-schema --keep_nulls
  { "s": null, "a": [], "m": {} }
  ^D
  INFO:root:Processed 1 lines
  [
    {
      "mode": "REPEATED",
      "type": "STRING",
      "name": "a"
    },
    {
      "mode": "NULLABLE",
      "fields": [
        {
          "mode": "NULLABLE",
          "type": "STRING",
          "name": "__unknown__"
        }
      ],
      "type": "RECORD",
      "name": "d"
    },
    {
      "mode": "NULLABLE",
      "type": "STRING",
      "name": "s"
    }
  ]
  ```

  <a name="QuotedValuesAreStrings"></a>


  By default, quoted values are inspected to determine if they can be interpreted
  as `DATE`, `TIME`, `TIMESTAMP`, `BOOLEAN`, `INTEGER` or `FLOAT`. This is
  consistent with the algorithm used by `bq load`. However, for the `BOOLEAN`,
  `INTEGER`, or `FLOAT` types, it is sometimes more useful to interpret those as
  normal strings instead. This flag disables type inference for `BOOLEAN`,
  `INTEGER` and `FLOAT` types inside quoted strings.

  ```bash
  $ generate-schema
  { "name": "1" }
  ^D
  [
    {
      "mode": "NULLABLE",
      "name": "name",
      "type": "INTEGER"
    }
  ]

  $ generate-schema --quoted_values_are_strings
  { "name": "1" }
  ^D
  [
    {
      "mode": "NULLABLE",
      "name": "name",
      "type": "STRING"
    }
  ]
  ```

  <a name="InferMode"></a>


  Set the schema `mode` of a field to `REQUIRED` instead of the default
  `NULLABLE` if the field contains a non-null or non-empty value for every data
  record in the input file. This option is available only for CSV
  (`--input_format csv`) files. It is theoretically possible to implement this
  feature for JSON files, but too difficult to implement in practice because
  fields are often completely missing from a given JSON record (instead of
  explicitly being defined to be `null`).

  In addition to the above, this option, when used in conjunction with
  `--existing_schema_map`, will allow fields to be relaxed from REQUIRED to
  NULLABLE if they were REQUIRED in the existing schema and NULL rows are found in
  the new data we are inferring a schema from. In this case it can be used with
  either input_format, CSV or JSON.

  See [Issue #28](https://github.com/bxparks/bigquery-schema-generator/issues/28)
  for implementation details.

  <a name="DebuggingInterval"></a>


  By default, the `generate_schema.py` script prints a short progress message
  every 1000 lines of input data. This interval can be changed using the
  `--debugging_interval` flag.

  ```bash
  $ generate-schema --debugging_interval 50 < file.data.json > file.schema.json
  ```

  <a name="DebuggingMap"></a>


  Instead of printing out the BigQuery schema, the `--debugging_map` prints out
  the bookkeeping metadata map which is used internally to keep track of the
  various fields and their types that were inferred using the data file. This
  flag is intended to be used for debugging.

  ```bash
  $ generate-schema --debugging_map < file.data.json > file.schema.json
  ```

  <a name="SanitizedNames"></a>


  BigQuery column names are [restricted to certain characters and
  length](https://cloud.google.com/bigquery/docs/schemas#column_names):
  * it must contain only letters (a-z, A-Z), numbers (0-9), or underscores
  * it must start with a letter or underscore
  * the maximum length is 128 characters
  * column names are case-insensitive

  For CSV files, the `bq load` command seems to automatically convert invalid
  column names into valid column names. This flag attempts to perform some of the
  same transformations, to avoid having to scan through the input data twice to
  generate the schema file. The transformations are:

  * any character outside of ASCII letters, numbers and underscore
    (`[a-zA-Z0-9_]`) are converted to an underscore. For example `go&2#there!` is
    converted to `go_2_there_`;
  * names longer than 128 characters are truncated to 128.

  My recollection is that the `bq load` command does *not* normalize the JSON key
  names. Instead it prints an error message. So the `--sanitize_names` flag is
  useful mostly for CSV files. For JSON files, you'll have to do a second pass
  through the data files to cleanup the column names anyway. See
  [Issue #14](https://github.com/bxparks/bigquery-schema-generator/issues/14) and
  [Issue #33](https://github.com/bxparks/bigquery-schema-generator/issues/33).

  <a name="IgnoreInvalidLines"></a>


  By default, if an error is encountered on a particular line, processing stops
  immediately with an exception. This flag causes invalid lines to be ignored and
  processing continues. A list of all errors and their line numbers will be
  printed on the STDERR after processing the entire file.

  This flag is currently most useful for JSON files, to ignore lines which do not
  parse correctly as a JSON object.

  This flag is probably not useful for CSV files. CSV files are processed by the
  `DictReader` class which performs its own line processing internally, including
  extracting the column names from the first line of the file. If the `DictReader`
  does throw an exception on a given line, we would not be able to catch it and
  continue processing. Fortunately, CSV files are fairly robust, and the schema
  deduction logic will handle any missing or extra columns gracefully.

  Fixes
  [Issue #49](https://github.com/bxparks/bigquery-schema-generator/issues/49).

  <a name="ExistingSchemaPath"></a>


  There are cases where we would like to start from an existing BigQuery table
  schema rather than starting from scratch with a new batch of data we would like
  to load. In this case we can specify the path to a local file on disk that is
  our existing bigquery table schema. This can be generated via the following `bq
  show --schema` command:
  ```bash
  bq show --schema <PROJECT_ID>:<DATASET_NAME>.<TABLE_NAME> > existing_table_schema.json
  ```

  We can then run generate-schema with the additional option
  ```bash
  --existing_schema_path existing_table_schema.json
  ```

  There is some subtle interaction between the `--existing_schema_path` and fields
  which are marked with a `mode` of `REQUIRED` in the existing schema. If the new
  data contains a `null` value (either in a CSV or JSON data file), it is not
  clear if the schema should be changed to `mode=NULLABLE` or whether the new data
  should be ignored and the schema should remain `mode=REQUIRED`. The choice is
  determined by overloading the `--infer_mode` flag:

  * If `--infer_mode` is given, the new schema will be allowed to revert back to
    `NULLABLE`.
  * If `--infer_mode` is not given, the offending new record will be ignored
    and the new schema will remain `REQUIRED`.

  See discussion in
  [PR #57](https://github.com/bxparks/bigquery-schema-generator/pull/57) for
  more details.

  <a name="PreserveInputSortOrder"></a>


  By default, the order of columns in the BQ schema file is sorted
  lexicographically, which matched the original behavior of `bq load
  --autodetect`. If the `--preserve_input_sort_order` flag is given, the columns
  in the resulting schema file is not sorted, but preserves the order of
  appearance in the input JSON data. For example, the following JSON data with
  the `--preserve_input_sort_order` flag will produce:

  ```bash
  $ generate-schema --preserve_input_sort_order
  { "s": "string", "i": 3, "x": 3.2, "b": true }
  ^D
  [
    {
      "mode": "NULLABLE",
      "name": "s",
      "type": "STRING"
    },
    {
      "mode": "NULLABLE",
      "name": "i",
      "type": "INTEGER"
    },
    {
      "mode": "NULLABLE",
      "name": "x",
      "type": "FLOAT"
    },
    {
      "mode": "NULLABLE",
      "name": "b",
      "type": "BOOLEAN"
    }
  ]
  ```

  It is possible that each JSON record line contains only a partial subset of the
  total possible columns in the data set. The order of the columns in the BQ
  schema will then be the order that each column was first *seen* by the
  script:

  ```bash
  $ generate-schema --preserve_input_sort_order
  { "s": "string", "i": 3 }
  { "x": 3.2, "s": "string", "i": 3 }
  { "b": true, "x": 3.2, "s": "string", "i": 3 }
  ^D
  [
    {
      "mode": "NULLABLE",
      "name": "s",
      "type": "STRING"
    },
    {
      "mode": "NULLABLE",
      "name": "i",
      "type": "INTEGER"
    },
    {
      "mode": "NULLABLE",
      "name": "x",
      "type": "FLOAT"
    },
    {
      "mode": "NULLABLE",
      "name": "b",
      "type": "BOOLEAN"
    }
  ]
  ```

  **Note**: In Python 3.6 (the earliest version of Python supported by this
  project), the order of keys in a `dict` was the insertion-order, but this
  ordering was an implementation detail, and not guaranteed. In Python 3.7, that
  ordering was made permanent. So the `--preserve_input_sort_order` flag
  **should** work in Python 3.6 but is not guaranteed.

  See discussion in
  [PR #75](https://github.com/bxparks/bigquery-schema-generator/pull/75) for
  more details.

  <a name="UsingAsLibrary"></a>


  The `SchemaGenerator` class can be used programmatically as a library from a
  larger Python application.

  <a name="SchemaGeneratorRun"></a>


  The `bigquery_schema_generator` module can be used as a library by an external
  Python client code by creating an instance of `SchemaGenerator` and calling the
  `run(input, output)` method:

  ```python
  from bigquery_schema_generator.generate_schema import SchemaGenerator

  generator = SchemaGenerator(
      input_format=input_format,
      infer_mode=infer_mode,
      keep_nulls=keep_nulls,
      quoted_values_are_strings=quoted_values_are_strings,
      debugging_interval=debugging_interval,
      debugging_map=debugging_map,
      sanitize_names=sanitize_names,
      ignore_invalid_lines=ignore_invalid_lines,
      preserve_input_sort_order=preserve_input_sort_order,
  )

  FILENAME = "..."

  with open(FILENAME) as input_file:
      generator.run(input_file=input_file, output_file=output_file)
  ```

  The `input_format` is one of `json`, `csv`, and `dict` as described in the
  [Input Format](#InputFormat) section above. The `input_file` must match the
  format given by this parameter.

  See [generatorrun.py](examples/generatorrun.py) for an example.

  <a name="SchemaGeneratorDeduceSchemaFromFile"></a>


  If you need to process the generated schema programmatically, create an instance
  of `SchemaGenerator` using the appropriate `input_format` option, use the
  `deduce_schema()` method to read in the file, then postprocess the resulting
  `schema_map` and `error_log` data structures.

  The following reads in a JSON file (see [jsoneader.py](examples/jsoneader.py)):

  ```python
  import json
  import logging
  import sys
  from bigquery_schema_generator.generate_schema import SchemaGenerator

  FILENAME = "jsonfile.json"

  generator = SchemaGenerator(
      input_format='json',
      quoted_values_are_strings=True,
  )

  with open(FILENAME) as file:
      schema_map, errors = generator.deduce_schema(file)

  for error in errors:
      logging.info("Problem on line %s: %s", error['line_number'], error['msg'])

  schema = generator.flatten_schema(schema_map)
  json.dump(schema, sys.stdout, indent=2)
  print()
  ```

  The following reads a CSV file (see [csvreader.py](examples/csvreader.py)):

  ```python
  ...(same as above)...

  generator = SchemaGenerator(
      input_format='csv',
      infer_mode=True,
      quoted_values_are_strings=True,
      sanitize_names=True,
  )

  with open(FILENAME) as file:
      schema_map, errors = generator.deduce_schema(file)

  ...(same as above)...
  ```

  The `deduce_schema()` also supports starting from an existing `schema_map`
  instead of starting from scratch. This is the internal version of the
  `--existing_schema_path` functionality.

  ```python
  schema_map1, errors = generator.deduce_schema(input_data=data1)
  schema_map2, errors = generator.deduce_schema(
      input_data=data1, schema_map=schema_map1
  )
  ```

  The `input_data` must match the `input_format` given in the constructor. The
  format is described in the [Input Format](#InputFormat) section above.

  <a name="SchemaGeneratorDeduceSchemaFromDict"></a>


  If the JSON data set has already been read into memory into an array or iterable
  of Python `dict` objects, the `SchemaGenerator` can process that too using the
  `input_format='dict'` option. Here is an example from
  [dictreader.py](examples/dictreader.py):


  ```Python
  import json
  import logging
  import sys
  from bigquery_schema_generator.generate_schema import SchemaGenerator

  generator = SchemaGenerator(input_format='dict')
  input_data = [
      {
          's': 'string',
          'b': True,
      },
      {
          'd': '2021-08-18',
          'x': 3.1
      },
  ]
  schema_map, errors = generator.deduce_schema(input_data)
  schema = generator.flatten_schema(schema_map)
  json.dump(schema, sys.stdout, indent=2)
  print()
  ```

  **Note**: The `input_format='dict'` option supports any `input_data` object
  which acts like an iterable of `dict`. The data does not have to be loaded into
  memory.

  <a name="SchemaGeneratorDeduceSchemaFromCsvDictReader"></a>


  The `input_format='csvdictreader'` option is similar to `input_format='dict'`
  but sort of acts like `input_format='csv'`. It supports any object that behaves
  like an iterable of `dict`, but it is intended to be used with the
  [csv.DictReader](https://docs.python.org/3/library/csv.html) object.

  The difference between `'dict'` and `'csvdictreader'` is the assumption made
  about the shape of the data. The `'csvdictreader'` option assumes that the data
  is tabular like a CSV file, with every row usually containing an entry for every
  column. The `'dict'` option does not make that assumption, and the data can be
  more hierarchical with some rows containing partial sets of columns.

  This semantic difference means that `'csvdictreader'` supports options which
  apply to `'csv'` files. In particular, the `infer_mode=True` option can be used
  to determine if the `mode` field can be `REQUIRED` instead of `NULLABLE` if the
  script finds that all columns are defined in every row.

  Here is an example from [tsvreader.py](examples/tsvreader.py) which reads a
  tab-separate file (TSV):

  ```python
  import csv
  import json
  import sys
  from bigquery_schema_generator.generate_schema import SchemaGenerator

  FILENAME = "tsvfile.tsv"

  generator = SchemaGenerator(input_format='dict')
  with open(FILENAME) as file:
      reader = csv.DictReader(file, delimiter='\t')
      schema_map, errors = generator.deduce_schema(reader)

  schema = generator.flatten_schema(schema_map)
  json.dump(schema, sys.stdout, indent=2)
  print()
  ```

  <a name="SchemaTypes"></a>


  <a name="SupportedTypes"></a>


  The `bq show --schema` command produces a JSON schema file that uses the
  older [Legacy SQL date types](https://cloud.google.com/bigquery/data-types).
  For compatibility, **generate-schema** script will also generate a schema file
  using the legacy data types.

  The supported types are:

  * `BOOLEAN`
  * `INTEGER`
  * `FLOAT`
  * `STRING`
  * `TIMESTAMP`
  * `DATE`
  * `TIME`
  * `RECORD`

  The `generate-schema` script supports both `NULLABLE` and `REPEATED` modes of
  all of the above types.

  The supported format of `TIMESTAMP` is as close as practical to the
  [bq load format](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#timestamp-type):
  ```
  YYYY-[M]M-[D]D[( |T)[H]H:[M]M:[S]S[.DDDDDD]][time zone]
  ```
  which appears to be an extension of the
  [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).
  The difference from `bq load` is that the `[time zone]` component can be only
  * `Z`
  * `UTC` (same as `Z`)
  * `(+|-)H[H][:M[M]]`

  Note that BigQuery supports up to 6 decimal places after the integer 'second'
  component. `generate-schema` follows the same restriction for compatibility. If
  your input file contains more than 6 decimal places, you need to write a data
  cleansing filter to fix this.

  The suffix `UTC` is not standard ISO 8601 nor
  [documented by Google](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#time-zones)
  but the `UTC` suffix is used by `bq extract` and the web interface. (See
  [Issue 19](https://github.com/bxparks/bigquery-schema-generator/issues/19).)

  Timezone names from the [tz database](http://www.iana.org/time-zones) (e.g.
  "America/Los_Angeles") are _not_ supported by `generate-schema`.

  The following types are _not_ supported at all:

  * `BYTES`
  * `DATETIME` (unable to distinguish from `TIMESTAMP`)

  <a name="TypeInference"></a>


  The `generate-schema` script attempts to emulate the various type conversion and
  compatibility rules implemented by **bq load**:

  * `INTEGER` can upgrade to `FLOAT`
      * if a field in an early record is an `INTEGER`, but a subsequent record
        shows this field to have a `FLOAT` value, the type of the field will be
        upgraded to a `FLOAT`
      * the reverse does not happen, once a field is a `FLOAT`, it will remain a
        `FLOAT`
  * conflicting `TIME`, `DATE`, `TIMESTAMP` types upgrades to `STRING`
      * if a field is determined to have one type of "time" in one record, then
        subsequently a different "time" type, then the field will be assigned a
        `STRING` type
  * `NULLABLE RECORD` can upgrade to a `REPEATED RECORD`
      * a field may be defined as `RECORD` (aka "Struct") type with `{ ... }`
      * if the field is subsequently read as an array with a `[{ ... }]`, the
        field is upgraded to a `REPEATED RECORD`
  * a primitive type (`FLOAT`, `INTEGER`, `STRING`) cannot upgrade to a `REPEATED`
    primitive type
      * there's no technical reason why this cannot be allowed, but **bq load**
        does not support it, so we follow its behavior
  * a `DATETIME` field is always inferred to be a `TIMESTAMP`
      * the format of these two fields is identical (in the absence of timezone)
      * we follow the same logic as **bq load** and always infer these as
        `TIMESTAMP`
  * `BOOLEAN`, `INTEGER`, and `FLOAT` can appear inside quoted strings
      * In other words, `"true"` (or `"True"` or `"false"`, etc) is considered a
        BOOLEAN type, `"1"` is considered an INTEGER type, and `"2.1"` is
        considered a FLOAT type. Luigi Mori (jtschichold@) added additional logic
        to replicate the type conversion logic used by `bq load` for these
        strings.
      * This type inference inside quoted strings can be disabled using the
        `--quoted_values_are_strings` flag
      * (See [Issue #22](https://github.com/bxparks/bigquery-schema-generator/issues/22) for more details.)
  * `INTEGER` values overflowing a 64-bit signed integer upgrade to `FLOAT`
      * integers greater than `2^63-1` (9223372036854775807)
      * integers less than `-2^63` (-9223372036854775808)
      * (See [Issue #18](https://github.com/bxparks/bigquery-schema-generator/issues/18) for more details)

  <a name="Examples"></a>


  Here is an example of a single JSON data record on the STDIN (the `^D` below
  means typing Control-D, which indicates "end of file" under Linux and MacOS):

  ```bash
  $ generate-schema
  { "s": "string", "b": true, "i": 1, "x": 3.1, "t": "2017-05-22T17:10:00-07:00" }
  ^D
  INFO:root:Processed 1 lines
  [
    {
      "mode": "NULLABLE",
      "name": "b",
      "type": "BOOLEAN"
    },
    {
      "mode": "NULLABLE",
      "name": "i",
      "type": "INTEGER"
    },
    {
      "mode": "NULLABLE",
      "name": "s",
      "type": "STRING"
    },
    {
      "mode": "NULLABLE",
      "name": "t",
      "type": "TIMESTAMP"
    },
    {
      "mode": "NULLABLE",
      "name": "x",
      "type": "FLOAT"
    }
  ]
  ```

  In most cases, the data file will be stored in a file:
  ```bash
  $ cat > file.data.json
  { "a": [1, 2] }
  { "i": 3 }
  ^D

  $ generate-schema < file.data.json > file.schema.json
  INFO:root:Processed 2 lines

  $ cat file.schema.json
  [
    {
      "mode": "REPEATED",
      "name": "a",
      "type": "INTEGER"
    },
    {
      "mode": "NULLABLE",
      "name": "i",
      "type": "INTEGER"
    }
  ]
  ```

  Here is the schema generated from a CSV input file. The first line is the header
  containing the names of the columns, and the schema lists the columns in the
  same order as the header:
  ```bash
  $ generate-schema --input_format csv
  e,b,c,d,a
  1,x,true,,2.0
  2,x,,,4
  3,,,,
  ^D
  INFO:root:Processed 3 lines
  [
    {
      "mode": "NULLABLE",
      "name": "e",
      "type": "INTEGER"
    },
    {
      "mode": "NULLABLE",
      "name": "b",
      "type": "STRING"
    },
    {
      "mode": "NULLABLE",
      "name": "c",
      "type": "BOOLEAN"
    },
    {
      "mode": "NULLABLE",
      "name": "d",
      "type": "STRING"
    },
    {
      "mode": "NULLABLE",
      "name": "a",
      "type": "FLOAT"
    }
  ]
  ```

  Here is an example of the schema generated with the `--infer_mode` flag:
  ```bash
  $ generate-schema --input_format csv --infer_mode
  name,surname,age
  John
  Michael,,
  Maria,Smith,30
  Joanna,Anders,21
  ^D
  INFO:root:Processed 4 lines
  [
    {
      "mode": "REQUIRED",
      "name": "name",
      "type": "STRING"
    },
    {
      "mode": "NULLABLE",
      "name": "surname",
      "type": "STRING"
    },
    {
      "mode": "NULLABLE",
      "name": "age",
      "type": "INTEGER"
    }
  ]
  ```

  <a name="Benchmarks"></a>


  I wrote the `bigquery_schema_generator/anonymize.py` script to create an
  anonymized data file `tests/testdata/anon1.data.json.gz`:
  ```bash
  $ ./bigquery_schema_generator/anonymize.py < original.data.json \
      > anon1.data.json
  $ gzip anon1.data.json
  ```
  This data file is 290MB (5.6MB compressed) with 103080 data records.

  Generating the schema using
  ```bash
  $ bigquery_schema_generator/generate_schema.py < anon1.data.json \
      > anon1.schema.json
  ```
  took 67s on a Dell Precision M4700 laptop with an Intel Core i7-3840QM CPU @
  2.80GHz, 32GB of RAM, Ubuntu Linux 18.04, Python 3.6.7.

  <a name="SystemRequirements"></a>


  This project was initially developed on Ubuntu 17.04 using Python 3.5.3, but it
  now requires Python 3.6 or higher, I think mostly due to the use of f-strings.

  I have tested it on:

  * Ubuntu 22.04, Python 3.10.6
  * Ubuntu 20.04, Python 3.8.5
  * Ubuntu 18.04, Python 3.7.7
  * Ubuntu 18.04, Python 3.6.7
  * Ubuntu 17.10, Python 3.6.3
  * MacOS 12.6.2 (Monterey), Python 3.10.9
  * MacOS 11.7.2 (Big Sur), Python 3.10.9
  * MacOS 11.7.2 (Big Sur), Python 3.8.9
  * MacOS 10.14.2 (Mojave), Python 3.6.4
  * MacOS 10.13.2 (High Sierra), Python 3.6.4

  The GitHub Actions continuous integration pipeline validates on Python 3.7,
  3.8, 3.9, and 3.10.

  The unit tests are invoked with `$ make tests` target, and depends only on the
  built-in Python `unittest` package.

  The coding style check is invoked using `$ make flake8` and depends on the
  `flake8` package. It can be installed using `$ pip3 install --user flake8`.

  <a name="License"></a>


  Apache License 2.0

  <a name="Feedback"></a>


  If you have any questions, comments, or feature requests for this library,
  please use the [GitHub
  Discussions](https://github.com/bxparks/bigquery-schema-generator/discussions)
  for this project. If you have bug reports, please file a ticket in [GitHub
  Issues](https://github.com/bxparks/bigquery-schema-generator/issues). Feature
  requests should go into Discussions first because they often have alternative
  solutions which are useful to remain visible, instead of disappearing from the
  default view of the Issue tracker after the ticket is closed.

  Please refrain from emailing me directly unless the content is sensitive. The
  problem with email is that I cannot reference the email conversation when other
  people ask similar questions later.

  <a name="Authors"></a>


  * Created by Brian T. Park (brian@xparks.net).
  * Type inference inside quoted strings by Luigi Mori (jtschichold@).
  * Flag to disable type inference inside quoted strings by Daniel Ecer
    (de-code@).
  * Support for CSV files and detection of `REQUIRED` fields by Sandor Korotkevics
    (korotkevics@).
  * Better support for using `bigquery_schema_generator` as a library from an
    external Python code by StefanoG_ITA (StefanoGITA@).
  * Sanitizing of column names to valid BigQuery characters and length by Jon
    Warghed (jonwarghed@).
  * Bug fix in `--sanitize_names` by Riccardo M. Cefala (riccardomc@).
  * Print full path of nested JSON elements in error messages, by Austin Brogle
    (abroglesc@).
  * Allow an existing schema file to be specified using `--existing_schema_path`,
    by Austin Brogle (abroglesc@) and Bozo Dragojevic (bozzzzo@).
  * Allow `SchemaGenerator.deduce_schema()` to accept a list of native Python
    `dict` objects, by Zigfrid Zvezdin (ZiggerZZ@).
  * Make the column order in the BQ schema file match the order of appearance in
    the JSON data file using the `--preserve_input_sort_order` flag. By Kevin
    Deggelman (kdeggelman@).


pkgId: 84917c0022fae8602b8b9088c94e18c4a467797a90bbc49ce60bf1d3f31e6ffc
name: python-bigraph-schema
arch: src
version: 0.0.46
epoch: 0
release: 1
summary: A serializable type schema for compositional systems biology
url: https://github.com/vivarium-collective/bigraph-schema
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigraph-schema-0.0.46-1.src.rpm
checksum_type: sha256
description:
  [![PyPI version](https://img.shields.io/pypi/v/bigraph-schema.svg)](https://pypi.org/project/bigraph-schema/)
  [![Tutorial](https://img.shields.io/badge/GitHub%20Pages-Tutorial-brightgreen)](https://vivarium-collective.github.io/bigraph-schema/notebooks/demo.html)

  Welcome to `bigraph-schema` – a library providing a serializable type schema for compositional systems biology
  simulations. This library is an integral component of the broader Process Bigraph project, which seeks to create an
  innovative framework for representing, simulating, and analyzing complex biological systems.

  The goal of `bigraph-schema` is to support interoperability and extensibility across compositional modeling,
  facilitating seamless integration with existing and future modeling platforms. This is achieved by establishing a
  standardized and serializable schema for the complex, hierarchical, and multiscale nature of biological systems.



  To install `bigraph-schema`, you can use pip:

  ```console
  pip install bigraph-schema
  ```



  To get started with bigraph-schema, check out our resources:

  * [Type System Overview](https://vivarium-collective.github.io/bigraph-schema/notebooks/core.html): A tutorial demonstrating the functionality of bigraph-schema's type system, "core".
  * [Bigraph Schema Basics Tutorial](https://vivarium-collective.github.io/bigraph-viz/notebooks/basics.html): A  tutorial covering the essential aspects of the bigraph-schema library.
  This resource will guide you through the core concepts and methods, helping you to master the basic operations.



  Bigraph-schema is open-source software released under the [Apache 2 License](https://github.com/vivarium-collective/bigraph-schema/blob/main/LICENSE).


pkgId: f43dceda1a40d579787dffb0c1a8faa5db59e37e9df226b64ffb4eba6e6a8449
name: python-bigraph-viz
arch: src
version: 0.0.35
epoch: 0
release: 1
summary: A graphviz-based plotting tool for compositional bigraph schema
url: https://github.com/vivarium-collective/bigraph-viz
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigraph-viz-0.0.35-1.src.rpm
checksum_type: sha256
description:
  [![PyPI](https://img.shields.io/pypi/v/bigraph-viz.svg)](https://pypi.org/project/bigraph-viz/)
  [![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages-Tutorial-brightgreen)](https://vivarium-collective.github.io/bigraph-viz/notebooks/basics.html)

  **Bigraph-viz** is an easy-to-use plotting tool for compositional bigraph schema, built on top of Graphviz.

  <p align="center">
      <img src="https://github.com/vivarium-collective/bigraph-viz/blob/main/doc/_static/cell_structure_function.png?raw=true" width="600" alt="Bigraph-viz example">
  </p>



  Compositional Bigraph Schemas (CBS) are based on a mathematical formalism introduced by
  <a href="https://www.google.com/search?q=the+space+and+motion+of+communicating+agents+by+robin+milner" target="_blank">Robin Milner in 2009</a>
  , and used in Vivarium.
  Bigraphs consist of networks with embeddable nodes that can be placed *within* other nodes and dynamically restructured.
  CBS reimagines the bigraph concept. Variables are contained within Stores (the circles in the figure), which can be embedded
  in a hierarchy, as shown by the dark edges. Instead of Milner's hyperedges, CBS employs Processes (the rectangles) which
  connect via wires (dashed edges) to shared variables within the Stores. Processes and Stores form a type of bipartite graph,
  as illustrated by the dashed edges.

  In Vivarium, the CBS is used to structure a modular multiscale simulation. Bigraph-viz is part of an effort to
  standardize this structure, so that it can be used as an exchange format for multiscale simulations.






  Before installing `bigraph-viz`, make sure you have [Graphviz](https://pypi.org/project/graphviz/).



  ```console
  sudo apt-get install -y graphviz
  ```


  ```console
  brew install graphviz
  ```


  Download and install the Graphviz installer from the [official website](https://graphviz.org/download/).
  Make sure to add the Graphviz bin directory to your system's PATH.



  Once Graphviz is installed, you can install `bigraph-viz` using pip:

  ```console
  pip install bigraph-viz
  ```



  To get started with Bigraph-viz, explore our resources:
  * [Bigraph Schema Basics Tutorial](https://vivarium-collective.github.io/bigraph-viz/notebooks/basics.html).
  * [Formatting Tutorial](https://vivarium-collective.github.io/bigraph-viz/notebooks/format.html) for examples
  about how to adjust the final look of your bigraph figure.
  * [Ecoli](https://raw.githubusercontent.com/vivarium-collective/bigraph-viz/main/doc/_static/ecoli.png) for the wiring
  diagraph of a whole-cell E. coli model.



  Bigraph-viz is open-source software released under the [Apache 2 License](https://github.com/vivarium-collective/bigraph-viz/blob/main/LICENSE).


pkgId: f00d36e11a0dd542aa8e78089bec7c2b471d7f5d706eec0e213b23991cbc9292
name: python-bigrest
arch: src
version: 1.7.3
epoch: 0
release: 1
summary: A Python SDK for F5 iControl REST API
url: https://github.com/leonardobdes/BIGREST
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigrest-1.7.3-1.src.rpm
checksum_type: sha256
description:
  | F5 BIG-IP and BIG-IQ devices have an API called iControl REST.
  | BIGREST is an SDK with multiple methods and functions that simplifies the use of the iControl REST API.


pkgId: 587212057fb0a95bbe6da52ce508403f1a8d54bdce9d67bd601f42750f5e793c
name: python-bigtools
arch: src
version: 1.0.6
epoch: 0
release: 1
summary: Tools for python
url: https://gitee.com/maxbanana
rpm_license: Apache
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigtools-1.0.6-1.src.rpm
checksum_type: sha256
description:
  python 工具箱，实现了一些实用的函数、类和赋值了一批常用变量，方便调用，减少工程代码量。



  ```
  pip install bigtools
  ```



  每个函数、类、变量均有两种导入的方法，视不同情况选择适合的写法。为了更好的说明这个项目的情况，创建这个README我会尽量使用第二种写法。实际工程中我会使用第一种写法，简单直接。

  ```python3


  from bigtools import generate_hash_value

  from bigtools.hash_tools import generate_hash_value
  ```


  以生成hash值为例：
  ```python3

  from bigtools import generate_hash_value




  hash_value = generate_hash_value('python工具箱')  # 默认使用md5，可选sha1、sha256 等等
  print(hash_value)
  ```

  2.1 以使用 headers 为例：
  ```python3
  from bigtools import headers



  print(headers)

  import requests
  url = ''
  requests.get(url=url, headers=headers)
  ```
  2.2 以使用 ContentType 为例：
  大写字母开头的是类(type is class)，类里包含已赋值的变量，可用.来加载变量

  ```python3
  from bigtools import ContentType



  print(ContentType.app_json_headers)


  import requests
  url = ''
  data = ''
  response = requests.post(url=url, data=data, headers=ContentType.app_json_headers)
  print(response)
  ```


  ```python3
  from bigtools.db_tools import mongo_client, MinioOperate
  from bigtools.hash_tools import generate_hash_value, get_new_hash_object_dict
  from bigtools.jieba_tools import get_keywords_from_text
  from bigtools.log_tools import set_log, SetLog
  from bigtools.yaml_tools import load_yaml, load_all_yaml, write_yaml
  from bigtools.path_tools import check_make_dir, get_execution_dir, get_file_type, get_execution_file_name
  from bigtools.requests_tools import get_requests_session, DealException, download, save_response_data
  from bigtools.similarity_tools import cosine_similarity, edit_distance
  from bigtools.sign_tools import generate_sign, generate_fused_sign, parse_sign, merge_str, merge_algorithm_dict
  from bigtools.sign_tools import insert_middle, verify_easy_sign, generate_easy_sign, generate_fixed_sign
  from bigtools.sign_tools import generate_fixed_encoded_sign, verify_fixed_encoded_sign, verify_sign_by_api
  from bigtools.sign_tools import async_verify_sign_by_api, common_verify_sign, async_common_verify_sign
  from bigtools.stopwords import stopwords
  from bigtools.more_tools import extract_ip, get_file_size, equally_split_list_or_str, json_validate, load_config
  from bigtools.more_tools import set_env, load_env, get_func_use_time, OpenFile, sleep, count_str_start_or_end_word_num
  from bigtools.more_tools import is_chinese, is_english, is_number, generate_random_string
  ```

  详情见于 bigtools.default_data


  ```python3
  from bigtools.default_data import headers
  from bigtools.default_data import user_agents
  from bigtools.default_data import random_headers
  from bigtools.default_data import en_letter
  from bigtools.default_data import numbers
  ```



  ```python3
  from bigtools.default_data import ContentType

  print(
  ContentType.app_json,
  ContentType.app_xwfu,
  ContentType.app_xml,
  ContentType.mul_fd,
  ContentType.text_xml,
  ContentType.app_json_headers,
  ContentType.app_xwfu_headers,
  ContentType.app_xml_headers,
  ContentType.mul_fd_headers,
  ContentType.text_xml_headers
  )
  ```

  ```python3
  from bigtools.default_data import DateType
  """
  用于编写代码时提示，不建议写入代码里。写入会代码增加阅读难度。
  实现了以下常用日期格式：
  YYYY-MM-DD
  YYYY年MM月DD日
  YYYY.MM.DD
  YYYYMMDD
  YYYY/MM/DD
  """

  print(DateType.type_1)

  print(DateType.type_2)

  print(DateType.type_3)

  print(DateType.type_4)

  print(DateType.type_5)
  ```

  ```python3
  from bigtools.default_data import RePattern
  print(RePattern.window_INITIAL_STATE)
  ```


pkgId: ee7301428e7b98cc17ddce130bb5e1d6476ef8f36026fa05851947c1ab36161d
name: python-bigtree
arch: src
version: 0.21.1
epoch: 0
release: 1
url: https://pypi.org/project/bigtree/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigtree-0.21.1-1.src.rpm
checksum_type: sha256
summary:
  Tree Implementation and Methods for Python, integrated with list, dictionary, pandas and polars DataFrame.

description:
  Related Links:
  - [Documentation](https://bigtree.readthedocs.io/)
  - [GitHub](https://github.com/kayjan/bigtree/)
  - Community
    - [Issues](https://github.com/kayjan/bigtree/issues)
    / [Discussions](https://github.com/kayjan/bigtree/discussions)
    / [Changelog](https://github.com/kayjan/bigtree/blob/master/CHANGELOG.md)
    / [Contributing](https://bigtree.readthedocs.io/en/stable/home/contributing/)
  - Package
    - [PyPI](https://pypi.org/project/bigtree/)
    / [Conda](https://anaconda.org/conda-forge/bigtree)
  - Articles
    - [Python Tree Implementation with BigTree](https://towardsdatascience.com/python-tree-implementation-with-bigtree-13cdabd77adc#245a-94ae81f0b3f1)
    - [The Reingold Tilford Algorithm Explained, with Walkthrough](https://towardsdatascience.com/reingold-tilford-algorithm-explained-with-walkthrough-be5810e8ed93?sk=2db8e10398cee76c486c4b06b0b33322)


pkgId: be460e2d4981f1c2b897a0caca755258ac2e172e01ae8374c91dd89c8bc94e95
name: python-bigvganinference
arch: src
version: 0.0.3
epoch: 0
release: 1
summary: An unofficial minimal package for using BigVGAN at inference time
url: https://pypi.org/project/bigvganinference/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigvganinference-0.0.3-1.src.rpm
checksum_type: sha256
description:
  An unofficial minimal package for using BigVGAN at inference time

  [![PyPI version](https://img.shields.io/pypi/v/bigvganinference)](https://pypi.org/project/bigvganinference/)
  ![License](https://img.shields.io/pypi/l/bigvganinference)
  ![Python versions](https://img.shields.io/pypi/pyversions/bigvganinference)



  ```bash
  pip install bigvganinference
  ```

  or install from source:

  ```bash
  git clone https://github.com/thunn/BigVGANInference.git
  cd BigVGANInference
  poetry install
  ```



  Loading model is as simple as:
  ```python
  from bigvganinference import BigVGANInference




  model = BigVGANInference.from_pretrained(
      'nvidia/BigVGAN-V2-44KHZ-128BAND-512X', use_cuda_kernel=False
  )


  model = BigVGANInference.from_pretrained(
      "path/to/local/model", use_cuda_kernel=False
  )



  path_to_audio = "path/to/audio.wav"
  wav, sr = librosa.load(path_to_audio, sr=model.h.sampling_rate, mono=True)


  mel = model.get_mel_spectrogram(wav)



  output_audio = model(input_mel)
  ```

  See the [example](https://github.com/thunn/BigVGANInference/blob/main/example/inference.py) for full usage example.


  This is an unofficial implementation based on [original BigVGAN repository](https://github.com/NVIDIA/BigVGAN).


  This project is licensed under the MIT License. See the [LICENSE](https://github.com/thunn/BigVGANInference/blob/main/LICENSE) file for details.


pkgId: 8f2547905e32543d025b8f5f68761b872484db85236060f6f7eca4b34ccfa843
name: python-bigxml
arch: src
version: 1.1.0
epoch: 0
release: 1
summary: Pythonic xml parser to handle big files or streams
url: https://github.com/rogdham/bigxml
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bigxml-1.1.0-1.src.rpm
checksum_type: sha256
description:
  [📖 Documentation](https://bigxml.rogdham.net/)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[📃 Changelog](./CHANGELOG.md)

rpm_license:
  The MIT License (MIT)  Copyright (c) 2020 Rogdham  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


pkgId: 71f1b1dd2b78f67d95e9e46ea4e014a4ef53298da516e85bb3f94dd957e0a28e
name: python-bihc
arch: src
version: 0.0.8.10
epoch: 0
release: 1
summary: BIHC: Beam-Induced Heating Computation package
url: https://github.com/LeonardoSito/BIHC
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bihc-0.0.8.10-1.src.rpm
checksum_type: sha256
description:
  There is a [paper about `bihc`](10.18429/JACoW-HB2023-THBP52), presented at 8th ICFA Advanced Beam Dynamics Workshop on High-Intensity and High-Brightness Hadron Beam (0ct. 2023).
  If you are using `bihc` in your scientific research, please help our scientific
  visibility by citing our work:
  > [1] E. de la Fuente, L. Sito, F. Giordano, G. Rumolo, B. Salvant, and C. Zannini, “A Python Package to Compute Beam-Induced Heating in Particle Accelerators and Applications,” JACoW, vol. HB2023, pp. 611–614, 2024, doi: [https://doi.10.18429/JACoW-HB2023-THBP52](https://jacow.org/hb2023/papers/thbp52.pdf).
  Bibtex:
  ```
  @article{Sito:2024ywv,
      author = "Sito, Leonardo and de la Fuente, Elena and Giordano, Francesco and Rumolo, Giovanni and Salvant, Benoit and Zannini, Carlo ",
      title = "{A Python Package to Compute Beam-Induced Heating in Particle Accelerators and Applications}",
      doi = "10.18429/JACoW-HB2023-THBP52",
      journal = "JACoW",
      volume = "HB2023",
      pages = "611--614",
      year = "2024"
  }


pkgId: f3a7cbb98bcca9b32bf01d15b1f0a92922af10040747274af5c093ac514aef61
name: python-biip
arch: src
version: 3.5.0
epoch: 0
release: 1
summary: Biip interprets the data in barcodes.
url: https://github.com/jodal/biip
rpm_license: Apache-2.0
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-biip-3.5.0-1.src.rpm
checksum_type: sha256
description:
  Biip is a Python library for making sense of the data in barcodes.
  The library can interpret the following formats:
  - GTIN-8, GTIN-12, GTIN-13, and GTIN-14 numbers,
    commonly found in EAN-8, EAN-13, and ITF-14 barcodes.
  - GS1 AI element strings,
    commonly found in GS1-128 barcodes.
  - UPC-A and UPC-E numbers, as found in UPC-A and UPC-E barcodes.
  For a quickstart guide and a complete API reference,
  see the [documentation](https://biip.readthedocs.io/).

  Biip requires Python 3.9 or newer.
  Biip is available from [PyPI](https://pypi.org/project/biip/):
  ```
  python3 -m pip install biip
  ```
  Optionally, with the help of `py-moneyed`, Biip can convert amounts with
  currency information to `moneyed.Money` objects.
  To install Biip with `py-moneyed`, run:
  ```
  python3 -m pip install "biip[money]"
  ```

  - [Documentation](https://biip.readthedocs.io/)
  - [Source code](https://github.com/jodal/biip)
  - [Releases](https://github.com/jodal/biip/releases)
  - [Issue tracker](https://github.com/jodal/biip/issues)
  - [Contributors](https://github.com/jodal/biip/graphs/contributors)
  - [Users](https://github.com/jodal/biip/wiki/Users)

  All planned features have been implemented.
  Please open an issue if you have any barcode parsing related needs that are not covered.

  - GS1 (multiple Element Strings with Application Identifiers)
    - Recognize all specified Application Identifiers.
    - Recognize allocating GS1 Member Organization from the GS1 Company Prefix.
    - Recognize the GS1 Company Prefix.
    - Parse fixed-length Element Strings.
    - Parse variable-length Element Strings.
      - Support configuring the separation character.
    - Parse AI `00` as SSCC.
    - Parse AI `01` and `02` as GTIN.
    - Parse AI `410`-`417` as GLN.
    - Parse dates/times into `datetime.date`/`datetime.datetime` values.
      - Interpret the year to be within -49/+50 years from today.
      - Interpret dates with day "00" as the last day of the month.
    - Parse variable measurement fields into `Decimal` values.
    - Parse discount percentage into `Decimal` values.
    - Parse amounts into `Decimal` values.
      - Additionally, if py-moneyed is installed,
        parse amounts with currency into `Money` values.
    - Encode as Human Readable Interpretation (HRI),
      e.g. with parenthesis around the AI numbers.
    - Parse Human Readable Interpretation (HRI) strings.
    - Easy lookup of parsed Element Strings by:
      - Application Identifier (AI) prefix
      - Part of AI's data title
  - GLN (Global Location Number)
    - Parse.
    - Extract and validate check digit.
    - Extract GS1 Prefix.
    - Extract GS1 Company Prefix.
  - GTIN (Global Trade Item Number)
    - Parse GTIN-8, e.g. from EAN-8 barcodes.
    - Parse GTIN-12, e.g. from UPC-A and UPC-E barcodes.
    - Parse GTIN-13, e.g. from EAN-13 barcodes.
    - Parse GTIN-14, e.g. from ITF-14 and GS1-128 barcodes.
    - Extract and validate check digit.
    - Extract GS1 Prefix.
    - Extract GS1 Company Prefix.
    - Extract packaging level digit from GTIN-14.
    - Encode GTIN-8 as GTIN-12/13/14.
    - Encode GTIN-12 as GTIN-13/14.
    - Encode GTIN-13 as GTIN-14.
  - RCN (Restricted Circulation Numbers), a subset of GTINs
    - Classification of RCN usage to either a geographical region or a company.
    - Parsing of variable measurements (price/weight) into `Decimal`
      values.
    - Parsing of price values into `Money` values if `py-moneyed` is
      installed and the region's RCN parsing rules specifies a currency.
    - Denmark: Parsing of weight and price.
    - Estland: Parsing of weight.
    - Finland: Parsing of weight.
    - Germany: Parsing of weight, price, and count, including validation of
      measurement check digit.
    - Great Britain: Parsing of price, including validation of measurement check
      digit.
    - Latvia: Parsing of weight.
    - Lithuania: Parsing of weight.
    - Norway: Parsing of weight and price.
    - Sweden: Parsing of weight and price.
    - Encode RCN with the variable measure part zeroed out,
      to help looking up the correct trade item.
  - SSCC (Serial Shipping Container Code)
    - Extract and validate check digit.
    - Extract GS1 Prefix.
    - Extract GS1 Company Prefix.
    - Extract extension digit.
    - Encode for human consumption, with the logical groups separated by whitespace.
  - UPC (Universal Product Code)
    - Parse 12-digit UPC-A.
    - Parse 6-digit UPC-E, with implicit number system 0 and no check digit.
    - Parse 7-digit UPC-E, with explicit number system and no check digit.
    - Parse 8-digit UPC-E, with explicit number system and a check digit.
    - Expand UPC-E to UPC-A.
    - Suppress UPC-A to UPC-E, for the values where it is supported.
  - Symbology Identifiers, e.g. `]EO`
    - Recognize all specified Symbology Identifier code characters.
    - Strip Symbology Identifiers before parsing the remainder.
    - Use Symbology Identifiers when automatically selecting what parser to use.

  Copyright 2020-2024 Stein Magnus Jodal and contributors.
  Licensed under the
  [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).


pkgId: 18260e22daf32e73b83a9a62ab1d1c641b1e4bd3c115079db45ddd38bfe60ead
name: python-bijou
arch: src
version: 0.1.7
epoch: 0
release: 1
url: https://github.com/hitlic/bijou
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bijou-0.1.7-1.src.rpm
checksum_type: sha256
summary:
  A fastai-like framework for training, tuning and probing pytorch models, which is compatible with pytorch_geometric.

description:
  A lightweight freamwork based on [fastai course](https://course.fast.ai) for training pytorch models conveniently. In particular, it is compatible with datasets and models of [pytorch_geometric](https://github.com/rusty1s/pytorch_geometric) and [DGL](https://docs.dgl.ai/en/latest/) for [Graph Neural Networks](https://arxiv.org/pdf/1812.08434.pdf).


  - Compatible with PyG and DGL for GNN
    - Graph level learning: It is compatible with [pytorch_geometric](https://github.com/rusty1s/pytorch_geometric) and [DGL](https://docs.dgl.ai/en/latest/) for Graph Neural Networks of graph classification and other graph level learning.
    - Node level learning: It can be used in node classification or other node level learning with dataset of single [pytorch_geometric Data](https://pytorch-geometric.readthedocs.io/en/latest/modules/data.html) or [DGLGraph](https://docs.dgl.ai/en/latest/api/python/graph.html).
  - Easy to Use
      - It likes [FastAI](https://docs.fast.ai) but far more lightweight.



  - `pip install bijou`



    - Pytorch
    - Matplotlib
    - Numpy
    - tqdm
    - Networkx
    - torch-geometric   (Optional)
    - dgl               (Optional)



  See following examples, and more examples are [here](https://github.com/hitlic/bijou/tree/master/examples).





  ```python
  import torch.nn as nn, torch.nn.functional as F, torch.optim as optim
  from bijou.learner import Learner
  from bijou.data import Dataset, DataLoader, DataBunch
  from bijou.metrics import accuracy
  from bijou.datasets import mnist
  import matplotlib.pyplot as plt


  x_train, y_train, x_valid, y_valid, x_test, y_test = mnist()
  train_ds, valid_ds, test_ds = Dataset(x_train, y_train), Dataset(x_valid, y_valid), Dataset(x_test, y_test)
  train_dl = DataLoader(train_ds, batch_size=128, shuffle=True)
  valid_dl = DataLoader(valid_ds, batch_size=128)
  test_dl = DataLoader(test_ds, batch_size=128)

  train_db = DataBunch(train_dl, valid_dl)


  in_dim = train_db.train_ds.x.shape[1]
  out_dim = y_train.max().item()+1
  model = nn.Sequential(nn.Linear(in_dim, 64), nn.ReLU(), nn.Linear(64, out_dim))
  opt = optim.SGD(model.parameters(), lr=0.35)


  loss_func = F.cross_entropy
  learner = Learner(model, opt, loss_func, train_db, metrics=[accuracy])


  learner.fit(10)


  learner.test(valid_dl)


  pred = learner.predict(x_valid)
  print(pred.size())


  learner.recorder.plot_metrics()
  plt.show()
  ```



  NOTE: Performance of this GNN model's is not good, as the dataset is highly unbalanced.

  ```python
  import torch, torch.nn as nn, torch.nn.functional as F, torch.optim as optim
  from torch_geometric.nn import global_max_pool, TopKPooling, GCNConv
  from bijou.learner import Learner
  from bijou.datasets import pyg_yoochoose_10k
  from bijou.data import DataBunch, PyGDataLoader
  from bijou.metrics import accuracy
  from examples.pyg_dataset import YooChooseBinaryDataset
  import matplotlib.pyplot as plt


  dataset = YooChooseBinaryDataset(root=pyg_yoochoose_10k()).shuffle()
  train_ds, val_ds, test_ds = dataset[:8000], dataset[8000:9000], dataset[9000:]
  train_dl = PyGDataLoader(train_ds, batch_size=64, shuffle=True)
  val_dl = PyGDataLoader(val_ds, batch_size=64)
  test_dl = PyGDataLoader(test_ds, batch_size=64)

  train_db = DataBunch(train_dl, val_dl)


  class Model(nn.Module):
      def __init__(self, feature_dim, class_num, embed_dim=64, gcn_dims=(32, 32), dense_dim=64):
          super().__init__()
          self.embedding = torch.nn.Embedding(num_embeddings=feature_dim, embedding_dim=embed_dim)
          self.gcns = nn.ModuleList()
          in_dim = embed_dim
          for dim in gcn_dims:
              self.gcns.append(GCNConv(in_dim, dim))
              in_dim = dim
          self.graph_pooling = TopKPooling(gcn_dims[-1], ratio=0.8)
          self.dense = nn.Linear(gcn_dims[-1], dense_dim)
          self.out = nn.Linear(dense_dim, class_num)

      def forward(self, data):
          x, edge_index, batch = data.x, data.edge_index, data.batch
          x = self.embedding(x)
          x = x.squeeze(1)
          for gcn in self.gcns:
              x = gcn(x, edge_index)
              x = F.relu(x)
          x, _, _, batch, _, _ = self.graph_pooling(x, edge_index, None, batch)
          x = global_max_pool(x, batch)
          outputs = self.dense(x)
          outputs = F.relu(outputs)
          outputs = self.out(outputs)
          return outputs

  model = Model(dataset.item_num, 2)
  opt = optim.SGD(model.parameters(), lr=0.5)


  learner = Learner(model, opt, F.cross_entropy, train_db, metrics=[accuracy])


  learner.fit(3)


  learner.test(test_dl)


  pred = learner.predict(test_dl)
  print(pred.size())


  learner.recorder.plot_metrics()
  plt.show()
  ```



  ```python
  from torch_geometric.datasets import Planetoid
  import torch.nn as nn, torch.nn.functional as F, torch.optim as optim
  from torch_geometric.nn import GCNConv
  from bijou.data import PyGGraphLoader, DataBunch
  from bijou.learner import Learner
  from bijou.metrics import masked_cross_entropy, masked_accuracy
  from bijou.datasets import pyg_cora
  import matplotlib.pyplot as plt


  dataset = Planetoid(root=pyg_cora(), name='Cora')
  train_dl = PyGGraphLoader(dataset, 'train')
  val_dl = PyGGraphLoader(dataset, 'val')
  test_dl = PyGGraphLoader(dataset, 'test')

  data = DataBunch(train_dl, val_dl)


  class Model(nn.Module):
      def __init__(self, feature_num, class_num):
          super().__init__()
          self.conv1 = GCNConv(feature_num, 16)
          self.conv2 = GCNConv(16, class_num)

      def forward(self, data):
          x, edge_index = data.x, data.edge_index
          x = self.conv1(x, edge_index)
          x = F.relu(x)
          x = self.conv2(x, edge_index)
          outputs = F.relu(x)
          return outputs

  model = Model(dataset.num_node_features, dataset.num_classes)
  opt = optim.SGD(model.parameters(), lr=0.5, weight_decay=0.01)


  learner = Learner(model, opt, masked_cross_entropy, data, metrics=[masked_accuracy])


  learner.fit(100)


  learner.test(test_dl)


  pred = learner.predict(dataset[0])
  print(pred.size())


  learner.recorder.plot_metrics()
  plt.show()
  ```


  ```python
  import torch, torch.nn as nn, torch.nn.functional as F, torch.optim as optim
  import dgl
  import dgl.function as fn
  from dgl.data import MiniGCDataset
  from bijou.data import DGLDataLoader, DataBunch
  from bijou.metrics import accuracy
  from bijou.learner import Learner
  import matplotlib.pyplot as plt


  train_ds = MiniGCDataset(320, 10, 20)
  val_ds = MiniGCDataset(100, 10, 20)
  test_ds = MiniGCDataset(80, 10, 20)

  train_dl = DGLDataLoader(train_ds, batch_size=32, shuffle=True)
  val_dl = DGLDataLoader(val_ds, batch_size=32, shuffle=False)
  test_dl = DGLDataLoader(test_ds, batch_size=32, shuffle=False)

  data = DataBunch(train_dl, val_dl)


  msg = fn.copy_src(src='h', out='m')  # Sends a message of node feature h.

  def reduce(nodes):
      """Take an average over all neighbor node features hu and use it to
      overwrite the original node feature."""
      accum = torch.mean(nodes.mailbox['m'], 1)
      return {'h': accum}

  class NodeApplyModule(nn.Module):
      """Update the node feature hv with ReLU(Whv+b)."""
      def __init__(self, in_feats, out_feats, activation):
          super().__init__()
          self.linear = nn.Linear(in_feats, out_feats)
          self.activation = activation

      def forward(self, node):
          h = self.linear(node.data['h'])
          h = self.activation(h)
          return {'h' : h}

  class GCN(nn.Module):
      def __init__(self, in_feats, out_feats, activation):
          super().__init__()
          self.apply_mod = NodeApplyModule(in_feats, out_feats, activation)

      def forward(self, g, feature):
          
          g.ndata['h'] = feature
          g.update_all(msg, reduce)
          g.apply_nodes(func=self.apply_mod)
          return g.ndata.pop('h')

  class Classifier(nn.Module):
      def __init__(self, in_dim, hidden_dim, n_classes):
          super(Classifier, self).__init__()

          self.layers = nn.ModuleList([
              GCN(in_dim, hidden_dim, F.relu),
              GCN(hidden_dim, hidden_dim, F.relu)])
          self.classify = nn.Linear(hidden_dim, n_classes)

      def forward(self, g):
          
          
          h = g.in_degrees().view(-1, 1).float()
          for conv in self.layers:
              h = conv(g, h)
          g.ndata['h'] = h
          hg = dgl.mean_nodes(g, 'h')
          return self.classify(hg)

  model = Classifier(1, 256, train_ds.num_classes)
  optimizer = optim.Adam(model.parameters(), lr=0.001)



  loss_func = nn.CrossEntropyLoss()
  learner = Learner(model, optimizer, loss_func, data, metrics=accuracy)


  learner.fit(80)


  learner.test(test_dl)


  learner.predict(test_dl)


  learner.recorder.plot_metrics()
  plt.show()
  ```


  ```python
  import torch.nn.functional as F, torch.nn as nn, torch as th
  import dgl.function as fn
  from dgl import DGLGraph
  from dgl.data import citation_graph as citegrh
  from bijou.learner import Learner
  from bijou.data import GraphLoader, DataBunch
  from bijou.metrics import masked_accuracy, masked_cross_entropy
  import matplotlib.pyplot as plt
  import networkx as nx



  def load_cora_data():
      data = citegrh.load_cora()
      features = th.FloatTensor(data.features)
      labels = th.LongTensor(data.labels)
      train_mask = th.BoolTensor(data.train_mask)
      val_mask = th.BoolTensor(data.val_mask)
      test_mask = th.BoolTensor(data.test_mask)
      g = data.graph
      
      g.remove_edges_from(nx.selfloop_edges(g))
      g = DGLGraph(g)
      g.add_edges(g.nodes(), g.nodes())
      return g, features, labels, train_mask, val_mask, test_mask

  g, features, labels, train_mask, val_mask, test_mask = load_cora_data()
  train_dl = GraphLoader(g, features=features, labels=labels, mask=train_mask)
  val_dl = GraphLoader(g, features=features, labels=labels, mask=val_mask)
  test_dl = GraphLoader(g, features=features, labels=labels, mask=test_mask)
  data = DataBunch(train_dl, val_dl)



  gcn_msg = fn.copy_src(src='h', out='m')
  gcn_reduce = fn.sum(msg='m', out='h')

  class NodeApplyModule(nn.Module):
      def __init__(self, in_feats, out_feats, activation):
          super(NodeApplyModule, self).__init__()
          self.linear = nn.Linear(in_feats, out_feats)
          self.activation = activation

      def forward(self, node):
          h = self.linear(node.data['h'])
          if self.activation is not None:
              h = self.activation(h)
          return {'h': h}

  class GCN(nn.Module):
      def __init__(self, in_feats, out_feats, activation):
          super(GCN, self).__init__()
          self.apply_mod = NodeApplyModule(in_feats, out_feats, activation)

      def forward(self, g, feature):
          g.ndata['h'] = feature
          g.update_all(gcn_msg, gcn_reduce)
          g.apply_nodes(func=self.apply_mod)
          return g.ndata.pop('h')

  class Net(nn.Module):
      def __init__(self):
          super(Net, self).__init__()
          self.gcn1 = GCN(1433, 16, F.relu)
          self.gcn2 = GCN(16, 7, None)

      def forward(self, g, features):
          x = self.gcn1(g, features)
          x = self.gcn2(g, x)
          return x

  net = Net()
  optimizer = th.optim.Adam(net.parameters(), lr=1e-3)



  learner = Learner(net, optimizer, masked_cross_entropy, data, metrics=masked_accuracy)


  learner.fit(50)


  learner.test(test_dl)


  learner.predict(test_dl)


  learner.recorder.plot_metrics()
  plt.show()
  ```


pkgId: b75d581b52687a1e3d2e2c5c3b81a8c3e9a96e9ddf0aee78576899a9e33b0806
name: python-bikeability
arch: src
version: 1.0.0
epoch: 0
release: 1
summary: A Package to derive bike-friendliness from OpenStreetMap data
url: https://github.com/DLR-VF/bikeability
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bikeability-1.0.0-1.src.rpm
checksum_type: sha256
description:
  [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/DLR-VF/bikeability/blob/master/LICENSE.md)
  [![PyPI version](https://badge.fury.io/py/bikeability.svg)](https://pypi.python.org/pypi/bikeability)
  ![test](https://github.com/DLR-VF/bikeability/actions/workflows/test-bikeability.yml/badge.svg)
  [![Documentation Status](https://readthedocs.org/projects/bikeability/badge/?version=latest)](https://bikeability.readthedocs.io/en/latest/?badge=latest)
  [![DOI](https://img.shields.io/badge/doi-10.5281%2Fzenodo.13318512-blue)](https://doi.org/10.5281/zenodo.13318512)




  "Bikeability" is a Python package to automatically compute bike-friendliness of specific areas.
  With this library, users can download [OpenStreetMap](https://www.openstreetmap.org) (OSM)
   data and generate spatial indicators for bikeability (bike facilities on main streets, green share, share of secondary
  and tertiary roads, node density and bike shop density). Based on these indicators, it is possible to calculate a bikeability index
  ([Hardinghaus et al. 2021](https://elib.dlr.de/144713/)) using a weighting approach derived from an expert survey.




  Please see the [user guide](https://bikeability.readthedocs.io/en/latest/)
  for information about installation and usage.



  To get started with bikeability, read the user reference and see the sample code and input data in the [examples repository](https://github.com/DLR-VF/bikeability-examples).



  Bikeability is built on top of osmnx, geopandas, networkx.

  * Download and prepare road networks and additional data from OpenStreetMap
  * Calculate indicators to derive bike-friendliness of certain regions
  * Weight the indicators and generate a bikeability index



  * [Simon Nieland](https://github.com/SimonNieland)



  * Michael Hardinghaus
  * Marius Lehne
  * María López Díaz



  If you use bikeability in your work, please cite the journal article:

  Hardinghaus, Michael, et al. "[More than bike lanes—a multifactorial index of urban bikeability.](https://elib.dlr.de/144713/)" Sustainability 13.21 (2021): 11584.



  If you have a usage question, please contact us via email ([simon.nieland@dlr.de](mailto:simon.nieland@dlr.de)).



  Bikeability is licensed under the [MIT License](https://github.com/DLR-VF/bikeability/blob/master/LICENSE). See the [LICENSE](https://github.com/DLR-VF/bikeability/blob/master/LICENSE) file for more information.



  * We have chosen some links to external pages as we think they contain useful information.
    However, we are not responsible for the contents of the pages we link to.

  * The software is provided "AS IS".

  * We tested the software, and it worked as expected. Nonetheless, we cannot guarantee it will work as you expect


pkgId: 7b9dc48b62bcaf38481a498fbcb4659f861a85f1d03bbd480feba7b7bc01e009
name: python-bikeshed
arch: src
version: 4.2.0
epoch: 0
release: 1
summary: A document-authoring tool mainly intended for web specifications.
url: https://github.com/speced/bikeshed/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bikeshed-4.2.0-1.src.rpm
checksum_type: sha256
description:
  <img src="https://raw.githubusercontent.com/speced/bikeshed/main/bikeshed.svg" width=100 height=100 align=left>
  Bikeshed is a pre-processor for spec documents,
  turning a source document
  (containing only the actual spec content, plus several shorthands for linking to terms and other things)
  into a final spec document,
  with appropriate boilerplate, bibliography, indexes, etc all filled in.
  It's used on specs for CSS and many other W3C working groups,
  WHATWG,
  the C++ standards committee,
  and elsewhere!
  ![CI](https://github.com/speced/bikeshed/workflows/CI/badge.svg)
  [![Gitter](https://img.shields.io/badge/Gitter-Join%20Chat%20↣-blue.svg)](https://gitter.im/tabatkins/bikeshed?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
  [![Docs](https://img.shields.io/badge/docs-available-orange.svg)](https://speced.github.io/bikeshed)
  [![Release Notes](https://img.shields.io/badge/release-notes-purple.svg)](https://github.com/speced/bikeshed/issues/1773)
  The processor can be easily [installed](https://speced.github.io/bikeshed/#installing) and run locally (requiring no
  network access unless you're updating), or accessed as a CGI without any installation at all: <https://api.csswg.org/bikeshed/>
  A short overview of some of Bikeshed's features:
  * [automatic linking](https://speced.github.io/bikeshed/#autolinking) of terms to their definitions based on text, so you can simple write `Use <a>some term</a> to...` and have it automatically link to the `<dfn>some term</dfn>` elsewhere in the document, or in another spec entirely!
  * [automatic id generation](https://speced.github.io/bikeshed/#id-gen) for headings and definitions, based on their text.
  * [textual shortcuts for autolinks](https://speced.github.io/bikeshed/#autolink-shortcuts): [[FOO]] for bibliography entries, &lt;&lt;foo>> for grammar productions, 'foo' for CSS property names, {{foo}} for IDL terms, and more.
  * [boilerplate generation](https://speced.github.io/bikeshed/#boilerplate), both wholesale and piecemeal.
  * [Bikeshed-flavored Markdown](https://speced.github.io/bikeshed/#markdown), a slight variant that is extra-friendly to intermixing with normal HTML. (Besides the few intentional divergences, compliance with [CommonMark](https://commonmark.org) is expected.)
  * a [compact syntax](https://speced.github.io/bikeshed/#table-expansion) for writing property-definition tables.
  * [automatic whitespace-prefix stripping](https://speced.github.io/bikeshed/#pre-whitespace-stripping) from `<pre>` contents, so the contents can be indented properly in your HTML.
  * [automatic IDL processing and syntax-checking](https://speced.github.io/bikeshed/#idl) for `<pre class=idl>` contents, so you don't have to mark up every single significant term yourself.
  * [automatic generation of railroad diagrams](https://speced.github.io/bikeshed/#railroad) from `<pre class='railroad'>` contents.


pkgId: 8fec3e56678f3cc1e626d976ed3fd6879aaec154738feeba4392f21fa041f642
name: python-bilby-numpyro
arch: src
version: 0.0.1
epoch: 0
release: 1
summary: please add a summary manually as the author left a blank one
url: https://pypi.org/project/bilby-numpyro/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bilby-numpyro-0.0.1-1.src.rpm
checksum_type: sha256
description:
  Sampler plugin for using `numpyro` samplers with `Bilby`

  `bilby-numpyro` is a sampler plugin for using `numpyro` samplers with `Bilby` likelihoods and priors.
  Any likelihood that uses only `JAX` JIT-compilable functions/classes works automatically.



  The sampler should always be given as `numpyro` regardless of which sampler (e.g., `HMC`, `NUTS`) is actually being used.
  The sampler is specified with `sampler_name` and any sampler keyword arguments should be passed in the usual way to
  `bilby.core.sampler.run_sampler` for example

  ```python
  run_sampler(
      ...,
      sampler="numpyro",
      sampler_name="NUTS",
      num_warmup=500,
      num_samples=1000,
  )
  ```

  This has not been tested with `numpyro` parallelisation.



  The likelihood class you use should be JIT compilable with `JAX`.
  Generally, this will be the case if you use `jax.numpy` and `jax.scipy` instead of `numpy`/`scipy`.

  Some `Bilby` priors have direct equivalents in `numpyro` and so we use those automatically.
  You will see logged warnings if a prior is not available and a `Uniform` prior over the same range will be used instead.


pkgId: 54decac642767e068e7e1f70a8240a09f52a66764733cff85823571223813816
name: python-bilby-pipe
arch: src
version: 1.4.2
epoch: 0
release: 1
summary: Automating the running of bilby for gravitational wave signals
url: https://git.ligo.org/lscsoft/bilby_pipe
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bilby-pipe-1.4.2-1.src.rpm
checksum_type: sha256
description:
  A package for automating transient gravitational wave parameter estimation
  -  `Installation
     instructions <https://lscsoft.docs.ligo.org/bilby_pipe/master/installation.html>`__
  -  `Documentation <https://lscsoft.docs.ligo.org/bilby_pipe/master/index.html>`__
  -  `Issue tracker <https://git.ligo.org/lscsoft/bilby/issues>`__
  -  See the `bilby page <https://git.ligo.org/lscsoft/bilby>`__ for help channels.


pkgId: ece1a74fdebf97a815be605c6e0a85e3cb56b35c88bda1705ce351d358a65a0c
name: python-biliarchiver
arch: src
version: 0.1.16
epoch: 0
release: 1
summary: Archiving tool for Bilibili based on bilix
url: https://pypi.org/project/biliarchiver/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-biliarchiver-0.1.16-1.src.rpm
checksum_type: sha256
description:
  > Archiving tool for Bilibili based on bilix

  [![PyPI version](https://badge.fury.io/py/biliarchiver.svg)](https://badge.fury.io/py/biliarchiver)



  ```bash
  pip install biliarchiver
  ```



  ```bash
  biliarchiver --help
  ```



  Follow these steps to start archiving:

  1. Initialize a new workspace in current working directory:

  ```bash
  biliarchiver init
  ```

  2. Provide cookies and tokens following instructions:

  ```bash
  biliarchiver auth
  ```

  3. Download videos from BiliBili:

  ```bash
  biliarchiver down --bvids BVXXXXXXXXX
  ```

  - This command also accepts a list of BVIDs or path to a file. Details can be found in `biliarchiver down --help`.

  4. Upload videos to Internet Archive:

  ```bash
  biliarchiver up --bvids BVXXXXXXXXX
  ```

  - This command also accepts a list of BVIDs or path to a file. Details can be found in `biliarchiver up --help`.



  1. Start server

  ```bash
  biliarchiver api
  ```

  2. Add videos

  ```bash
  curl -X PUT -H "Content-Type: application/json" http://127.0.0.1:8000/archive/BVXXXXXX
  ```





  Please use poetry to install dependencies:

  ```sh
  poetry install
  ```

  Build English locale if necessary. Refer to the last section for details.



  ```sh
  poetry run biliarchiver --help
  ```

  Debug using another workspace:

  ```sh
  poetry --directory /path/to/workspace run biliarchiver --help
  ```



  ```sh
  poetry run ruff check .
  ```



  To generate and build locales, you need a GNU gettext compatible toolchain. You can install `mingw` and use `sh` to enter a bash shell on Windows.

  Generate or update `biliarchiver.pot`:

  ```sh
  find biliarchiver/ -name '*.py' | xargs xgettext -d base -o biliarchiver/locales/biliarchiver.pot
  ```

  Add a new language:

  ```sh
  msginit -i biliarchiver/locales/biliarchiver.pot -o en.po -l en
  ```

  Update a language:

  ```sh
  pnpx gpt-po sync --po biliarchiver/locales/en/LC_MESSAGES/biliarchiver.po --pot biliarchiver/locales/biliarchiver.pot
  ```

  **(Important)** Build a language:

  ```sh
  msgfmt biliarchiver/locales/en/LC_MESSAGES/biliarchiver.po -o biliarchiver/locales/en/LC_MESSAGES/biliarchiver.mo
  ```


pkgId: 22297e8b39df766bb30b9336b81de670b55525c4b3acf695cdd10116919630ad
name: python-bilibili-api
arch: src
version: 9.1.0
epoch: 0
release: 1
summary: 哔哩哔哩的各种 API 调用便捷整合（视频、动态、直播等），另外附加一些常用的功能。
url: https://github.com/MoyuScript/bilibili-api
rpm_license: GPLv3+
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bilibili-api-9.1.0-1.src.rpm
checksum_type: sha256
description:
  ![LOGO](https://raw.githubusercontent.com/MoyuScript/bilibili-api/HEAD/design/logo.png)



  [![API 数量](https://img.shields.io/badge/API%20数量-100+-blue)][api.json]
  [![STARS](https://img.shields.io/github/stars/MoyuScript/bilibili-api?color=yellow&label=Github%20Stars)][stargazers]
  [![LICENSE](https://img.shields.io/badge/LICENSE-GPLv3-red)][license]
  ![Python](https://img.shields.io/badge/Python-3.9|3.8-blue)
  [![Testing](https://github.com/MoyuScript/bilibili-api/actions/workflows/testing.yml/badge.svg)](https://github.com/MoyuScript/bilibili-api/actions/workflows/testing.yml)

  开发文档: [bilibili_api 开发文档][docs] ([GitHub][docs-github])



  这是一个用 Python 写的调用 [Bilibili](https://www.bilibili.com) 各种 API 的库，
  范围涵盖视频、音频、直播、动态、专栏、用户、番剧等[[1]](#脚注)。



  - 范围涵盖广，基本覆盖常用的爬虫，操作。
  - 可使用代理，绕过 b 站风控策略。
  - 全面支持 BV 号（bvid），同时也兼容 AV 号（aid）。
  - 调用简便，函数命名易懂，代码注释详细。
  - 不仅仅是官方提供的 API！还附加：AV 号与 BV 号互转[[2]](#脚注)、连接直播弹幕 Websocket 服务器、视频弹幕反查[[3]](#脚注)、专栏内容爬取等。
  - **全部是异步操作**。



  首先使用以下指令安装本模块：

  ```
  $ pip install bilibili-api
  ```

  接下来我们来获取视频的播放量等信息：

  ```python
  import asyncio
  from bilibili_api import video

  async def main():
      
      v = video.Video(bvid="BV1uv411q7Mv")
      
      info = await v.get_info()
      
      print(info)

  if __name__ == '__main__':
      asyncio.get_event_loop().run_until_complete(main())
  ```

  输出（已格式化，已省略部分）：

  ```json
  {
      "bvid": "BV1uv411q7Mv",
      "aid": 243922477,
      "videos": 1,
      "tid": 17,
      "tname": "单机游戏",
      "copyright": 1,
      "pic": "http://i2.hdslb.com/bfs/archive/82e52df9d0221836c260c82f2890e3761a46716b.jpg",
      "title": "爆肝９８小时！在 MC 中还原糖调小镇",
      "pubdate": 1595203214,
      "ctime": 1595168654,
      ...and more
  }
  ```

  如何给这个视频点赞？我们需要登录自己的账号。

  这里设计是传入一个 Credential 类，获取所需的信息参照：[获取 Credential 类所需信息][get-credential]

  下面的代码将会给视频点赞

  ```python
  import asyncio
  from bilibili_api import video, Credential

  async def main():
      
      credential = Credential(sessdata=SESSDATA, bili_jct=BILI_JCT, buvid3=BUVID3)
      
      v = video.Video(bvid="BVxxxxxxxx", credential=credential)
      info = await v.get_info()
      print(info)
      
      await v.like(True)

  if __name__ == '__main__':
      asyncio.get_event_loop().run_until_complete(main())
  ```

  如果没有报错，就代表调用 API 成功，你可以到视频页面确认是不是调用成功了。

  !> 注意，请不要泄露这两个值给他人，否则你的账号将可能遭受盗号的风险！



  由于从 v5 版本开始，全部改为异步，如果你不会异步，可以参考 [asyncio](https://docs.python.org/zh-cn/3/library/asyncio.html)

  异步可以进行并发请求，性能更高，不过如果请求过快仍然会导致被屏蔽。

  总的来说，异步比同步更有优势，所以不会的话可以去学一下，会发现新天地（误

  如果你仍然想继续使用同步代码，请参考 [同步执行异步代码](https://www.moyu.moe/bilibili-api/#/sync-executor)



  **Q: 关于 API 调用的正确姿势是什么？**

  A: 所有 API 调用，请尽量使用 **指名方式** 传参，
  因为 API 较多，可能不同函数的传参顺序不一样，例子：

  ```python

  video.get_info(bvid="BV1uv411q7Mv")


  kwargs = {
      "bvid": "BV1uv411q7Mv"
  }
  video.get_info(**kwargs)


  video.get_info("BV1uv411q7Mv")
  ```

  **Q: 为什么会提示 412 Precondition Failed ？**

  A: 你的请求速度太快了。造成请求速度过快的原因可能是你写了高并发的代码。

  这种情况下，你的 IP 会暂时被封禁而无法使用，你可以设置代理绕过。

  ```python
  from bilibili_api import settings

  settings.proxy = "http://your-proxy.com" # 里头填写你的代理地址
  ```

  **Q: 怎么没有我想要的功能？**

  A: 你可以发 Issue 来提交你的需求，但是，最好的办法是自己写（懒）

  **Q: 我有一个大胆的想法，如何给代码库贡献？**

  A: 请先 clone 本仓库一份，然后从 main 分支新建一个分支，在该分支上工作。
  如果你觉得已经可以了，请向项目仓库的 develop 分支发起 Pull request。
  如果你不明白这些操作的话，可以百度。

  **Q: 稳定性怎么样？**

  A: 由于该模块比较特殊，是爬虫模块，如果 b 站的接口变更，可能会马上失效。因此请始终保证是最新版本。如果发现问题可以提 [Issues][issues-new]。



  + \[1\] 这里只列出一部分，请以实际 API 为准。
  + \[2\] 代码来源：<https://www.zhihu.com/question/381784377/answer/1099438784>
  + \[3\] 代码翻译自：<https://github.com/esterTion/BiliBili_crc2mid>


  [docs]: https://www.moyu.moe/bilibili-api/
  [docs-github]: https://github.com/MoyuScript/bilibili-api-docs
  [api.json]: https://github.com/MoyuScript/bilibili-api/tree/main/bilibili-api/data/api/
  [license]: https://github.com/MoyuScript/bilibili-api/tree/main/LICENSE.md
  [stargazers]: https://github.com/MoyuScript/bilibili-api/stargazers
  [issues-new]: https://github.com/MoyuScript/bilibili-api/issues/new
  [get-credential]: https://www.moyu.moe/bilibili-api/#/get-credential


pkgId: ecb7f168d550d5ae832cc5c8531bdabcea84ab8a72d74297c6fc4d0cd9fefa5b
name: python-bilibili-api-python
arch: src
version: 16.3.0
epoch: 0
release: 1
summary: The fork of module bilibili-api. 哔哩哔哩的各种 API 调用便捷整合（视频、动态、直播等），另外附加一些常用的功能。
url: https://pypi.org/project/bilibili-api-python/
rpm_license: GPL-3.0-or-later
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bilibili-api-python-16.3.0-1.src.rpm
checksum_type: sha256
description:
  ![bilibili-api logo](https://raw.githubusercontent.com/Nemo2011/bilibili-api/main/design/logo.png)

  <div align="center">



  [![API 数量](https://img.shields.io/badge/API%20数量-400+-blue)][api.json]
  [![LICENSE](https://img.shields.io/badge/LICENSE-GPLv3+-red)][LICENSE]
  [![Python](https://img.shields.io/badge/python-3.12(dev)|3.11|3.10|3.9|3.8-blue)](https://www.python.org)
  [![Stable Version](https://img.shields.io/pypi/v/bilibili-api-python?label=stable)][pypi]
  [![Pre-release Version](https://img.shields.io/github/v/release/Nemo2011/bilibili-api?label=pre-release&include_prereleases&sort=semver)][pypi-dev]
  [![STARS](https://img.shields.io/github/stars/nemo2011/bilibili-api?color=yellow&label=Github%20Stars)][stargazers]
  [![Testing](https://github.com/Nemo2011/bilibili-api/actions/workflows/testing.yml/badge.svg?branch=dev)](https://github.com/Nemo2011/bilibili-api/actions/workflows/testing.yml)

  **:warning: 接口可能改动，请及时更新最新版 [![Stable Version](https://img.shields.io/pypi/v/bilibili-api-python?label=stable)][pypi]**
  </div>

  **注意事项：使用此模块时请仅用于学习和测试，禁止用于非法用途及其他恶劣的社区行为如：恶意刷屏、辱骂黄暴、各种形式的滥用等，违规此模块许可证 `GNU General Public License Version 3` 及此条注意事项而产生的任何后果自负，模块的所有贡献者不负任何责任。**

  开发文档: [bilibili_api 开发文档][docs] ([GitHub][docs-github]) <!-- ([Gitee][docs-gitee]) -->

  原仓库地址：[https://github.com/MoyuScript/bilibili-api](https://github.com/MoyuScript/bilibili-api)

  Github 仓库：[https://github.com/nemo2011/bilibili-api](https://github.com/nemo2011/bilibili-api)

  <!-- Gitee 仓库：[https://gitee.com/nemo2011/bilibili-api](https://gitee.com/nemo2011/bilibili-api) 长期未同步... -->

  > 此仓库是对原仓库 `bilibili-api` 的继续的维护。更多相关的信息请前往原仓库地址进行查看。



  这是一个用 Python 写的调用 [Bilibili](https://www.bilibili.com) 各种 API 的库，
  范围涵盖视频、音频、直播、动态、专栏、用户、番剧等[[1]](#脚注)。



  - 范围涵盖广，基本覆盖常用的爬虫，操作。
  - 可使用代理，绕过 b 站风控策略。
  - 全面支持 BV 号（bvid），同时也兼容 AV 号（aid）。
  - 调用简便，函数命名易懂，代码注释详细。
  - 不仅仅是官方提供的 API！还附加：AV 号与 BV 号互转[[2]](#脚注)、连接直播弹幕 Websocket 服务器、视频弹幕反查、下载弹幕、字幕文件、专栏内容爬取等。
  - **全部是异步操作**。



  首先使用以下指令安装本模块：

  ```

  $ pip3 install bilibili-api-python


  $ pip3 install bilibili-api-dev


  $ pip3 install git+https://github.com/Nemo2011/bilibili-api.git@dev
  ```


  接下来我们来获取视频的播放量等信息：

  ```python
  import asyncio
  from bilibili_api import video


  async def main() -> None:
      
      v = video.Video(bvid="BV1uv411q7Mv")
      
      info = await v.get_info()
      
      print(info)


  if __name__ == "__main__":
      asyncio.get_event_loop().run_until_complete(main())

  ```

  输出（已格式化，已省略部分）：

  ```json
  {
      "bvid": "BV1uv411q7Mv",
      "aid": 243922477,
      "videos": 1,
      "tid": 17,
      "tname": "单机游戏",
      "copyright": 1,
      "pic": "http://i2.hdslb.com/bfs/archive/82e52df9d0221836c260c82f2890e3761a46716b.jpg",
      "title": "爆肝９８小时！在 MC 中还原糖调小镇",
      "pubdate": 1595203214,
      "ctime": 1595168654,
      ...and more
  }
  ```

  如何给这个视频点赞？我们需要登录自己的账号。

  这里设计是传入一个 Credential 类，获取所需的信息参照：[获取 Credential 类所需信息][get-credential]

  下面的代码将会给视频点赞

  ```python
  import asyncio
  from bilibili_api import video, Credential

  async def main() -> None:
      
      credential = Credential(sessdata=SESSDATA, bili_jct=BILI_JCT, buvid3=BUVID3)
      
      v = video.Video(bvid="BVxxxxxxxx", credential=credential)
      info = await v.get_info()
      print(info)
      
      await v.like(True)

  if __name__ == '__main__':
      asyncio.get_event_loop().run_until_complete(main())
  ```

  如果没有报错，就代表调用 API 成功，你可以到视频页面确认是不是调用成功了。

  > **Warning** 注意，请不要泄露这两个值给他人，否则你的账号将可能遭受盗号的风险！



  由于从 v5 版本开始，基本全部改为异步，如果你不会异步，可以参考 [asyncio](https://docs.python.org/zh-cn/3/library/asyncio.html)

  异步可以进行并发请求，性能更高，不过如果请求过快仍然会导致被屏蔽。

  总的来说，异步比同步更有优势，所以不会的话可以去学一下，会发现新天地（误

  如果你仍然想继续使用同步代码，请参考 [同步执行异步代码](https://nemo2011.github.io/bilibili-api/#/sync-executor)

  以下为 `API` 关于异步请求库使用的详细信息：

  | Feature | 同步 | 异步 | aiohttp | httpx | 备注 |
  | ------ | ---- | ----- | ------ | ------ | ---- |
  | `LiveDanmaku` & `VideoOnlineMonitor` | :x: | :white_check_mark: | :white_check_mark: | :x: | httpx 暂不支持 `WebSocket` |
  | `login` | :white_check_mark: | :x: | :x: | :white_check_mark: | 目前暂时仅支持同步请求 |
  | other | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: | |



  **Q: 关于 API 调用的正确姿势是什么？**

  A: 所有 API 调用，请尽量使用 **指名方式** 传参，
  因为 API 较多，可能不同函数的传参顺序不一样，例子：

  ```python

  video.get_info(bvid="BV1uv411q7Mv")


  kwargs = {
      "bvid": "BV1uv411q7Mv"
  }
  video.get_info(**kwargs)


  video.get_info("BV1uv411q7Mv")
  ```

  **Q: 为什么会提示 412 Precondition Failed ？**

  A: 你的请求速度太快了。造成请求速度过快的原因可能是你写了高并发的代码。

  这种情况下，你的 IP 会暂时被封禁而无法使用，你可以设置代理绕过。

  ```python
  from bilibili_api import settings

  settings.proxy = "http://your-proxy.com" # 里头填写你的代理地址

  settings.proxy = "http://username:password@your-proxy.com" # 如果需要用户名、密码
  ```

  **Q: 怎么没有我想要的功能？**

  A: 你可以发 Issue 来提交你的需求，但是，最好的办法是自己写（懒）

  <span id="contribute">**Q: 我有一个大胆的想法，如何给代码库贡献？**</span>

  A: 请先 clone 本仓库一份，然后从 main 分支新建一个分支，在该分支上工作。
  如果你觉得已经可以了，请向项目仓库的 develop 分支发起 Pull request。
  如果你不明白这些操作的话，可以百度。完整指南：[CONTRIBUTING.md](https://github.com/nemo2011/bilibili-api/blob/main/.github/CONTRIBUTING.md)

  **Q: 稳定性怎么样？**

  A: 由于该模块比较特殊，是爬虫模块，如果 b 站的接口变更，可能会马上失效。因此请始终保证是最新版本。如果发现问题可以提 [Issues][issues-new]。



  + \[1\] 这里只列出一部分，请以实际 API 为准。
  + \[2\] 代码来源：<https://www.zhihu.com/question/381784377/answer/1099438784>


  [docs]: https://nemo2011.github.io/bilibili-api
  [docs-github]: https://github.com/nemo2011/bilibili-api/tree/main/docs
  [docs-gitee]: https://gitee.com/nemo2011/bilibili-api/tree/main/docs
  [api.json]: https://github.com/nemo2011/bilibili-api/tree/main/bilibili_api/data/api/
  [license]: https://github.com/nemo2011/bilibili-api/tree/main/LICENSE
  [stargazers]: https://github.com/nemo2011/bilibili-api/stargazers
  [issues-new]: https://github.com/Nemo2011/bilibili-api/issues/new/choose
  [get-credential]: https://nemo2011.github.io/bilibili-api/#/get-credential
  [pypi]: https://pypi.org/project/bilibili-api-python
  [pypi-dev]: https://pypi.org/project/bilibili-api-dev



  [![Star History Chart](https://api.star-history.com/svg?repos=Nemo2011/bilibili-api&type=Date)](https://star-history.com/#Nemo2011/bilibili-api&Date)


pkgId: 16cdf97918a2559edfdb945b1b3e28db94f66cb86cedf288eb633b91946bcc50
name: python-bilibili-toolman
arch: src
version: 1.0.7.9
epoch: 0
release: 1
summary: bilibili-toolman 哔哩哔哩搬运工具
url: https://github.com/greats3an/bilibili-toolman
rpm_license: Apache Software License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bilibili-toolman-1.0.7.9-1.src.rpm
checksum_type: sha256
description:
      pip install bilibili_toolman





  凭据需要在本地准备
  - [pip 安装 bilibili_toolman](#安装)
      - **Windows 用户**: 在 [Releases](https://github.com/mos9527/bilibili-toolman/releases) 可下载已打包 `.exe` 版本
  - 使用 Web 端 API

          python -m bilibili_toolman --save --cookies "SESSDATA=8aafe8**********;bili_jct=4f39b**********"
      `SESSDATA`,`bili_jct` 可在XHR请求头中或`document.cookies`获得，这里不将阐述
  - 使用 上传助手 API

          python -m bilibili_toolman --save --sms
      跟随输出操作即可（注：需要完成 Geetest 校验）
  - 凭据即输出的 Base64 编码内容


  - Fork 此项目
  - 在项目 Settings > Secret > New repository secret 创建：
      - Name  : `SESSION`
      - Value : `此处为准备好的凭据`
  - *可选* 替换不同凭据上传、投稿

      **指定上传凭据**

      - Name  : `SESSION_UPLOAD`
      - Value : `此处为准备好的凭据`

      **指定投稿凭据**

      - Name  : `SESSION_SUBMIT`
      - Value : `此处为准备好的凭据`

      一般推荐使用 Web 凭据上传，上传助手凭据投稿（高速 (?) (~400Mbps) 上传，多P投稿）


  该 Actions 适用于手动转载的用户

  - 在项目 Actions > 手动转载 > Run Workflow 填入值（[详见参数说明](#参数说明)）
  - 运行即可


  该 Actions 适用于需要自动转载Youtube频道的用户

  - 依照 [reupload-channel-timed.yml](https://github.com/greats3an/bilibili-toolman/blob/master/.github/workflows/reupload-channel-timed.yml) 及其注释配置即可


  ```python
  >>> from bilibili_toolman.bilisession.web import BiliSession





  >>> session = BiliSession.from_base64_string("H4sIADKW+2EC/5VVWW/bRhB2EF216...")

  >>> endpoint_1,cid_1 = session.UploadVideo("本地视频01.mp4")
  ('n220208141kq78....', ...)
  >>> endpoint_2,cid_2 = session.UploadVideo("本地视频02.mp4")
  ('n220209892re88....', ...)





  >>> from bilibili_toolman.bilisession.common.submission import Submission

  >>> submission = Submission(
      title="【toolman】 转载测试",
      desc="...as per request"
  )

  >>> submission.videos.append(
      Submission(
          title="多 P （P1)",
          video_endpoint=endpoint_1
      )
  )
  >>> submission.videos.append(
      Submission(
          title="多 P （P2)",
          video_endpoint=endpoint_2
      )
  )

  >>> cover = session.UploadCover('封面测试.png')
  >>> submission.cover_url = cover['data']['url']

  >>> submission.source = 'https://github.com/mos9527/bilibili-toolman'

  >>> submission.tags.append('转载')

  >>> submission.thread = 17

  >>> session.SubmitSubmission(submission,seperate_parts=False)


  >>> session.SubmitSubmission(submission,seperate_parts=True)

  {'code:': 0,
      'results': [{'code': 0, 'message': '0','ttl': 1,
      'data': {'aid': 5939...., 'bvid': 'BV1oq....'}}]}
  ```


  - [examples](https://github.com/greats3an/bilibili-toolman/tree/master/examples)
  - - [编辑稿件信息](https://github.com/greats3an/bilibili-toolman/blob/master/examples/submission-editor.py)
  - - [投稿VTT字幕](https://github.com/greats3an/bilibili-toolman/blob/master/examples/subtitle-helper.py)
  - - [解码 `--save` 凭据](https://github.com/greats3an/bilibili-toolman/blob/master/examples/token-info.py)
  - [main.py](https://github.com/greats3an/bilibili-toolman/blob/master/bilibili_toolman/cli/main.py)

  - [client.py](https://github.com/greats3an/bilibili-toolman/blob/master/bilibili_toolman/bilisession/client.py)
  - [web.py](https://github.com/greats3an/bilibili-toolman/blob/master/bilibili_toolman/bilisession/web.py)

  [![asciicast](https://asciinema.org/a/lesWLYGFZJxyeGrS6TDBkvRJV.svg)](https://asciinema.org/a/lesWLYGFZJxyeGrS6TDBkvRJV)


  [PC 上传助手逆向 · FortuneDayssss/BilibiliUploader](https://github.com/FortuneDayssss/BilibiliUploader)

  [分区数据，API 参考 · Passkou/bilibili_api](https://github.com/Passkou/bilibili_api "Passkou · bilibili_api")

  [Youtube 解析 · yt-dlp/yt-dlp](https://github.com/yt-dlp/yt-dlp "yt-dlp · yt-dlp")

      usage: bilibili-toolman [-h] [--cookies COOKIES] [--sms] [--load LOAD]
                              [--load_upload LOAD_UPLOAD]
                              [--load_submit LOAD_SUBMIT] [--save] [--http]
                              [--noenv] [--cdn {ws,qn,bda2,kodo,gcs,bos}]
                              [--opts OPTS] [--thread_id THREAD_ID] [--tags TAGS]
                              [--desc DESC] [--title TITLE] [--seperate_parts]
                              [--no_upload] [--no_submit] [--original]
                              [--no_reprint] [--localfile LOCALFILE-URL]
                              [--youtube YOUTUBE-URL]

      使用帮助

      optional arguments:
      -h, --help            show this help message and exit

      身份设置 （随方式优先级排序）:
      --cookies COOKIES     登陆： 使用 Cookies 登陆，即使用 Web API （不可多 P 上传） ( 需要 SESSDATA 及 bili_jct ) e.g.SESSDATA=cb0..; bili_jct=6750...
      --sms                 登陆：使用短信验证码登陆，即使用 上传助手 API （可多 P 上传）（需手动交互）（有日获取限制，请配合 --save 使用）
      --load LOAD           登陆：加载凭据，同时用于上传及投稿
      --load_upload LOAD_UPLOAD
                              登陆：使用该凭据上传，而不用--load凭据上传
      --load_submit LOAD_SUBMIT
                              登陆：使用该凭据投稿，而不用--load凭据投稿
      --save                登陆：向stdout输出当前登陆凭据并退出（其他输出转移至stderr）
      --http                强制使用 HTTP （不推荐）
      --noenv               上传时，不采用环境变量（如代理）
      --cdn {ws,qn,bda2,kodo,gcs,bos}
                              上传用 CDN （限 Web API) （对应 网宿（适合海外），七牛，百度（默认），七牛，谷歌，百度）
      --retry_submit_delay RETRY_SUBMIT_DELAY
                              投稿限流时，重新投稿周期
      --retry_submit_count RETRY_SUBMIT_COUNT
                              投稿限流时，尝试重新投稿次数

      上传设置:
      --opts OPTS           解析可选参数 ，详见 --opts 格式
      --thread_id THREAD_ID
                              分区 ID
      --tags TAGS           标签
      --desc DESC           描述格式 e.g. "原描述：{desc}" (其他变量详见下文)（仅稿件有描述）
      --title TITLE         标题格式 e.g. "[Youtube] {title} (其他变量详见下文)（使用于稿件及分P）"
      --seperate_parts      不分P （e.g. --youtube [播放列表],--localfile [文件夹]）独立投稿（不分P）（Web上传默认不分 P）
      --no_upload           只下载资源
      --no_submit           不提交稿件，适用于获取filename参数
      --original            设置稿件为原创
      --no_reprint          设置稿件不允许转载

      解析可选参数 "opts" （格式 ： [参数1]=[值1];[参数2]=[值2] (query-string)）:
      --localfile LOCALFILE-URL
                              本地文件
                              参数:
                                  cover (str) - 封面图片路径
                              e.g. --localfile "le videos/" --opts cover="le cover.png" --tags ...
      --youtube YOUTUBE-URL
                              Youtube / Twitch / etc 视频下载 (yt-dlp)
                              参数:yt-dlp 参数：
                                  format (str) - 同 yt-dlp -f
                                  quite (True,False) - 是否屏蔽 yt-dlp 日志 (默认 False)
                              特殊参数：
                                  playlistend - 对于播放列表、频道，下载到（时间顺序，新者在前）第 n 个视频为止
                                  playliststart - 对于播放列表、频道，从（时间顺序，新者在前）第 n 个视频开始下载

                                  daterange - 只下载在该参数指定时间窗口内的视频 (精确到毫秒)
                                      格式可以为 YYmmdd,也可以用相对时间. 如：

                                      e.g. daterange=now; (下载今天上传的视频)
                                      e.g. daterange=now-1day; (下载昨天到今天上传的视频)
                                      e.g. daterange=220430~220501 (下载 2022年4月30日~2022年5月1日 的视频)

                                  hardcode - 烧入硬字幕选项
                                      e.g. 启用    ..;hardcode;...
                                      e.g. 换用字体 ..;hardcode=style:FontName=Segoe UI
                                      e.g. NV硬解码   ..;hardcode=input:-hwaccel cuda/output:-c:v h264_nvenc -crf 17 -b:v 5M
                                      多个选项用 / 隔开
                              e.g. --youtube "..." --opts "format=best&quiet=True&hardcode" --tags ...
                                  此外，针对视频对象，还提供其他变量:
                                      {id}
                                      {title}
                                      {descrption}
                                      {upload_date}
                                      {uploader}
                                      {uploader_id}
                                      {uploader_url}
                                      {channel_id}
                                      {channel_url}
                                      {duration}
                                      {view_count}
                                      {avereage_rating}
                                      ...
                                  注：输入播放列表且多 P 时，稿件标题为播放列表标题，稿件描述仅为 `来自Youtube`

                              默认配置：不烧入字幕，下载最高质量音视频，下载字幕但不操作

      变量：
          {title},{desc} 等变量适用于：
              title, desc, tags

      通用变量:
          {title}     -       原标题
          {desc}      -       原描述
          {safe_korean_title}
                      -       【韩文】替换韩文为特殊字符的标题
          {roma_korean_title}
                      -       【韩文】替换韩文为罗马音的标题 (需要安装 korean_romanizer)

      本工具支持将给定视频源转载至哔哩哔哩

      详见项目 README 以获取更多例程 ： github.com/greats3an/bilibili-toolman




  |分区| TID|
  |-|-|
  |MAD·AMV|24|完结动画|32|
  |MMD·3D|25|
  |综合|27|
  |短片·手书·配音|47|
  |特摄|86|
  |手办·模玩|210|

  |分区| TID|
  |-|-|
  |连载动画|33|
  |资讯|51|
  |官方延伸|152|

  |分区| TID|
  |-|-|
  |国产动画|153|
  |国产原创相关|168|
  |布袋戏|169|
  |资讯|170|
  |动态漫·广播剧|195|

  |分区| TID|
  |-|-|
  |原创音乐|28|
  |音乐现场|29|
  |VOCALOID·UTAU|30|
  |翻唱|31|
  |演奏|59|
  |音乐综合|130|
  |MV|193|
  |电音|194|

  |分区| TID|
  |-|-|
  |宅舞|20|
  |舞蹈综合|154|
  |舞蹈教程|156|
  |街舞|198|
  |明星舞蹈|199|
  |中国舞|200|

  |分区| TID|
  |-|-|
  |单机游戏|17|
  |Mugen|19|
  |网络游戏|65|
  |GMV|121|
  |音游|136|
  |电子竞技|171|
  |手机游戏|172|
  |桌游棋牌|173|

  |分区| TID|
  |-|-|
  |野生技术协会|122|
  |社科人文|124|
  |科学科普|201|
  |财经|207|
  |校园学习|208|
  |职业职场|209|

  |分区| TID|
  |-|-|
  |手机平板|95|
  |电脑装机|189|
  |摄影摄像|190|
  |影音智能|191|

  |分区| TID|
  |-|-|
  |日常|21|
  |动物圈|75|
  |美食圈|76|
  |搞笑|138|
  |手工|161|
  |绘画|162|
  |运动|163|
  |其他|174|
  |汽车|176|

  |分区| TID|
  |-|-|
  |鬼畜调教|22|
  |音MAD|26|
  |人力VOCALOID|126|
  |教程演示|127|

  |分区| TID|
  |-|-|
  |美妆|157|
  |服饰|158|
  |T台|159|
  |健身|164|
  |风尚标|192|

  |分区| TID|
  |-|-|
  |热点|203|
  |环球|204|
  |社会|205|
  |综合|206|

  |分区| TID|
  |-|-|
  |综艺|71|
  |明星|137|

  |分区| TID|
  |-|-|
  |短片|85|
  |影视杂谈|182|
  |影视剪辑|183|
  |预告·资讯|184|

  |分区| TID|
  |-|-|
  |人文·历史|37|
  |科学·探索·自然|178|
  |军事|179|
  |社会·美食·旅行|180|

  |分区| TID|
  |-|-|
  |其他国家|83|
  |欧美电影|145|
  |日本电影|146|
  |华语电影|147|

  |分区| TID|
  |-|-|
  |国产剧|185|
  |海外剧|187|


pkgId: 4d1b540a1ba59b725765e8b756e697dd957f4163bb151bd334785a7c8fcb0657
name: python-bilili
arch: src
version: 1.4.15
epoch: 0
release: 1
summary: 🍻 bilibili video and danmaku downloader | B站视频、弹幕下载器
url: https://github.com/yutto-dev/bilili
rpm_license: GPLv3
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bilili-1.4.15-1.src.rpm
checksum_type: sha256
description:
  <p align="center">
     <img src="./docs/.vuepress/public/logo.png" width="500px">
  </p>

  <p align="center">
     <a href="https://bilibili.com" target="_blank"><img src="https://img.shields.io/badge/bilibili-1eabc9.svg?logo=bilibili&logoColor=white&style=flat-square" alt="Bilibili"></a>
     <a href="https://python.org/" target="_blank"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/bilili?logo=python&style=flat-square"></a>
     <a href="https://pypi.org/project/bilili/" target="_blank"><img src="https://img.shields.io/pypi/v/bilili?style=flat-square" alt="pypi"></a>
     <a href="https://pypi.org/project/bilili/" target="_blank"><img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/bilili?style=flat-square"></a>
     <a href="https://actions-badge.atrox.dev/yutto-dev/bilili/goto?ref=main"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fyutto-dev%2Fbilili%2Fbadge%3Fref%3Dmain&label=API%20Test&style=flat-square" /></a>
     <a href="LICENSE"><img alt="LICENSE" src="https://img.shields.io/github/license/yutto-dev/bilili?style=flat-square"></a>
     <a href="https://gitmoji.dev"><img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67?style=flat-square" alt="Gitmoji"></a>
  </p>

  <p align="center"><strong>🍻 𝓫𝓲𝓵𝓲𝓵𝓲，一个可以帮你快速下载 <a href="https://www.bilibili.com">B 站</a>投稿视频以及番剧视频的 CLI～～～</strong></p>

  **文档戳这里啦 → [bilili の可愛い自己紹介](https://bilili.nyakku.moe)**

  如果想要体验 v2 请戳这里 → [yutto<sup>2.0.0-beta</sup>](https://github.com/yutto-dev/yutto)



  -  支持投稿视频（也即原 AV 号视频）和番剧下载
  -  多线程 + 分块下载，总之就是很快啦
  -  断点续传，即便一次没下完也可以接着下载
  -  弹幕支持，自动下载弹幕并可转换为 ASS 弹幕



  `bilili` 可以从以下两种视频主页获取视频

  -  投稿视频主页：
     -  `https://www.bilibili.com/video/avxxxxxx`
     -  `https://b23.tv/avxxxxxx`
     -  `https://www.bilibili.com/video/BVxxxxxx`
     -  `https://b23.tv/BVxxxxxx`
  -  番剧视频主页：
     -  `https://www.bilibili.com/bangumi/media/mdxxxxxx`
     -  `https://www.bilibili.com/bangumi/play/ssxxxxxx`
     -  `https://b23.tv/ssxxxxxx`
     -  `https://www.bilibili.com/bangumi/play/epxxxxxx`
     -  `https://b23.tv/epxxxxxx`



  由于大多数格式需要合并，所以 bilili 依赖于 FFmpeg，你需要事先安装好它

  Windows 请[手动下载](https://ffmpeg.org/download.html)并解压后，存放到任意文件夹下，之后将 `ffmpeg.exe` 所在文件夹**添加到环境变量**

  而如果是 macOS 或者 Linux 发行版，这一步可以很方便地通过包管理器一键完成啦～

  最后你可以通过直接在终端运行 `ffmpeg -version` 测试是否安装成功





  现在 bilili 支持通过 pip 一键安装

  ```bash
  pip install bilili
  ```



  此外你还可以从 GitHub 上下载最新的源码进行安装

  ```bash
  git clone git@github.com:yutto-dev/bilili.git
  cd bilili/
  pip install .
  ```



  你只需要这样就可以运行 bilili 啦～

  ```bash
  bilili <url>
  ```

  当然，你需要将 `<url>` 替换为前面的视频主页 url



  bilili 还支持很多参数，但参数使用方法等内容此处不作赘述，详情请访问[文档](https://bilili.nyakku.moe/cli/)

  -  `-t`/`--type` 选择下载类型（`flv` or `dash` or `mp4`），默认为 dash 类型，注意该参数仅代表下载源格式，所有格式最后均会转为 mp4
  -  `-d`/`--dir` 指定存储目录，默认为项目根目录
  -  `-q`/`--quality` 指定清晰度，默认为 `127`（8K 超高清）
  -  `-n`/`--num-threads` 指定最大下载线程数，默认为 16
  -  `-p`/`--episodes` 选集，默认为 `^~$`（全选）
  -  `-s`/`--with-section` 同时下载附加剧集（ PV、预告以及特别篇等专区内容）
  -  `-w`/`--overwrite` 强制覆盖已下载视频
  -  `-c`/`--sess-data` 传入 `cookies` 中的 `SESSDATA`
  -  `-y`/`--yes` 跳过下载询问
  -  `--audio-quality` 指定音频质量等级，默认为 `30280`（320kbps）
  -  `--playlist-type` 指定播放列表类型，支持 `dpl` 和 `m3u` ，默认为 `dpl`，设置为 `no` 即不生成播放列表
  -  `--danmaku` 指定弹幕类型，支持 `xml` 和 `ass`，如果设置为 `no` 则不下载弹幕，默认为 `xml` 弹幕
  -  `--block-size` 分块下载器的块大小，单位为 MB，默认为 128MB，设置为 0 时禁用分块下载
  -  `--abs-path` 修改播放列表路径类型为绝对路径
  -  `--use-mirrors` 启用从多个镜像下载功能
  -  `--disable-proxy` 禁用系统代理 「Beta」
  -  `--no-color` 不使用任何颜色
  -  `--debug` 开启 `debug` 模式



  请阅读 [CONTRIBUTING.md](CONTRIBUTING.md)


pkgId: ee095695fdc17905605d7de5e3166a75884a2959d136ba2ac416b5ac431780a6
name: python-biliup
arch: src
version: 0.4.78
epoch: 0
release: 1
summary: stream download and upload
url: https://github.com/ForgQi/bilibiliupload
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-biliup-0.4.78-1.src.rpm
checksum_type: sha256
description:
  <p align="center">
      <img src="https://image.biliup.me/2024-06-26/1719388842-365149-logo.png" width="400" alt="logo">
  </p>

  <div align="center">

  [![python](https://img.shields.io/badge/python-3.7%2B-blue)](http://www.python.org/download)
  [![PyPI](https://img.shields.io/pypi/v/biliup)](https://pypi.org/project/biliup)
  [![PyPI - Downloads](https://img.shields.io/pypi/dm/biliup)](https://pypi.org/project/biliup)
  [![license](https://img.shields.io/github/license/biliup/biliup)](https://github.com/biliup/biliup/blob/master/LICENSE)
  [![Telegram](https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram)](https://t.me/+IkpIABHqy6U0ZTQ5)


  [![issues](https://img.shields.io/github/issues/biliup/biliup?label=Github%20issues)](https://github.com/biliup/biliup/issues)
  [![STARS](https://img.shields.io/github/stars/biliup/biliup)](https://github.com/biliup/biliup/stargazers)
  [![forks](https://img.shields.io/github/forks/biliup/biliup)](https://github.com/biliup/biliup/network)

  </div>




    <p align="center">
      录制各大主流直播平台并上传至哔哩哔哩弹幕网<br />
    自动选择上传线路，保证上传稳定性，可手动调整并发<br />
      支持录制哔哩哔哩、斗鱼、虎牙、Twitch直播弹幕用于外挂播放器<br />
   防止录制花屏（使用默认的stream-gears下载器就会有这个功能），解决网络、PK导致的花屏。


  <br />
      <a href="https://biliup.github.io/biliup/docs/guide/changelog"><strong>更新日志 »</strong></a>
      <br />
      <br />
      <a href="https://github.com/biliup/biliup/wiki/%E5%AE%89%E8%A3%85-%E8%BF%90%E8%A1%8C-%E6%9B%B4%E6%96%B0-%E5%8D%B8%E8%BD%BD">简易教程</a>
      ·
      <a href="https://biliup.me/">交流社区</a>
      ·
      <a href="https://github.com/biliup/biliup-app">投稿工具</a>
    </p>
  </div>





  <p align="center">
    <b>社区教程</b>: <a href="https://www.bilibili.com/opus/908292536945082370">图文教程</a> by <a href="https://github.com/ikun1993">@ikun1993</a>编写。
  </p>




  下载 exe: [Release](https://github.com/biliup/biliup/releases/latest)


  0. python`version >= 3.8`
  1. `pip3 install biliup`
  2. `biliup start`
  3. 启动时访问 `http://your-ip:19159` 使用webUI，


  ![](.github/resource/light.png)
  ![](.github/resource/dark.png)



  1. nodejs `version >= 18`
  2. `npm i`
  3. `npm run dev`
  4. `python3 -m biliup`
  5. 访问`http://localhost:3000`



  | 直播平台 | 支持类型      | 链接示例 | 特殊注释 |
  | :------:| :--------------: | --------- | ------ |
  | 虎牙 | 直播 | `https://www.huya.com/123456` | 可录制弹幕 |
  | 斗鱼 | 直播 | `https://www.douyu.com/123456` | 可录制弹幕 |
  | YY语音 | 直播 | `https://www.yy.com/123456` |
  | 哔哩哔哩 | 直播 | `https://live.bilibili.com/123456` | 特殊分区hls流需要单独配置/可录制弹幕 |
  | acfun | 直播 | `https://live.acfun.cn/live/123456` |
  | afreecaTV | 直播 | `https://play.afreecatv.com/biliup123/123456` | 录制部分直播时需要登陆 |
  | bigo | 直播 | `https://www.bigo.tv/123456` |
  | 抖音 | 直播 | 直播:`https://live.douyin.com/123456(直播间数字号)`<br>直播:`https://live.douyin.com/tiktok(抖音号)`<br>主页:`https://www.douyin.com/user/456789(抖音号)` | 使用主页链接或被风控需配置cookies |
  | 快手 | 直播 | `https://live.kuaishou.com/u/biliup123` | 监控开播需使用中国大陆IPv4家宽，<br>且24小时内单直播间最多120次请求 |
  | 网易CC | 直播 | `https://cc.163.com/123456` |
  | flextv | 直播 | `https://www.flextv.co.kr/channels/123456/live` |
  | 映客 | 直播 | `https://www.inke.cn/liveroom/index.html?uid=123456` |
  | 猫耳FM | 直播 | `https://fm.missevan.com/live/123456` | 猫耳为纯音频流 |
  | nico | 直播 | `https://live.nicovideo.jp/watch/lv123456` | 可配置登录信息 |
  | twitch | 直播<br>回放 | 直播:`https://www.twitch.tv/biliup123`<br>回放:`https://www.twitch.tv/biliup123/videos?filter=archives&sort=time`  | 可配置登录信息/尽量录制回放/可录制弹幕 |
  | youtube | 直播<br>回放 | 直播:`https://www.youtube.com/watch?v=biliup123(单场)`<br>直播:`https://www.youtube.com/@biliup123/live(最远的预约)`<br>回放:`https://www.youtube.com/@biliup123/videos` | 可配置登录信息/尽量录制回放/可配置回放下载日期 |
  * 理论上streamlink与yt-dlp支持的都可以下载，但不保证可以正常使用，详见:[streamlink支持列表](https://streamlink.github.io/plugins.html)，[yt-dlp支持列表](https://github.com/yt-dlp/yt-dlp/tree/master/yt_dlp/extractor).



  * Thanks `ykdl, youtube-dl, streamlink` provides downloader.
  * Thanks `THMonster/danmaku`.



  * 爱发电 :`https://afdian.net/a/biliup`



  [![Star History Chart](https://api.star-history.com/svg?repos=biliup/biliup&type=Date)](https://star-history.com/#biliup/biliup&Date)


pkgId: 25750ec0a95683902a8d1cdcd603808bdf1f22ee3724a64dbc869faa6c7265c6
name: python-bilix
arch: src
version: 0.18.9
epoch: 0
release: 1
summary: ⚡️Lightning-fast asynchronous download tool for bilibili and more
url: https://github.com/HFrost0/bilix
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bilix-0.18.9-1.src.rpm
checksum_type: sha256
description:
  [![GitHub license](https://img.shields.io/github/license/HFrost0/bilix?style=flat-square)](https://github.com/HFrost0/bilix/blob/master/LICENSE)
  ![PyPI](https://img.shields.io/pypi/v/bilix?style=flat-square&color=blue)
  ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/HFrost0/bilix)
  ![PyPI - Downloads](https://img.shields.io/pypi/dm/bilix?label=pypi%20downloads&style=flat-square)

  ⚡️Lightning-fast asynchronous download tool for bilibili and more






  Asynchronous high concurrency support, controllable concurrency and speed settings.



  Lightweight user-friendly CLI with progress notification, focusing on core functionality.



  Submissions, anime, TV Series, video clip, audio, favourite, danmaku ,cover...



  Extensible Python module suitable for more download scenarios.



  ```shell
  pip install bilix
  ```

  for macOS, you can also install `bilix` by `brew`

  ```shell
  brew install bilix
  ```



  * If you prefer to use command line interface (cli)

  ```shell
  bilix v 'url'
  ```

  > `v` is a method short alias for `get_video`

  * If you prefer to code with python

  ```python
  from bilix.sites.bilibili import DownloaderBilibili
  import asyncio


  async def main():
      async with DownloaderBilibili() as d:
          await d.get_video('url')


  asyncio.run(main())
  ```



  If you find any bugs or other issues, feel free to raise an [Issue](https://github.com/HFrost0/bilix/issues).

  If you have new ideas or new feature requests👍，welcome to participate in
  the [Discussion](https://github.com/HFrost0/bilix/discussions)

  If you find this project helpful, you can support the author by [Star](https://github.com/HFrost0/bilix/stargazers)🌟



  ❤️ Welcome! Details can be found in [Contributing](https://github.com/HFrost0/bilix/blob/master/CONTRIBUTING_EN.md)


pkgId: fe1dbcd38d5a85189dff31a96574a4baf24722fc4af5a6b9773beed12299ee69
name: python-billboardgetter
arch: src
version: 0.0.2
epoch: 0
release: 1
summary: A small web scraping package
url: https://pypi.org/project/billboardgetter/
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-billboardgetter-0.0.2-1.src.rpm
checksum_type: sha256
rpm_license:
  MIT License  Copyright (c) 2023 Python web scraping tool  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


pkgId: dd2152c382aa35d28efc8b133943e7f410814915a36b25975d4a7bbf66a7223f
name: python-billing-sdk
arch: src
version: 0.7.3
epoch: 0
release: 1
summary: please add a summary manually as the author left a blank one
url: https://gitlab.mypath.group/my-path/billing-sdk
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-billing-sdk-0.7.3-1.src.rpm
checksum_type: sha256
description:
  ```python
  from billing import BillingClient
  billing_client = BillingClient(
      terminal_id="...",
      terminal_secret_key="tr_sk__...",
  )
  ```

  You can configure the SDK to use either synchronous or asynchronous requests:
  - **Synchronous Requests Only**:
    ```python
      billing_client = BillingClient(
          setup_sync_client=True,
      )
      ```
  - **Asynchronous Requests Only**:
    ```python
      billing_client = BillingClient(
          setup_async_client=True,
      )
      ```
  - **Both Synchronous and Asynchronous Requests**:
    ```python
      billing_client = BillingClient(
          setup_sync_client=True,
          setup_async_client=True,
      )
      ```

  If you have already initialized an `httpx` client in your application, you can reuse it in the `BillingClient` to avoid unnecessary resource allocation:
  ```python
  import httpx
  from billing import BillingClient
  reusable_sync_client = httpx.Client()
  billing_client = BillingClient(
      sync_client=reusable_sync_client,
  )

  reusable_async_client = httpx.AsyncClient()
  billing_client = BillingClient(
      async_client=reusable_async_client,
  )
  ```
  > ⚠️ **Warning:** Ensure that your custom `httpx` client is not pre-configured with a `base_url`, `headers`, or other settings that may cause unexpected errors when making API calls.

  Enable automatic retries for transient network errors by setting the `max_network_retries` parameter:
  ```python
  billing_client = BillingClient(
      max_network_retries=3,
  )
  ```

  You can access various API methods through the `BillingClient` properties. For example, to interact with the Agreement API:

  ```python
  agreements = billing_client.agreements.list(page_number=1, page_size=20)
  ```

  ```python
  agreements = await billing_client.agreements.list_async(page_number=1, page_size=20)
  ```
  For now Billing SDK support the following API methods:
  - `Agreement`
      - `retrieve`
      - `list`
  - `Feature`
      - `retrieve_usage_summary`
      - `list_usage_summary`
      - `record_usage`
  - `Invoice`
      - `retrieve`
      - `list`
  - `Offer`
      - `retrieve`
      - `list`
      - `cancel`
  - `Order`
      - `retrieve`
      - `list`
      - `create`
  - `Product`
      - `retrieve`
      - `list`

  When you receive a webhook from Billing, it is highly recommended to verify its Signature to ensure the integrity and authenticity of the event. The Billing SDK provides built-in support for webhook signature verification and event construction, making it easy to validate and process webhooks securely.

  Below is an example of how to set up a webhook handler using [FastAPI](https://github.com/fastapi/fastapi):
  ```python
  from billing import Webhook, SignatureVerificationError
  from fastapi import FastAPI, HTTPException, Header, Request, status

  terminal_webhook_secret_key = "tr_wsk__..."

  app = FastAPI(...)
  @app.post("billing/webhook", status_code=status.HTTP_200_OK)
  async def handle_billing_webhook(
      request: Request,
      x_billing_signature: str = Header(..., alias="X-Billing-Signature"),
      x_billing_signature_timestamp: str = Header(..., alias="X-Billing-Signature-Timestamp"),
  ) -> None:
      try:
          
          webhook_event = Webhook.construct_event(
              payload=await request.body(),  # The raw request body as payload
              signature=x_billing_signature,  # The signature from the header
              signature_timestamp=x_billing_signature_timestamp,  # The timestamp from the header
              terminal_webhook_secret_key=terminal_webhook_secret_key,  # Your secret key for verification
          )
          
          
          print("Received webhook event:", webhook_event)
      except SignatureVerificationError:
          raise HTTPException(
              status_code=status.HTTP_400_BAD_REQUEST,
              detail="Invalid webhook signature"
          )
  ```

  The Billing SDK is licensed under the MIT License. See the `LICENSE` file for more information.


pkgId: 610f3cd0bd9d347264fb4ff43d2e505500d469587a133b7b414acd43d64f036f
name: python-billomat
arch: src
version: 0.1.32
epoch: 0
release: 1
summary: billomat.com API client
url: http://jensnistler.de/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-billomat-0.1.32-1.src.rpm
checksum_type: sha256
description:
  This library is unmaintained!
  My employer stopped using billomat services. Therefore no fix or update will be done on this project anymore.
  If you're interested in taking over maintenance, let me know.


pkgId: 317a357ed464c6d51c880c1e2feef42e121457c4f5751a512b35298fab915408
name: python-bimdata-api-client
arch: src
version: 10.7.0
epoch: 0
release: 1
summary: BIMData API
url: https://github.com/bimdata/python-api-client
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bimdata-api-client-10.7.0-1.src.rpm
checksum_type: sha256
description:
  *BcfApi* | [**create_comment**](docs/BcfApi.md#create_comment) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments | Create a comment
  *BcfApi* | [**create_extension_label**](docs/BcfApi.md#create_extension_label) | **POST** /bcf/2.1/projects/{projects_pk}/extension/label | Create a Label
  *BcfApi* | [**create_extension_priority**](docs/BcfApi.md#create_extension_priority) | **POST** /bcf/2.1/projects/{projects_pk}/extension/priority | Create a Priority
  *BcfApi* | [**create_extension_stage**](docs/BcfApi.md#create_extension_stage) | **POST** /bcf/2.1/projects/{projects_pk}/extension/stage | Create a Stage
  *BcfApi* | [**create_extension_status**](docs/BcfApi.md#create_extension_status) | **POST** /bcf/2.1/projects/{projects_pk}/extension/status | Create a TopicStatus
  *BcfApi* | [**create_extension_type**](docs/BcfApi.md#create_extension_type) | **POST** /bcf/2.1/projects/{projects_pk}/extension/type | Create a TopicType
  *BcfApi* | [**create_full_topic**](docs/BcfApi.md#create_full_topic) | **POST** /bcf/2.1/projects/{projects_pk}/full-topic | Create a Topic with viewpoints and comments
  *BcfApi* | [**create_pin**](docs/BcfApi.md#create_pin) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin | Create a Pin
  *BcfApi* | [**create_topic**](docs/BcfApi.md#create_topic) | **POST** /bcf/2.1/projects/{projects_pk}/topics | Create a topic
  *BcfApi* | [**create_viewpoint**](docs/BcfApi.md#create_viewpoint) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints | Create a Viewpoint
  *BcfApi* | [**delete_comment**](docs/BcfApi.md#delete_comment) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Delete a comment
  *BcfApi* | [**delete_extension_label**](docs/BcfApi.md#delete_extension_label) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/label/{id} | Delete a Label
  *BcfApi* | [**delete_extension_priority**](docs/BcfApi.md#delete_extension_priority) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/priority/{id} | Delete a Priority
  *BcfApi* | [**delete_extension_stage**](docs/BcfApi.md#delete_extension_stage) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/stage/{id} | Delete a Stage
  *BcfApi* | [**delete_extension_status**](docs/BcfApi.md#delete_extension_status) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/status/{id} | Delete a TopicStatus
  *BcfApi* | [**delete_extension_type**](docs/BcfApi.md#delete_extension_type) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/type/{id} | Delete a TopicType
  *BcfApi* | [**delete_pin**](docs/BcfApi.md#delete_pin) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Delete a Pin
  *BcfApi* | [**delete_topic**](docs/BcfApi.md#delete_topic) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Delete a topic
  *BcfApi* | [**delete_viewpoint**](docs/BcfApi.md#delete_viewpoint) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Delete a Viewpoint
  *BcfApi* | [**download_bcf_export**](docs/BcfApi.md#download_bcf_export) | **GET** /bcf/2.1/projects/{id}/export | Export project&#39;s topics in bcf-xml format
  *BcfApi* | [**download_bcf_export_xlsx**](docs/BcfApi.md#download_bcf_export_xlsx) | **GET** /bcf/2.1/projects/{id}/export-xlsx | Export project&#39;s topics in excel format
  *BcfApi* | [**full_update_bcf_project**](docs/BcfApi.md#full_update_bcf_project) | **PUT** /bcf/2.1/projects/{id} | Update all fields of a BCF project
  *BcfApi* | [**full_update_comment**](docs/BcfApi.md#full_update_comment) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Update all fields of a comment
  *BcfApi* | [**full_update_full_topic**](docs/BcfApi.md#full_update_full_topic) | **PUT** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Update all fields of a topic
  *BcfApi* | [**full_update_pin**](docs/BcfApi.md#full_update_pin) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Update all fields of a Pin
  *BcfApi* | [**full_update_topic**](docs/BcfApi.md#full_update_topic) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Update all fields of a topic
  *BcfApi* | [**get_auth**](docs/BcfApi.md#get_auth) | **GET** /bcf/2.1/auth | Retrieve Authentication Information
  *BcfApi* | [**get_bcf_project**](docs/BcfApi.md#get_bcf_project) | **GET** /bcf/2.1/projects/{id} | Retrieve a BCF project
  *BcfApi* | [**get_bcf_projects**](docs/BcfApi.md#get_bcf_projects) | **GET** /bcf/2.1/projects | Retrieve all BCF projects
  *BcfApi* | [**get_colorings**](docs/BcfApi.md#get_colorings) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/coloring | Retrieve all colorings of a viewpoint
  *BcfApi* | [**get_comment**](docs/BcfApi.md#get_comment) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Retrieve a comment
  *BcfApi* | [**get_comments**](docs/BcfApi.md#get_comments) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments | Retrieve all comments
  *BcfApi* | [**get_detailed_extensions**](docs/BcfApi.md#get_detailed_extensions) | **GET** /bcf/2.1/projects/{id}/detailed-extensions | Retrieve project detailed extensions
  *BcfApi* | [**get_extensions**](docs/BcfApi.md#get_extensions) | **GET** /bcf/2.1/projects/{id}/extensions | Retrieve project extensions
  *BcfApi* | [**get_full_topic**](docs/BcfApi.md#get_full_topic) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Retrieve a full topic
  *BcfApi* | [**get_full_topics**](docs/BcfApi.md#get_full_topics) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic | Retrieve all full topics
  *BcfApi* | [**get_pins**](docs/BcfApi.md#get_pins) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin | Retrieve all Pins of a viewpoint
  *BcfApi* | [**get_related_topics**](docs/BcfApi.md#get_related_topics) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/related_topics | Get all related topics
  *BcfApi* | [**get_selections**](docs/BcfApi.md#get_selections) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/selection | Retrieve all selections of a viewpoint
  *BcfApi* | [**get_snapshot**](docs/BcfApi.md#get_snapshot) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/snapshot | Retrieve the viewpoint&#39; snapshot
  *BcfApi* | [**get_topic**](docs/BcfApi.md#get_topic) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Retrieve a topic
  *BcfApi* | [**get_topic_document_references**](docs/BcfApi.md#get_topic_document_references) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references | Get all related documents
  *BcfApi* | [**get_topic_viewpoints**](docs/BcfApi.md#get_topic_viewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints | Retrieve all viewpoints attached to the topic
  *BcfApi* | [**get_topics**](docs/BcfApi.md#get_topics) | **GET** /bcf/2.1/projects/{projects_pk}/topics | Retrieve all topics
  *BcfApi* | [**get_user**](docs/BcfApi.md#get_user) | **GET** /bcf/2.1/current-user | Get current user info
  *BcfApi* | [**get_versions**](docs/BcfApi.md#get_versions) | **GET** /bcf/versions | Retrieve all supported BCF versions by this API
  *BcfApi* | [**get_viewpoin_pin**](docs/BcfApi.md#get_viewpoin_pin) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Retrieve a Pin
  *BcfApi* | [**get_viewpoint**](docs/BcfApi.md#get_viewpoint) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Retrieve a Viewpoint
  *BcfApi* | [**get_viewpoints**](docs/BcfApi.md#get_viewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints | Retrieve all Viewpoints of a topic
  *BcfApi* | [**get_visibilities**](docs/BcfApi.md#get_visibilities) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/visibility | Retrieve all visibilities of a viewpoint
  *BcfApi* | [**import_bcf**](docs/BcfApi.md#import_bcf) | **POST** /bcf/2.1/projects/{id}/import | Import bcf-xml format into this project
  *BcfApi* | [**update_bcf_project**](docs/BcfApi.md#update_bcf_project) | **PATCH** /bcf/2.1/projects/{id} | Update some fields of a BCF project
  *BcfApi* | [**update_comment**](docs/BcfApi.md#update_comment) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Update some fields of a comment
  *BcfApi* | [**update_extension_label**](docs/BcfApi.md#update_extension_label) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/label/{id} | Update a Label
  *BcfApi* | [**update_extension_priority**](docs/BcfApi.md#update_extension_priority) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/priority/{id} | Update a Priority
  *BcfApi* | [**update_extension_stage**](docs/BcfApi.md#update_extension_stage) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/stage/{id} | Update a Stage
  *BcfApi* | [**update_extension_status**](docs/BcfApi.md#update_extension_status) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/status/{id} | Update a TopicStatus
  *BcfApi* | [**update_extension_type**](docs/BcfApi.md#update_extension_type) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/type/{id} | Update a TopicType
  *BcfApi* | [**update_full_topic**](docs/BcfApi.md#update_full_topic) | **PATCH** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Update some fields of a topic
  *BcfApi* | [**update_pin**](docs/BcfApi.md#update_pin) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Update some fields of a Pin
  *BcfApi* | [**update_topic**](docs/BcfApi.md#update_topic) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Update some fields of a topic
  *BcfApi* | [**update_viewpoint**](docs/BcfApi.md#update_viewpoint) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Update some fields of a Viewpoint
  *CollaborationApi* | [**accept_user_invitation**](docs/CollaborationApi.md#accept_user_invitation) | **POST** /user/invitations/{id}/accept | Accept an invitation
  *CollaborationApi* | [**accept_validation**](docs/CollaborationApi.md#accept_validation) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/accept | Accept a validation
  *CollaborationApi* | [**add_document_tag**](docs/CollaborationApi.md#add_document_tag) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/tag | Add a tag to a document
  *CollaborationApi* | [**add_group_member**](docs/CollaborationApi.md#add_group_member) | **POST** /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/member | Add a user to a group
  *CollaborationApi* | [**cancel_cloud_user_invitation**](docs/CollaborationApi.md#cancel_cloud_user_invitation) | **DELETE** /cloud/{cloud_pk}/invitation/{id} | Cancel a pending invitation
  *CollaborationApi* | [**cancel_project_user_invitation**](docs/CollaborationApi.md#cancel_project_user_invitation) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/invitation/{id} | Cancel a pending invitation
  *CollaborationApi* | [**check_access**](docs/CollaborationApi.md#check_access) | **GET** /cloud/{id}/check-access | Check app access from cloud
  *CollaborationApi* | [**check_project_access**](docs/CollaborationApi.md#check_project_access) | **GET** /cloud/{cloud_pk}/project/{id}/check-access | Check if the current token has access to the requested project
  *CollaborationApi* | [**close_visa**](docs/CollaborationApi.md#close_visa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/close | Close a visa of a document
  *CollaborationApi* | [**create_classification**](docs/CollaborationApi.md#create_classification) | **POST** /cloud/{cloud_pk}/project/{project_pk}/classification | Create a classification
  *CollaborationApi* | [**create_cloud**](docs/CollaborationApi.md#create_cloud) | **POST** /cloud | Create a cloud
  *CollaborationApi* | [**create_demo**](docs/CollaborationApi.md#create_demo) | **POST** /cloud/{id}/create-demo | Create a Demo project in a cloud
  *CollaborationApi* | [**create_dms_tree**](docs/CollaborationApi.md#create_dms_tree) | **POST** /cloud/{cloud_pk}/project/{id}/dms-tree | Create a complete DMS tree
  *CollaborationApi* | [**create_document**](docs/CollaborationApi.md#create_document) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document | Create a document
  *CollaborationApi* | [**create_folder**](docs/CollaborationApi.md#create_folder) | **POST** /cloud/{cloud_pk}/project/{project_pk}/folder | Create a folder
  *CollaborationApi* | [**create_manage_group**](docs/CollaborationApi.md#create_manage_group) | **POST** /cloud/{cloud_pk}/project/{project_pk}/group | Create a group
  *CollaborationApi* | [**create_project**](docs/CollaborationApi.md#create_project) | **POST** /cloud/{cloud_pk}/project | Create a project
  *CollaborationApi* | [**create_project_access_token**](docs/CollaborationApi.md#create_project_access_token) | **POST** /cloud/{cloud_pk}/project/{project_pk}/access-token | Create a token for this project
  *CollaborationApi* | [**create_tag**](docs/CollaborationApi.md#create_tag) | **POST** /cloud/{cloud_pk}/project/{project_pk}/tag | Create a tag
  *CollaborationApi* | [**create_validation**](docs/CollaborationApi.md#create_validation) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation | Add a validation to a visa
  *CollaborationApi* | [**create_visa**](docs/CollaborationApi.md#create_visa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa | Create a visa
  *CollaborationApi* | [**create_visa_comment**](docs/CollaborationApi.md#create_visa_comment) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment | Add a comment
  *CollaborationApi* | [**delete_all_document_history**](docs/CollaborationApi.md#delete_all_document_history) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/delete | Delete all document history
  *CollaborationApi* | [**delete_classification**](docs/CollaborationApi.md#delete_classification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Delete a classification
  *CollaborationApi* | [**delete_cloud**](docs/CollaborationApi.md#delete_cloud) | **DELETE** /cloud/{id} | Delete a cloud
  *CollaborationApi* | [**delete_cloud_user**](docs/CollaborationApi.md#delete_cloud_user) | **DELETE** /cloud/{cloud_pk}/user/{id} | Remove a user from a cloud
  *CollaborationApi* | [**delete_document**](docs/CollaborationApi.md#delete_document) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Delete the document
  *CollaborationApi* | [**delete_document_tag**](docs/CollaborationApi.md#delete_document_tag) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/tag/{id} | Delete a tag from a document
  *CollaborationApi* | [**delete_folder**](docs/CollaborationApi.md#delete_folder) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Delete a folder
  *CollaborationApi* | [**delete_group_member**](docs/CollaborationApi.md#delete_group_member) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/member/{id} | Delete a user from a group
  *CollaborationApi* | [**delete_manage_group**](docs/CollaborationApi.md#delete_manage_group) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/group/{id} | Delete a group
  *CollaborationApi* | [**delete_project**](docs/CollaborationApi.md#delete_project) | **DELETE** /cloud/{cloud_pk}/project/{id} | Delete a project
  *CollaborationApi* | [**delete_project_access_token**](docs/CollaborationApi.md#delete_project_access_token) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} | Delete a token
  *CollaborationApi* | [**delete_project_user**](docs/CollaborationApi.md#delete_project_user) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Remove a user from a project
  *CollaborationApi* | [**delete_tag**](docs/CollaborationApi.md#delete_tag) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/tag/{id} | Delete the tag
  *CollaborationApi* | [**delete_validation**](docs/CollaborationApi.md#delete_validation) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id} | Remove a validation
  *CollaborationApi* | [**delete_visa**](docs/CollaborationApi.md#delete_visa) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id} | Remove a visa
  *CollaborationApi* | [**delete_visa_comment**](docs/CollaborationApi.md#delete_visa_comment) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} | Remove a comment
  *CollaborationApi* | [**deny_user_invitation**](docs/CollaborationApi.md#deny_user_invitation) | **POST** /user/invitations/{id}/deny | Deny an invitation
  *CollaborationApi* | [**deny_validation**](docs/CollaborationApi.md#deny_validation) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/deny | Deny a validation
  *CollaborationApi* | [**get_classification**](docs/CollaborationApi.md#get_classification) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Retrieve a classification
  *CollaborationApi* | [**get_classifications**](docs/CollaborationApi.md#get_classifications) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification | Retrieve all classifications
  *CollaborationApi* | [**get_cloud**](docs/CollaborationApi.md#get_cloud) | **GET** /cloud/{id} | Retrieve one cloud
  *CollaborationApi* | [**get_cloud_invitations**](docs/CollaborationApi.md#get_cloud_invitations) | **GET** /cloud/{cloud_pk}/invitation | Retrieve all pending invitations in the cloud
  *CollaborationApi* | [**get_cloud_size**](docs/CollaborationApi.md#get_cloud_size) | **GET** /cloud/{id}/size | Get size of the cloud
  *CollaborationApi* | [**get_cloud_user**](docs/CollaborationApi.md#get_cloud_user) | **GET** /cloud/{cloud_pk}/user/{id} | Retrieve a user in a cloud
  *CollaborationApi* | [**get_cloud_users**](docs/CollaborationApi.md#get_cloud_users) | **GET** /cloud/{cloud_pk}/user | Retrieve all users in a cloud, or a list with a filter by email
  *CollaborationApi* | [**get_clouds**](docs/CollaborationApi.md#get_clouds) | **GET** /cloud | Retrieve all clouds
  *CollaborationApi* | [**get_document**](docs/CollaborationApi.md#get_document) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Retrieve a document
  *CollaborationApi* | [**get_document_histories**](docs/CollaborationApi.md#get_document_histories) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history | Retrieve all document histories
  *CollaborationApi* | [**get_documents**](docs/CollaborationApi.md#get_documents) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document | Retrieve all documents
  *CollaborationApi* | [**get_folder**](docs/CollaborationApi.md#get_folder) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Retrieve a folder
  *CollaborationApi* | [**get_folder_documents**](docs/CollaborationApi.md#get_folder_documents) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/document | Get all documents of a folder
  *CollaborationApi* | [**get_folder_project_users**](docs/CollaborationApi.md#get_folder_project_users) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/user | Retrieve all users in a project with the permission on the folder
  *CollaborationApi* | [**get_folders**](docs/CollaborationApi.md#get_folders) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder | Retrieve all folders
  *CollaborationApi* | [**get_group**](docs/CollaborationApi.md#get_group) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/group/{id} | Retrieve a group
  *CollaborationApi* | [**get_groups**](docs/CollaborationApi.md#get_groups) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/group | Retrieve all groups
  *CollaborationApi* | [**get_logs**](docs/CollaborationApi.md#get_logs) | **GET** /cloud/{cloud_pk}/project/{project_pk}/logs | Retrieve all logs of the project
  *CollaborationApi* | [**get_manage_group**](docs/CollaborationApi.md#get_manage_group) | **GET** /cloud/{cloud_pk}/project/{project_pk}/group/{id} | Retrieve a group
  *CollaborationApi* | [**get_manage_groups**](docs/CollaborationApi.md#get_manage_groups) | **GET** /cloud/{cloud_pk}/project/{project_pk}/group | Retrieve all groups
  *CollaborationApi* | [**get_project**](docs/CollaborationApi.md#get_project) | **GET** /cloud/{cloud_pk}/project/{id} | Retrieve a project
  *CollaborationApi* | [**get_project_access_token**](docs/CollaborationApi.md#get_project_access_token) | **GET** /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} | Retrieve one token created for this project
  *CollaborationApi* | [**get_project_access_tokens**](docs/CollaborationApi.md#get_project_access_tokens) | **GET** /cloud/{cloud_pk}/project/{project_pk}/access-token | Retrieve all tokens created for this project
  *CollaborationApi* | [**get_project_creator_visas**](docs/CollaborationApi.md#get_project_creator_visas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/creator | List visas created by user
  *CollaborationApi* | [**get_project_dms_tree**](docs/CollaborationApi.md#get_project_dms_tree) | **GET** /cloud/{cloud_pk}/project/{id}/dms-tree | Retrieve the complete DMS tree
  *CollaborationApi* | [**get_project_folder_tree**](docs/CollaborationApi.md#get_project_folder_tree) | **GET** /cloud/{cloud_pk}/project/{id}/folder-tree | Retrieve folder tree of the project
  *CollaborationApi* | [**get_project_invitations**](docs/CollaborationApi.md#get_project_invitations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/invitation | Retrieve all pending invitations in the project
  *CollaborationApi* | [**get_project_size**](docs/CollaborationApi.md#get_project_size) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all model files in the project
  *CollaborationApi* | [**get_project_sub_tree**](docs/CollaborationApi.md#get_project_sub_tree) | **GET** /cloud/{cloud_pk}/project/subtree | Retrieve the complete projects tree of the cloud
  *CollaborationApi* | [**get_project_tree**](docs/CollaborationApi.md#get_project_tree) | **GET** /cloud/{cloud_pk}/project/{id}/tree | Retrieve the complete DMS tree
  *CollaborationApi* | [**get_project_users**](docs/CollaborationApi.md#get_project_users) | **GET** /cloud/{cloud_pk}/project/{project_pk}/user | Retrieve all users in a project, or a list with a filter by email
  *CollaborationApi* | [**get_project_validator_visas**](docs/CollaborationApi.md#get_project_validator_visas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/validator | List visas where user is a validator
  *CollaborationApi* | [**get_projects**](docs/CollaborationApi.md#get_projects) | **GET** /cloud/{cloud_pk}/project | Retrieve all projects
  *CollaborationApi* | [**get_self_projects**](docs/CollaborationApi.md#get_self_projects) | **GET** /user/projects | List current user&#39;s projects
  *CollaborationApi* | [**get_self_user**](docs/CollaborationApi.md#get_self_user) | **GET** /user | Get info about the current user
  *CollaborationApi* | [**get_tag**](docs/CollaborationApi.md#get_tag) | **GET** /cloud/{cloud_pk}/project/{project_pk}/tag/{id} | Retrieve a tag
  *CollaborationApi* | [**get_tags**](docs/CollaborationApi.md#get_tags) | **GET** /cloud/{cloud_pk}/project/{project_pk}/tag | Retrieve all tags
  *CollaborationApi* | [**get_user_invitation**](docs/CollaborationApi.md#get_user_invitation) | **GET** /user/invitations/{id} | Retrieve an invitation
  *CollaborationApi* | [**get_user_invitations**](docs/CollaborationApi.md#get_user_invitations) | **GET** /user/invitations | List user&#39;s invitations
  *CollaborationApi* | [**get_validation**](docs/CollaborationApi.md#get_validation) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id} | Retrieve a validation to a visa
  *CollaborationApi* | [**get_validations**](docs/CollaborationApi.md#get_validations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation | List all validations to a visa
  *CollaborationApi* | [**get_visa**](docs/CollaborationApi.md#get_visa) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id} | Retrieve a visa of a document
  *CollaborationApi* | [**get_visa_comment**](docs/CollaborationApi.md#get_visa_comment) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} | Retrieve a comment
  *CollaborationApi* | [**get_visa_comments**](docs/CollaborationApi.md#get_visa_comments) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment | List all comment of a visa
  *CollaborationApi* | [**get_visas**](docs/CollaborationApi.md#get_visas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa | List all visas of a document
  *CollaborationApi* | [**import_from_project**](docs/CollaborationApi.md#import_from_project) | **POST** /cloud/{cloud_pk}/project/{id}/import_from | Import data from a project
  *CollaborationApi* | [**import_manage_group**](docs/CollaborationApi.md#import_manage_group) | **POST** /cloud/{cloud_pk}/project/{project_pk}/group/import | Import a group from another project
  *CollaborationApi* | [**invite_cloud_user**](docs/CollaborationApi.md#invite_cloud_user) | **POST** /cloud/{cloud_pk}/invitation | Invite a cloud member
  *CollaborationApi* | [**invite_project_user**](docs/CollaborationApi.md#invite_project_user) | **POST** /cloud/{cloud_pk}/project/{project_pk}/invitation | Invite a project member
  *CollaborationApi* | [**leave_project**](docs/CollaborationApi.md#leave_project) | **POST** /cloud/{cloud_pk}/project/{id}/leave | Leave the project
  *CollaborationApi* | [**leave_version_document_history**](docs/CollaborationApi.md#leave_version_document_history) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/{id}/leave | Leave the history version
  *CollaborationApi* | [**make_head_version_document_history**](docs/CollaborationApi.md#make_head_version_document_history) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/{id}/head-version | Make the head of the version
  *CollaborationApi* | [**pause_visa**](docs/CollaborationApi.md#pause_visa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/pause | Pause a visa of a document
  *CollaborationApi* | [**reset_validation**](docs/CollaborationApi.md#reset_validation) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/reset | Reset a validation
  *CollaborationApi* | [**resume_visa**](docs/CollaborationApi.md#resume_visa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/resume | Resume a visa of a document
  *CollaborationApi* | [**update_classification**](docs/CollaborationApi.md#update_classification) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Update some fields of a classification
  *CollaborationApi* | [**update_cloud**](docs/CollaborationApi.md#update_cloud) | **PATCH** /cloud/{id} | Update some fields of a cloud
  *CollaborationApi* | [**update_cloud_user**](docs/CollaborationApi.md#update_cloud_user) | **PATCH** /cloud/{cloud_pk}/user/{id} | Change the user role in the cloud
  *CollaborationApi* | [**update_document**](docs/CollaborationApi.md#update_document) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update some fields of the document
  *CollaborationApi* | [**update_folder**](docs/CollaborationApi.md#update_folder) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Update some fields of a folder
  *CollaborationApi* | [**update_group_folder**](docs/CollaborationApi.md#update_group_folder) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/group/{id} | Update the permission of a group on a folder. When propagate is set to True, the permission of all children in the folder will be updated.
  *CollaborationApi* | [**update_manage_group**](docs/CollaborationApi.md#update_manage_group) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/group/{id} | Update some fields of a group
  *CollaborationApi* | [**update_preview_file**](docs/CollaborationApi.md#update_preview_file) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id}/preview-file | Update preview of the document
  *CollaborationApi* | [**update_project**](docs/CollaborationApi.md#update_project) | **PATCH** /cloud/{cloud_pk}/project/{id} | Update some fields of a project
  *CollaborationApi* | [**update_project_user**](docs/CollaborationApi.md#update_project_user) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Change the user role in the cloud
  *CollaborationApi* | [**update_tag**](docs/CollaborationApi.md#update_tag) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/tag/{id} | Update some fields of the tag
  *CollaborationApi* | [**update_validation**](docs/CollaborationApi.md#update_validation) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id} | Update the validator of validation
  *CollaborationApi* | [**update_visa**](docs/CollaborationApi.md#update_visa) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id} | Update some fields of a visa
  *CollaborationApi* | [**update_visa_comment**](docs/CollaborationApi.md#update_visa_comment) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} | Update some fields of a comment
  *ModelApi* | [**add_model_errors**](docs/ModelApi.md#add_model_errors) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/errors | Add errors to model
  *ModelApi* | [**add_zone_space**](docs/ModelApi.md#add_zone_space) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/add | Add a space to a zone
  *ModelApi* | [**bulk_delete_model_classifications**](docs/ModelApi.md#bulk_delete_model_classifications) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/list_destroy | Remove all classifications from model&#39;s elements
  *ModelApi* | [**bulk_delete_model_properties**](docs/ModelApi.md#bulk_delete_model_properties) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_destroy | Delete many Property of a model
  *ModelApi* | [**bulk_delete_model_property_definitions**](docs/ModelApi.md#bulk_delete_model_property_definitions) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/bulk_destroy | Delete many PropertyDefinitions of a model
  *ModelApi* | [**bulk_delete_model_units**](docs/ModelApi.md#bulk_delete_model_units) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/bulk_destroy | Delete many Units of a model
  *ModelApi* | [**bulk_delete_property_set**](docs/ModelApi.md#bulk_delete_property_set) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/bulk_destroy | Delete many PropertySet of a model
  *ModelApi* | [**bulk_full_update_elements**](docs/ModelApi.md#bulk_full_update_elements) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/bulk_update | Update many elements at once (only changing fields may be defined)
  *ModelApi* | [**bulk_full_update_model_property**](docs/ModelApi.md#bulk_full_update_model_property) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_update | Update some fields of many properties of a model
  *ModelApi* | [**bulk_remove_classifications_of_element**](docs/ModelApi.md#bulk_remove_classifications_of_element) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification/bulk_destroy | Remove many classifications from an element
  *ModelApi* | [**bulk_remove_documents_of_element**](docs/ModelApi.md#bulk_remove_documents_of_element) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents/bulk_destroy | Remove many documents from an element
  *ModelApi* | [**bulk_remove_elements_from_classification**](docs/ModelApi.md#bulk_remove_elements_from_classification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element/bulk_destroy | Remove the classifications from all elements
  *ModelApi* | [**bulk_update_elements**](docs/ModelApi.md#bulk_update_elements) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/bulk_update | Update many elements at once (all field must be defined)
  *ModelApi* | [**bulk_update_model_property**](docs/ModelApi.md#bulk_update_model_property) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_update | Update all fields of many properties of a model
  *ModelApi* | [**create_access_token**](docs/ModelApi.md#create_access_token) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token | Create a token for this model
  *ModelApi* | [**create_building**](docs/ModelApi.md#create_building) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building | Create a building of a model
  *ModelApi* | [**create_building_plan**](docs/ModelApi.md#create_building_plan) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/add | Create a relation between a 2d model and a building
  *ModelApi* | [**create_classification_element_relations**](docs/ModelApi.md#create_classification_element_relations) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification-element | Create association between existing classification and existing element
  *ModelApi* | [**create_classifications_of_element**](docs/ModelApi.md#create_classifications_of_element) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification | Create one or many classifications to an element
  *ModelApi* | [**create_drawing**](docs/ModelApi.md#create_drawing) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing | Create a drawing in the model
  *ModelApi* | [**create_element**](docs/ModelApi.md#create_element) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element | Create an element in the model
  *ModelApi* | [**create_element_property_set**](docs/ModelApi.md#create_element_property_set) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset | Create a PropertySets to an element
  *ModelApi* | [**create_element_property_set_property**](docs/ModelApi.md#create_element_property_set_property) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property | Create a property to a PropertySet
  *ModelApi* | [**create_element_property_set_property_definition**](docs/ModelApi.md#create_element_property_set_property_definition) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition | Create a Definition to a Property
  *ModelApi* | [**create_element_property_set_property_definition_unit**](docs/ModelApi.md#create_element_property_set_property_definition_unit) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit | Create a Unit to a Definition
  *ModelApi* | [**create_layer**](docs/ModelApi.md#create_layer) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer | Create a layer in the model
  *ModelApi* | [**create_meta_building**](docs/ModelApi.md#create_meta_building) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-metabuilding | Create an empty 3D Model
  *ModelApi* | [**create_model**](docs/ModelApi.md#create_model) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-model | Make a PDF or Image file a Model
  *ModelApi* | [**create_model_property_definition**](docs/ModelApi.md#create_model_property_definition) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition | Create a PropertyDefinition on the model
  *ModelApi* | [**create_model_unit**](docs/ModelApi.md#create_model_unit) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit | Create a Unit on a model
  *ModelApi* | [**create_multi_page_model**](docs/ModelApi.md#create_multi_page_model) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/create-multipage-model | Create a multi page model
  *ModelApi* | [**create_photosphere**](docs/ModelApi.md#create_photosphere) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-photosphere | Create a photopshere model from an image file
  *ModelApi* | [**create_photosphere_building**](docs/ModelApi.md#create_photosphere_building) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-photosphere-building | Create an empty Photosphere Building Model
  *ModelApi* | [**create_property_set**](docs/ModelApi.md#create_property_set) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset | Create one or many PropertySet
  *ModelApi* | [**create_property_set_element_relations**](docs/ModelApi.md#create_property_set_element_relations) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset-element | Create association between PropertySet and element
  *ModelApi* | [**create_raw_elements**](docs/ModelApi.md#create_raw_elements) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/raw | Create elements in an optimized format
  *ModelApi* | [**create_space**](docs/ModelApi.md#create_space) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space | Create a space in the model
  *ModelApi* | [**create_storey**](docs/ModelApi.md#create_storey) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey | Create a storey of a model
  *ModelApi* | [**create_storey_plan**](docs/ModelApi.md#create_storey_plan) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/add | Create a relation between a 2d model and a storey
  *ModelApi* | [**create_system**](docs/ModelApi.md#create_system) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system | Create a system in the model
  *ModelApi* | [**create_tileset**](docs/ModelApi.md#create_tileset) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/tileset | Create the tileset of the model and upload all files
  *ModelApi* | [**create_xkt_file**](docs/ModelApi.md#create_xkt_file) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/xkt-file | Create an xkt file for the model. Overrides existing file with same version
  *ModelApi* | [**create_zone**](docs/ModelApi.md#create_zone) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone | Create a zone in the model
  *ModelApi* | [**create_zone_space**](docs/ModelApi.md#create_zone_space) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space | Create a space in a zone
  *ModelApi* | [**delete_access_token**](docs/ModelApi.md#delete_access_token) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token} | Delete a token
  *ModelApi* | [**delete_building**](docs/ModelApi.md#delete_building) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid} | Delete a building of a model
  *ModelApi* | [**delete_building_plan**](docs/ModelApi.md#delete_building_plan) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id} | Delete the relation between a 2d model and a building
  *ModelApi* | [**delete_drawing**](docs/ModelApi.md#delete_drawing) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} | Delete a drawing of a model
  *ModelApi* | [**delete_element**](docs/ModelApi.md#delete_element) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Delete an element of a model
  *ModelApi* | [**delete_layer**](docs/ModelApi.md#delete_layer) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Delete a layer of a model
  *ModelApi* | [**delete_model**](docs/ModelApi.md#delete_model) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id} | Delete a model
  *ModelApi* | [**delete_model_property**](docs/ModelApi.md#delete_model_property) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} | Delete a Property of a model
  *ModelApi* | [**delete_model_property_definition**](docs/ModelApi.md#delete_model_property_definition) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} | Delete a PropertyDefinitions of a model
  *ModelApi* | [**delete_model_unit**](docs/ModelApi.md#delete_model_unit) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id} | Delete a Unit of a model
  *ModelApi* | [**delete_model_without_doc**](docs/ModelApi.md#delete_model_without_doc) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/delete-model | Delete the Model without deleting the related document
  *ModelApi* | [**delete_property_set**](docs/ModelApi.md#delete_property_set) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id} | Delete a PropertySet of a model
  *ModelApi* | [**delete_space**](docs/ModelApi.md#delete_space) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id} | Delete a space
  *ModelApi* | [**delete_storey**](docs/ModelApi.md#delete_storey) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid} | Delete a storey of a model
  *ModelApi* | [**delete_storey_plan**](docs/ModelApi.md#delete_storey_plan) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id} | Delete the relation between a 2d model and a storey
  *ModelApi* | [**delete_system**](docs/ModelApi.md#delete_system) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} | Delete a system of a model
  *ModelApi* | [**delete_zone**](docs/ModelApi.md#delete_zone) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} | Delete a zone of a model
  *ModelApi* | [**delete_zone_space**](docs/ModelApi.md#delete_zone_space) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} | Delete the relation between a space and a zone
  *ModelApi* | [**export_ifc**](docs/ModelApi.md#export_ifc) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/export | Export IFC
  *ModelApi* | [**full_update_element**](docs/ModelApi.md#full_update_element) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Update all fields of an element
  *ModelApi* | [**get_access_token**](docs/ModelApi.md#get_access_token) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token} | Retrieve one token created for this model
  *ModelApi* | [**get_access_tokens**](docs/ModelApi.md#get_access_tokens) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token | Retrieve all tokens created for this model
  *ModelApi* | [**get_building**](docs/ModelApi.md#get_building) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid} | Retrieve a building of a model
  *ModelApi* | [**get_building_plan_positioning**](docs/ModelApi.md#get_building_plan_positioning) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id}/positioning | Retrieve the postioning of the plan in the building
  *ModelApi* | [**get_buildings**](docs/ModelApi.md#get_buildings) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building | Retrieve all buildings of a model
  *ModelApi* | [**get_classifications_of_element**](docs/ModelApi.md#get_classifications_of_element) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification | Retrieve all classifications of an element
  *ModelApi* | [**get_documents_of_element**](docs/ModelApi.md#get_documents_of_element) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents | Retrieve all documents of an element
  *ModelApi* | [**get_drawing**](docs/ModelApi.md#get_drawing) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} | Retrieve a drawing of a model
  *ModelApi* | [**get_drawings**](docs/ModelApi.md#get_drawings) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing | Retrieve all drawings of a model
  *ModelApi* | [**get_element**](docs/ModelApi.md#get_element) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Retrieve an element of a model
  *ModelApi* | [**get_element_linked_documents**](docs/ModelApi.md#get_element_linked_documents) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/documents | Retrieve all documents linked to any element
  *ModelApi* | [**get_element_property_set**](docs/ModelApi.md#get_element_property_set) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{id} | Retrieve a PropertySet of an element
  *ModelApi* | [**get_element_property_set_properties**](docs/ModelApi.md#get_element_property_set_properties) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property | Retrieve all Properties of a PropertySet
  *ModelApi* | [**get_element_property_set_property**](docs/ModelApi.md#get_element_property_set_property) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Retrieve a Property of a PropertySet
  *ModelApi* | [**get_element_property_set_property_definition**](docs/ModelApi.md#get_element_property_set_property_definition) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id} | Retrieve a Definition of a Property
  *ModelApi* | [**get_element_property_set_property_definition_unit**](docs/ModelApi.md#get_element_property_set_property_definition_unit) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit/{id} | Retrieve a Unit of a Definition
  *ModelApi* | [**get_element_property_set_property_definition_units**](docs/ModelApi.md#get_element_property_set_property_definition_units) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit | Retrieve all Units of a Definition
  *ModelApi* | [**get_element_property_set_property_definitions**](docs/ModelApi.md#get_element_property_set_property_definitions) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition | Retrieve all Definitions of a PropertySet
  *ModelApi* | [**get_element_property_sets**](docs/ModelApi.md#get_element_property_sets) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset | Retrieve all PropertySets of an element
  *ModelApi* | [**get_elements**](docs/ModelApi.md#get_elements) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element | Retrieve all elements of a model
  *ModelApi* | [**get_elements_from_classification**](docs/ModelApi.md#get_elements_from_classification) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element | Retrieve all elements with the classification
  *ModelApi* | [**get_layer**](docs/ModelApi.md#get_layer) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Retrieve a layer of a model
  *ModelApi* | [**get_layers**](docs/ModelApi.md#get_layers) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer | Retrieve all layers of a model
  *ModelApi* | [**get_material**](docs/ModelApi.md#get_material) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/material/{id} | Retrieve a material of a model
  *ModelApi* | [**get_materials**](docs/ModelApi.md#get_materials) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/material | Retrieve all materials of a model
  *ModelApi* | [**get_model**](docs/ModelApi.md#get_model) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{id} | Retrieve one model
  *ModelApi* | [**get_model_classifications**](docs/ModelApi.md#get_model_classifications) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification | Retrieve all classifications in a model
  *ModelApi* | [**get_model_material**](docs/ModelApi.md#get_model_material) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/material/{id} | Retrieve a material of a model
  *ModelApi* | [**get_model_materials**](docs/ModelApi.md#get_model_materials) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/material | Retrieve all materials of a model
  *ModelApi* | [**get_model_properties**](docs/ModelApi.md#get_model_properties) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property | Retrieve all Properties of a model
  *ModelApi* | [**get_model_property**](docs/ModelApi.md#get_model_property) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} | Retrieve a Property of a model
  *ModelApi* | [**get_model_property_definition**](docs/ModelApi.md#get_model_property_definition) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} | Retrieve a PropertyDefinition of a model
  *ModelApi* | [**get_model_property_definitions**](docs/ModelApi.md#get_model_property_definitions) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition | Retrieve all PropertyDefinitions of a model
  *ModelApi* | [**get_model_unit**](docs/ModelApi.md#get_model_unit) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id} | Retrieve a Unit of a model
  *ModelApi* | [**get_model_units**](docs/ModelApi.md#get_model_units) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit | Retrieve all Units of a model
  *ModelApi* | [**get_models**](docs/ModelApi.md#get_models) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model | Retrieve all models
  *ModelApi* | [**get_processor_handler**](docs/ModelApi.md#get_processor_handler) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler/{id} | Retrieve a processor handler
  *ModelApi* | [**get_processor_handlers**](docs/ModelApi.md#get_processor_handlers) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler | Get all processor handlers
  *ModelApi* | [**get_property_set**](docs/ModelApi.md#get_property_set) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id} | Retrieve a PropertySet of a model
  *ModelApi* | [**get_property_sets**](docs/ModelApi.md#get_property_sets) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset | Retrieve all PropertySets of a model
  *ModelApi* | [**get_raw_elements**](docs/ModelApi.md#get_raw_elements) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/raw | Retrieve all elements in a optimized format
  *ModelApi* | [**get_simple_element**](docs/ModelApi.md#get_simple_element) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid}/simple | Retrieve an element of a model with a simple value representation
  *ModelApi* | [**get_simple_elements**](docs/ModelApi.md#get_simple_elements) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/simple | Retrieve all elements of a model with a simple value representation
  *ModelApi* | [**get_space**](docs/ModelApi.md#get_space) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id} | Retrieve one space of the model
  *ModelApi* | [**get_spaces**](docs/ModelApi.md#get_spaces) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space | Retrieve all spaces of the model
  *ModelApi* | [**get_storey**](docs/ModelApi.md#get_storey) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid} | Retrieve a storey of a model
  *ModelApi* | [**get_storey_plan_positioning**](docs/ModelApi.md#get_storey_plan_positioning) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id}/positioning | Retrieve the postioning of the plan in the storey
  *ModelApi* | [**get_storeys**](docs/ModelApi.md#get_storeys) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey | Retrieve all storeys of a model
  *ModelApi* | [**get_system**](docs/ModelApi.md#get_system) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} | Retrieve a system of a model
  *ModelApi* | [**get_systems**](docs/ModelApi.md#get_systems) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system | Retrieve all systems of a model
  *ModelApi* | [**get_tileset**](docs/ModelApi.md#get_tileset) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/tileset | Retrieve the tileset of the model
  *ModelApi* | [**get_zone**](docs/ModelApi.md#get_zone) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} | Retrieve one zone of a model
  *ModelApi* | [**get_zone_space**](docs/ModelApi.md#get_zone_space) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} | Retrieve one space of a zone
  *ModelApi* | [**get_zone_spaces**](docs/ModelApi.md#get_zone_spaces) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space | Retrieve all spaces of a zone
  *ModelApi* | [**get_zones**](docs/ModelApi.md#get_zones) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone | Retrieve zones of a model
  *ModelApi* | [**link_documents_of_element**](docs/ModelApi.md#link_documents_of_element) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents | Link one or many documents to an element
  *ModelApi* | [**list_classification_element_relations**](docs/ModelApi.md#list_classification_element_relations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification-element | List all associations between classifications and elements
  *ModelApi* | [**merge_ifcs**](docs/ModelApi.md#merge_ifcs) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/merge | Merge IFC files
  *ModelApi* | [**optimize_ifc**](docs/ModelApi.md#optimize_ifc) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/optimize | Optimize the IFC
  *ModelApi* | [**remove_all_element_property_set**](docs/ModelApi.md#remove_all_element_property_set) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/all | Remove all property sets from element
  *ModelApi* | [**remove_classification_of_element**](docs/ModelApi.md#remove_classification_of_element) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification/{id} | Remove a classification from an element
  *ModelApi* | [**remove_document_of_element**](docs/ModelApi.md#remove_document_of_element) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents/{id} | Remove a documents from an element
  *ModelApi* | [**remove_element_property_set**](docs/ModelApi.md#remove_element_property_set) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{id} | Remove a PropertySet from an element
  *ModelApi* | [**remove_element_property_set_property**](docs/ModelApi.md#remove_element_property_set_property) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Remove a property from a PropertySet
  *ModelApi* | [**remove_element_property_set_property_definition**](docs/ModelApi.md#remove_element_property_set_property_definition) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id} | Delete a Definition to a Property
  *ModelApi* | [**remove_element_property_set_property_definition_unit**](docs/ModelApi.md#remove_element_property_set_property_definition_unit) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit/{id} | Remove a Unit from a Definition
  *ModelApi* | [**remove_elements_from_classification**](docs/ModelApi.md#remove_elements_from_classification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element/{uuid} | Remove the classification from all elements
  *ModelApi* | [**reprocess_model**](docs/ModelApi.md#reprocess_model) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/reprocess | Reprocess Model file
  *ModelApi* | [**update_access_token**](docs/ModelApi.md#update_access_token) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token} | Update some fields of a token
  *ModelApi* | [**update_building**](docs/ModelApi.md#update_building) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid} | Update some fields of a building
  *ModelApi* | [**update_building_plan_positioning**](docs/ModelApi.md#update_building_plan_positioning) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id}/positioning | Update the postioning of the plan in the building
  *ModelApi* | [**update_drawing**](docs/ModelApi.md#update_drawing) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} | Update some fields of a drawing
  *ModelApi* | [**update_element**](docs/ModelApi.md#update_element) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Update some fields of an element
  *ModelApi* | [**update_element_property_set_property**](docs/ModelApi.md#update_element_property_set_property) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Update a property from an element
  *ModelApi* | [**update_layer**](docs/ModelApi.md#update_layer) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Update some fields of a layer
  *ModelApi* | [**update_model**](docs/ModelApi.md#update_model) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{id} | Update some fields of a model
  *ModelApi* | [**update_model_files**](docs/ModelApi.md#update_model_files) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/files | Update models file (gltf, svg, structure, etc)
  *ModelApi* | [**update_model_property**](docs/ModelApi.md#update_model_property) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} | Update some fields of a Property
  *ModelApi* | [**update_model_property_definition**](docs/ModelApi.md#update_model_property_definition) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} | Update some fields of many PropertyDefinitions of a model
  *ModelApi* | [**update_model_unit**](docs/ModelApi.md#update_model_unit) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id} | Update some fields of a Unit of a model
  *ModelApi* | [**update_order_building_plan**](docs/ModelApi.md#update_order_building_plan) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/order | Update order of all plan of a building
  *ModelApi* | [**update_order_storey_plan**](docs/ModelApi.md#update_order_storey_plan) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/order | Update order of all plan of a storey
  *ModelApi* | [**update_order_storeys**](docs/ModelApi.md#update_order_storeys) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/order | Update order of all storey of a model
  *ModelApi* | [**update_processor_handler**](docs/ModelApi.md#update_processor_handler) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler/{id} | Update the status of a processor handler
  *ModelApi* | [**update_property_set**](docs/ModelApi.md#update_property_set) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id} | Update some fields of a PropertySet
  *ModelApi* | [**update_space**](docs/ModelApi.md#update_space) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id} | Update some fields of a space
  *ModelApi* | [**update_storey**](docs/ModelApi.md#update_storey) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid} | Update some fields of a storey
  *ModelApi* | [**update_storey_plan_positioning**](docs/ModelApi.md#update_storey_plan_positioning) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id}/positioning | Update the postioning of the plan in the storey
  *ModelApi* | [**update_system**](docs/ModelApi.md#update_system) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} | Update some fields of a system
  *ModelApi* | [**update_zone**](docs/ModelApi.md#update_zone) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} | Update some fields of a zone
  *ModelApi* | [**update_zone_space**](docs/ModelApi.md#update_zone_space) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} | Update some fields of a space
  *SsoApi* | [**accept_invitation**](docs/SsoApi.md#accept_invitation) | **POST** /identity-provider/invitation/{id}/accept | Accept an invitation
  *SsoApi* | [**create_user**](docs/SsoApi.md#create_user) | **POST** /identity-provider/user | Create a user
  *SsoApi* | [**delete_user**](docs/SsoApi.md#delete_user) | **DELETE** /identity-provider/user | Delete user from BIMData
  *SsoApi* | [**deny_invitation**](docs/SsoApi.md#deny_invitation) | **POST** /identity-provider/invitation/{id}/deny | Deny an invitation
  *SsoApi* | [**get_invitation**](docs/SsoApi.md#get_invitation) | **GET** /identity-provider/invitation/{id} | Retrieve an invitation
  *SsoApi* | [**get_invitations**](docs/SsoApi.md#get_invitations) | **GET** /identity-provider/invitation | Retrieve all invitations
  *WebhookApi* | [**create_web_hook**](docs/WebhookApi.md#create_web_hook) | **POST** /cloud/{cloud_pk}/webhook | Create a new Webhook
  *WebhookApi* | [**delete_web_hook**](docs/WebhookApi.md#delete_web_hook) | **DELETE** /cloud/{cloud_pk}/webhook/{id} | Delete a webhook
  *WebhookApi* | [**get_web_hook**](docs/WebhookApi.md#get_web_hook) | **GET** /cloud/{cloud_pk}/webhook/{id} | Retrieve one configured webhook
  *WebhookApi* | [**get_web_hooks**](docs/WebhookApi.md#get_web_hooks) | **GET** /cloud/{cloud_pk}/webhook | Retrieve all configured webhooks
  *WebhookApi* | [**ping_web_hook**](docs/WebhookApi.md#ping_web_hook) | **POST** /cloud/{cloud_pk}/webhook/{id}/ping | Test a webhook
  *WebhookApi* | [**update_web_hook**](docs/WebhookApi.md#update_web_hook) | **PATCH** /cloud/{cloud_pk}/webhook/{id} | Update some field of a webhook

   - [Auth](docs/Auth.md)
   - [BcfProject](docs/BcfProject.md)
   - [BcfProjectRequest](docs/BcfProjectRequest.md)
   - [Building](docs/Building.md)
   - [BuildingModelPlanRequest](docs/BuildingModelPlanRequest.md)
   - [CheckProjectAccess](docs/CheckProjectAccess.md)
   - [Classification](docs/Classification.md)
   - [ClassificationRequest](docs/ClassificationRequest.md)
   - [ClippingPlane](docs/ClippingPlane.md)
   - [ClippingPlaneRequest](docs/ClippingPlaneRequest.md)
   - [Cloud](docs/Cloud.md)
   - [CloudInvitation](docs/CloudInvitation.md)
   - [CloudInvitationRequest](docs/CloudInvitationRequest.md)
   - [CloudRequest](docs/CloudRequest.md)
   - [CloudRole](docs/CloudRole.md)
   - [Coloring](docs/Coloring.md)
   - [ColoringRequest](docs/ColoringRequest.md)
   - [Comment](docs/Comment.md)
   - [CommentRequest](docs/CommentRequest.md)
   - [Component](docs/Component.md)
   - [ComponentRequest](docs/ComponentRequest.md)
   - [ComponentsParent](docs/ComponentsParent.md)
   - [ComponentsParentRequest](docs/ComponentsParentRequest.md)
   - [CreateBuildingByNameRequest](docs/CreateBuildingByNameRequest.md)
   - [CreateModelRequest](docs/CreateModelRequest.md)
   - [CreateMultiPageModelRequest](docs/CreateMultiPageModelRequest.md)
   - [CreateUserRequest](docs/CreateUserRequest.md)
   - [DetailedExtensions](docs/DetailedExtensions.md)
   - [Direction](docs/Direction.md)
   - [DirectionRequest](docs/DirectionRequest.md)
   - [Document](docs/Document.md)
   - [DocumentPreviewFile](docs/DocumentPreviewFile.md)
   - [DocumentWithElementList](docs/DocumentWithElementList.md)
   - [Drawing](docs/Drawing.md)
   - [DrawingRequest](docs/DrawingRequest.md)
   - [Element](docs/Element.md)
   - [ElementClassificationRelation](docs/ElementClassificationRelation.md)
   - [ElementClassificationRelationRequest](docs/ElementClassificationRelationRequest.md)
   - [ElementPropertySetRelationRequest](docs/ElementPropertySetRelationRequest.md)
   - [ElementRequest](docs/ElementRequest.md)
   - [Extensions](docs/Extensions.md)
   - [Feature](docs/Feature.md)
   - [FeatureRequest](docs/FeatureRequest.md)
   - [Folder](docs/Folder.md)
   - [FolderTree](docs/FolderTree.md)
   - [FolderUserProject](docs/FolderUserProject.md)
   - [FolderWithoutChildren](docs/FolderWithoutChildren.md)
   - [FolderWithoutChildrenRequest](docs/FolderWithoutChildrenRequest.md)
   - [FullTopic](docs/FullTopic.md)
   - [FullTopicRequest](docs/FullTopicRequest.md)
   - [GeometryPoint](docs/GeometryPoint.md)
   - [GeometryPointRequest](docs/GeometryPointRequest.md)
   - [Group](docs/Group.md)
   - [GroupFolder](docs/GroupFolder.md)
   - [GroupFolderRead](docs/GroupFolderRead.md)
   - [GroupRequest](docs/GroupRequest.md)
   - [IfcAccessToken](docs/IfcAccessToken.md)
   - [IfcAccessTokenRequest](docs/IfcAccessTokenRequest.md)
   - [IfcExportRequest](docs/IfcExportRequest.md)
   - [IfcMergeRequest](docs/IfcMergeRequest.md)
   - [IfcOptimizeRequest](docs/IfcOptimizeRequest.md)
   - [ImportGroupRequest](docs/ImportGroupRequest.md)
   - [Invitation](docs/Invitation.md)
   - [Label](docs/Label.md)
   - [LabelRequest](docs/LabelRequest.md)
   - [Layer](docs/Layer.md)
   - [LayerElement](docs/LayerElement.md)
   - [LayerElementRequest](docs/LayerElementRequest.md)
   - [LayerRequest](docs/LayerRequest.md)
   - [LightDocument](docs/LightDocument.md)
   - [Line](docs/Line.md)
   - [LineRequest](docs/LineRequest.md)
   - [LogEntry](docs/LogEntry.md)
   - [MarketplaceAppImage](docs/MarketplaceAppImage.md)
   - [MarketplaceAppLight](docs/MarketplaceAppLight.md)
   - [MarketplaceAppLightRequest](docs/MarketplaceAppLightRequest.md)
   - [Material](docs/Material.md)
   - [MaterialListComponent](docs/MaterialListComponent.md)
   - [MaterialListComponentRequest](docs/MaterialListComponentRequest.md)
   - [MaterialOption](docs/MaterialOption.md)
   - [MaterialRequest](docs/MaterialRequest.md)
   - [Model](docs/Model.md)
   - [ModelErrors](docs/ModelErrors.md)
   - [ModelErrorsRequest](docs/ModelErrorsRequest.md)
   - [ModelFiles](docs/ModelFiles.md)
   - [ModelProperty](docs/ModelProperty.md)
   - [ModelSerializerWithoutChildren](docs/ModelSerializerWithoutChildren.md)
   - [ModelWithPositioningPlan](docs/ModelWithPositioningPlan.md)
   - [Organization](docs/Organization.md)
   - [OrganizationRequest](docs/OrganizationRequest.md)
   - [OrthogonalCamera](docs/OrthogonalCamera.md)
   - [OrthogonalCameraRequest](docs/OrthogonalCameraRequest.md)
   - [PatchedBcfProjectRequest](docs/PatchedBcfProjectRequest.md)
   - [PatchedClassificationRequest](docs/PatchedClassificationRequest.md)
   - [PatchedCloudRequest](docs/PatchedCloudRequest.md)
   - [PatchedCommentRequest](docs/PatchedCommentRequest.md)
   - [PatchedDocumentRequest](docs/PatchedDocumentRequest.md)
   - [PatchedDrawingRequest](docs/PatchedDrawingRequest.md)
   - [PatchedElementRequest](docs/PatchedElementRequest.md)
   - [PatchedFolderWithoutChildrenRequest](docs/PatchedFolderWithoutChildrenRequest.md)
   - [PatchedFullTopicRequest](docs/PatchedFullTopicRequest.md)
   - [PatchedGroupFolderRequest](docs/PatchedGroupFolderRequest.md)
   - [PatchedGroupRequest](docs/PatchedGroupRequest.md)
   - [PatchedIfcAccessTokenRequest](docs/PatchedIfcAccessTokenRequest.md)
   - [PatchedLabelRequest](docs/PatchedLabelRequest.md)
   - [PatchedLayerRequest](docs/PatchedLayerRequest.md)
   - [PatchedModelRequest](docs/PatchedModelRequest.md)
   - [PatchedPinRequest](docs/PatchedPinRequest.md)
   - [PatchedPositioningPlanRequest](docs/PatchedPositioningPlanRequest.md)
   - [PatchedPriorityRequest](docs/PatchedPriorityRequest.md)
   - [PatchedProcessorHandlerRequest](docs/PatchedProcessorHandlerRequest.md)
   - [PatchedProjectRequest](docs/PatchedProjectRequest.md)
   - [PatchedPropertyDefinitionRequest](docs/PatchedPropertyDefinitionRequest.md)
   - [PatchedPropertyRequest](docs/PatchedPropertyRequest.md)
   - [PatchedPropertySetRequest](docs/PatchedPropertySetRequest.md)
   - [PatchedSpaceRequest](docs/PatchedSpaceRequest.md)
   - [PatchedStageRequest](docs/PatchedStageRequest.md)
   - [PatchedStoreyBuildingRequest](docs/PatchedStoreyBuildingRequest.md)
   - [PatchedSystemRequest](docs/PatchedSystemRequest.md)
   - [PatchedTagRequest](docs/PatchedTagRequest.md)
   - [PatchedTopicRequest](docs/PatchedTopicRequest.md)
   - [PatchedTopicStatusRequest](docs/PatchedTopicStatusRequest.md)
   - [PatchedTopicTypeRequest](docs/PatchedTopicTypeRequest.md)
   - [PatchedUnitRequest](docs/PatchedUnitRequest.md)
   - [PatchedUserCloudUpdateRequest](docs/PatchedUserCloudUpdateRequest.md)
   - [PatchedUserProjectUpdateRequest](docs/PatchedUserProjectUpdateRequest.md)
   - [PatchedViewpointRequest](docs/PatchedViewpointRequest.md)
   - [PatchedVisaCommentRequest](docs/PatchedVisaCommentRequest.md)
   - [PatchedVisaRequest](docs/PatchedVisaRequest.md)
   - [PatchedVisaValidationRequest](docs/PatchedVisaValidationRequest.md)
   - [PatchedWebHookRequest](docs/PatchedWebHookRequest.md)
   - [PatchedZoneRequest](docs/PatchedZoneRequest.md)
   - [PatchedZoneSpaceRequest](docs/PatchedZoneSpaceRequest.md)
   - [PerspectiveCamera](docs/PerspectiveCamera.md)
   - [PerspectiveCameraRequest](docs/PerspectiveCameraRequest.md)
   - [Pin](docs/Pin.md)
   - [PinRequest](docs/PinRequest.md)
   - [Point](docs/Point.md)
   - [PointRequest](docs/PointRequest.md)
   - [PositioningPlan](docs/PositioningPlan.md)
   - [Priority](docs/Priority.md)
   - [PriorityRequest](docs/PriorityRequest.md)
   - [ProcessorHandler](docs/ProcessorHandler.md)
   - [Project](docs/Project.md)
   - [ProjectAccessToken](docs/ProjectAccessToken.md)
   - [ProjectAccessTokenRequest](docs/ProjectAccessTokenRequest.md)
   - [ProjectImportRequest](docs/ProjectImportRequest.md)
   - [ProjectInvitation](docs/ProjectInvitation.md)
   - [ProjectInvitationRequest](docs/ProjectInvitationRequest.md)
   - [ProjectRequest](docs/ProjectRequest.md)
   - [ProjectRole](docs/ProjectRole.md)
   - [ProjectSize](docs/ProjectSize.md)
   - [ProjectWithChildren](docs/ProjectWithChildren.md)
   - [PropertyDefinition](docs/PropertyDefinition.md)
   - [PropertyDefinitionRequest](docs/PropertyDefinitionRequest.md)
   - [PropertyRequest](docs/PropertyRequest.md)
   - [PropertySet](docs/PropertySet.md)
   - [PropertySetRequest](docs/PropertySetRequest.md)
   - [PublicOrganization](docs/PublicOrganization.md)
   - [PublicOrganizationRequest](docs/PublicOrganizationRequest.md)
   - [RawClassification](docs/RawClassification.md)
   - [RawClassificationRequest](docs/RawClassificationRequest.md)
   - [RawDefinition](docs/RawDefinition.md)
   - [RawDefinitionRequest](docs/RawDefinitionRequest.md)
   - [RawElement](docs/RawElement.md)
   - [RawElementRequest](docs/RawElementRequest.md)
   - [RawElements](docs/RawElements.md)
   - [RawElementsRequest](docs/RawElementsRequest.md)
   - [RawLayer](docs/RawLayer.md)
   - [RawLayerRequest](docs/RawLayerRequest.md)
   - [RawMaterial](docs/RawMaterial.md)
   - [RawMaterialList](docs/RawMaterialList.md)
   - [RawMaterialListComponents](docs/RawMaterialListComponents.md)
   - [RawMaterialListComponentsRequest](docs/RawMaterialListComponentsRequest.md)
   - [RawMaterialListRequest](docs/RawMaterialListRequest.md)
   - [RawMaterialOptions](docs/RawMaterialOptions.md)
   - [RawMaterialOptionsRequest](docs/RawMaterialOptionsRequest.md)
   - [RawMaterialRequest](docs/RawMaterialRequest.md)
   - [RawProperty](docs/RawProperty.md)
   - [RawPropertyRequest](docs/RawPropertyRequest.md)
   - [RawPropertySet](docs/RawPropertySet.md)
   - [RawPropertySetRequest](docs/RawPropertySetRequest.md)
   - [RawSystem](docs/RawSystem.md)
   - [RawSystemRequest](docs/RawSystemRequest.md)
   - [RawUnit](docs/RawUnit.md)
   - [RawUnitRequest](docs/RawUnitRequest.md)
   - [RecursiveFolderChildren](docs/RecursiveFolderChildren.md)
   - [SelectUserRequest](docs/SelectUserRequest.md)
   - [SelfBcfUser](docs/SelfBcfUser.md)
   - [SelfUser](docs/SelfUser.md)
   - [ShortUser](docs/ShortUser.md)
   - [SimpleElement](docs/SimpleElement.md)
   - [Size](docs/Size.md)
   - [Snapshot](docs/Snapshot.md)
   - [SnapshotRequest](docs/SnapshotRequest.md)
   - [Space](docs/Space.md)
   - [SpaceRequest](docs/SpaceRequest.md)
   - [Stage](docs/Stage.md)
   - [StageRequest](docs/StageRequest.md)
   - [Storey](docs/Storey.md)
   - [StoreyBuildingRequest](docs/StoreyBuildingRequest.md)
   - [StoreyModelPlanRequest](docs/StoreyModelPlanRequest.md)
   - [System](docs/System.md)
   - [SystemRequest](docs/SystemRequest.md)
   - [Tag](docs/Tag.md)
   - [TagIdRequest](docs/TagIdRequest.md)
   - [TagRequest](docs/TagRequest.md)
   - [Topic](docs/Topic.md)
   - [TopicRequest](docs/TopicRequest.md)
   - [TopicStatus](docs/TopicStatus.md)
   - [TopicStatusRequest](docs/TopicStatusRequest.md)
   - [TopicType](docs/TopicType.md)
   - [TopicTypeRequest](docs/TopicTypeRequest.md)
   - [Unit](docs/Unit.md)
   - [UnitRequest](docs/UnitRequest.md)
   - [User](docs/User.md)
   - [UserInvitation](docs/UserInvitation.md)
   - [UserProject](docs/UserProject.md)
   - [UserProjectIdRequest](docs/UserProjectIdRequest.md)
   - [Version](docs/Version.md)
   - [ViewSetupHints](docs/ViewSetupHints.md)
   - [ViewSetupHintsRequest](docs/ViewSetupHintsRequest.md)
   - [Viewpoint](docs/Viewpoint.md)
   - [ViewpointRequest](docs/ViewpointRequest.md)
   - [Visa](docs/Visa.md)
   - [VisaAttachment](docs/VisaAttachment.md)
   - [VisaAttachmentRequest](docs/VisaAttachmentRequest.md)
   - [VisaComment](docs/VisaComment.md)
   - [VisaCommentRequest](docs/VisaCommentRequest.md)
   - [VisaRequest](docs/VisaRequest.md)
   - [VisaValidation](docs/VisaValidation.md)
   - [VisaValidationRequest](docs/VisaValidationRequest.md)
   - [VisaWithDocument](docs/VisaWithDocument.md)
   - [Visibility](docs/Visibility.md)
   - [VisibilityRequest](docs/VisibilityRequest.md)
   - [WebHook](docs/WebHook.md)
   - [WebHookRequest](docs/WebHookRequest.md)
   - [WriteFolderRequest](docs/WriteFolderRequest.md)
   - [XktFile](docs/XktFile.md)
   - [Zone](docs/Zone.md)
   - [ZoneRequest](docs/ZoneRequest.md)
   - [ZoneSpace](docs/ZoneSpace.md)
   - [ZoneSpaceRelationRequest](docs/ZoneSpaceRelationRequest.md)
   - [ZoneSpaceRequest](docs/ZoneSpaceRequest.md)


  - **Type**: API key
  - **API key parameter name**: Authorization
  - **Location**: HTTP header

  - **Type**: OAuth
  - **Flow**: implicit
  - **Authorization URL**: http://fakeurl.bimdata.example/realms/bimdata/protocol/openid-connect/auth
  - **Scopes**: N/A

  - **Type**: OAuth
  - **Flow**: application
  - **Authorization URL**:
  - **Scopes**: N/A

  - **Type**: API key
  - **API key parameter name**: Authorization
  - **Location**: HTTP header

  support@bimdata.io

  If the OpenAPI document is large, imports in bimdata_api_client.apis and bimdata_api_client.models may fail with a
  RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
  Solution 1:
  Use specific imports for apis and models like:
  - `from bimdata_api_client.api.default_api import DefaultApi`
  - `from bimdata_api_client.model.pet import Pet`
  Solution 2:
  Before importing the package, adjust the maximum recursion limit as shown below:
  ```
  import sys
  sys.setrecursionlimit(1500)
  import bimdata_api_client
  from bimdata_api_client.apis import *
  from bimdata_api_client.models import *
  ```


pkgId: 41e3ecdff5498e909f23cc061087982b8512f457c8938566adc78dadc7d8052e
name: python-bimdata-api-client
arch: src
version: 10.9.1
epoch: 0
release: 1
summary: BIMData API
url: https://github.com/bimdata/python-api-client
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bimdata-api-client-10.9.1-1.src.rpm
checksum_type: sha256
description:
  *BcfApi* | [**create_comment**](docs/BcfApi.md#create_comment) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments | Create a comment
  *BcfApi* | [**create_extension_label**](docs/BcfApi.md#create_extension_label) | **POST** /bcf/2.1/projects/{projects_pk}/extension/label | Create a Label
  *BcfApi* | [**create_extension_priority**](docs/BcfApi.md#create_extension_priority) | **POST** /bcf/2.1/projects/{projects_pk}/extension/priority | Create a Priority
  *BcfApi* | [**create_extension_stage**](docs/BcfApi.md#create_extension_stage) | **POST** /bcf/2.1/projects/{projects_pk}/extension/stage | Create a Stage
  *BcfApi* | [**create_extension_status**](docs/BcfApi.md#create_extension_status) | **POST** /bcf/2.1/projects/{projects_pk}/extension/status | Create a TopicStatus
  *BcfApi* | [**create_extension_type**](docs/BcfApi.md#create_extension_type) | **POST** /bcf/2.1/projects/{projects_pk}/extension/type | Create a TopicType
  *BcfApi* | [**create_full_topic**](docs/BcfApi.md#create_full_topic) | **POST** /bcf/2.1/projects/{projects_pk}/full-topic | Create a Topic with viewpoints and comments
  *BcfApi* | [**create_pin**](docs/BcfApi.md#create_pin) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin | Create a Pin
  *BcfApi* | [**create_topic**](docs/BcfApi.md#create_topic) | **POST** /bcf/2.1/projects/{projects_pk}/topics | Create a topic
  *BcfApi* | [**create_viewpoint**](docs/BcfApi.md#create_viewpoint) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints | Create a Viewpoint
  *BcfApi* | [**delete_comment**](docs/BcfApi.md#delete_comment) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Delete a comment
  *BcfApi* | [**delete_extension_label**](docs/BcfApi.md#delete_extension_label) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/label/{id} | Delete a Label
  *BcfApi* | [**delete_extension_priority**](docs/BcfApi.md#delete_extension_priority) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/priority/{id} | Delete a Priority
  *BcfApi* | [**delete_extension_stage**](docs/BcfApi.md#delete_extension_stage) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/stage/{id} | Delete a Stage
  *BcfApi* | [**delete_extension_status**](docs/BcfApi.md#delete_extension_status) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/status/{id} | Delete a TopicStatus
  *BcfApi* | [**delete_extension_type**](docs/BcfApi.md#delete_extension_type) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/type/{id} | Delete a TopicType
  *BcfApi* | [**delete_pin**](docs/BcfApi.md#delete_pin) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Delete a Pin
  *BcfApi* | [**delete_topic**](docs/BcfApi.md#delete_topic) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Delete a topic
  *BcfApi* | [**delete_viewpoint**](docs/BcfApi.md#delete_viewpoint) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Delete a Viewpoint
  *BcfApi* | [**download_bcf_export**](docs/BcfApi.md#download_bcf_export) | **GET** /bcf/2.1/projects/{id}/export | Export project&#39;s topics in bcf-xml format
  *BcfApi* | [**download_bcf_export_xlsx**](docs/BcfApi.md#download_bcf_export_xlsx) | **GET** /bcf/2.1/projects/{id}/export-xlsx | Export project&#39;s topics in excel format
  *BcfApi* | [**full_update_bcf_project**](docs/BcfApi.md#full_update_bcf_project) | **PUT** /bcf/2.1/projects/{id} | Update all fields of a BCF project
  *BcfApi* | [**full_update_comment**](docs/BcfApi.md#full_update_comment) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Update all fields of a comment
  *BcfApi* | [**full_update_full_topic**](docs/BcfApi.md#full_update_full_topic) | **PUT** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Update all fields of a topic
  *BcfApi* | [**full_update_pin**](docs/BcfApi.md#full_update_pin) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Update all fields of a Pin
  *BcfApi* | [**full_update_topic**](docs/BcfApi.md#full_update_topic) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Update all fields of a topic
  *BcfApi* | [**get_auth**](docs/BcfApi.md#get_auth) | **GET** /bcf/2.1/auth | Retrieve Authentication Information
  *BcfApi* | [**get_bcf_project**](docs/BcfApi.md#get_bcf_project) | **GET** /bcf/2.1/projects/{id} | Retrieve a BCF project
  *BcfApi* | [**get_bcf_projects**](docs/BcfApi.md#get_bcf_projects) | **GET** /bcf/2.1/projects | Retrieve all BCF projects
  *BcfApi* | [**get_colorings**](docs/BcfApi.md#get_colorings) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/coloring | Retrieve all colorings of a viewpoint
  *BcfApi* | [**get_comment**](docs/BcfApi.md#get_comment) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Retrieve a comment
  *BcfApi* | [**get_comments**](docs/BcfApi.md#get_comments) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments | Retrieve all comments
  *BcfApi* | [**get_detailed_extensions**](docs/BcfApi.md#get_detailed_extensions) | **GET** /bcf/2.1/projects/{id}/detailed-extensions | Retrieve project detailed extensions
  *BcfApi* | [**get_extensions**](docs/BcfApi.md#get_extensions) | **GET** /bcf/2.1/projects/{id}/extensions | Retrieve project extensions
  *BcfApi* | [**get_full_topic**](docs/BcfApi.md#get_full_topic) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Retrieve a full topic
  *BcfApi* | [**get_full_topics**](docs/BcfApi.md#get_full_topics) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic | Retrieve all full topics
  *BcfApi* | [**get_pins**](docs/BcfApi.md#get_pins) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin | Retrieve all Pins of a viewpoint
  *BcfApi* | [**get_related_topics**](docs/BcfApi.md#get_related_topics) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/related_topics | Get all related topics
  *BcfApi* | [**get_selections**](docs/BcfApi.md#get_selections) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/selection | Retrieve all selections of a viewpoint
  *BcfApi* | [**get_snapshot**](docs/BcfApi.md#get_snapshot) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/snapshot | Retrieve the viewpoint&#39; snapshot
  *BcfApi* | [**get_topic**](docs/BcfApi.md#get_topic) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Retrieve a topic
  *BcfApi* | [**get_topic_document_references**](docs/BcfApi.md#get_topic_document_references) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references | Get all related documents
  *BcfApi* | [**get_topic_viewpoints**](docs/BcfApi.md#get_topic_viewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints | Retrieve all viewpoints attached to the topic
  *BcfApi* | [**get_topics**](docs/BcfApi.md#get_topics) | **GET** /bcf/2.1/projects/{projects_pk}/topics | Retrieve all topics
  *BcfApi* | [**get_user**](docs/BcfApi.md#get_user) | **GET** /bcf/2.1/current-user | Get current user info
  *BcfApi* | [**get_versions**](docs/BcfApi.md#get_versions) | **GET** /bcf/versions | Retrieve all supported BCF versions by this API
  *BcfApi* | [**get_viewpoin_pin**](docs/BcfApi.md#get_viewpoin_pin) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Retrieve a Pin
  *BcfApi* | [**get_viewpoint**](docs/BcfApi.md#get_viewpoint) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Retrieve a Viewpoint
  *BcfApi* | [**get_viewpoints**](docs/BcfApi.md#get_viewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints | Retrieve all Viewpoints of a topic
  *BcfApi* | [**get_visibilities**](docs/BcfApi.md#get_visibilities) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/visibility | Retrieve all visibilities of a viewpoint
  *BcfApi* | [**import_bcf**](docs/BcfApi.md#import_bcf) | **POST** /bcf/2.1/projects/{id}/import | Import bcf-xml format into this project
  *BcfApi* | [**update_bcf_project**](docs/BcfApi.md#update_bcf_project) | **PATCH** /bcf/2.1/projects/{id} | Update some fields of a BCF project
  *BcfApi* | [**update_comment**](docs/BcfApi.md#update_comment) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Update some fields of a comment
  *BcfApi* | [**update_extension_label**](docs/BcfApi.md#update_extension_label) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/label/{id} | Update a Label
  *BcfApi* | [**update_extension_priority**](docs/BcfApi.md#update_extension_priority) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/priority/{id} | Update a Priority
  *BcfApi* | [**update_extension_stage**](docs/BcfApi.md#update_extension_stage) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/stage/{id} | Update a Stage
  *BcfApi* | [**update_extension_status**](docs/BcfApi.md#update_extension_status) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/status/{id} | Update a TopicStatus
  *BcfApi* | [**update_extension_type**](docs/BcfApi.md#update_extension_type) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/type/{id} | Update a TopicType
  *BcfApi* | [**update_full_topic**](docs/BcfApi.md#update_full_topic) | **PATCH** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Update some fields of a topic
  *BcfApi* | [**update_pin**](docs/BcfApi.md#update_pin) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Update some fields of a Pin
  *BcfApi* | [**update_topic**](docs/BcfApi.md#update_topic) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Update some fields of a topic
  *BcfApi* | [**update_viewpoint**](docs/BcfApi.md#update_viewpoint) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Update some fields of a Viewpoint
  *CollaborationApi* | [**accept_user_invitation**](docs/CollaborationApi.md#accept_user_invitation) | **POST** /user/invitations/{id}/accept | Accept an invitation
  *CollaborationApi* | [**accept_validation**](docs/CollaborationApi.md#accept_validation) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/accept | Accept a validation
  *CollaborationApi* | [**add_document_tag**](docs/CollaborationApi.md#add_document_tag) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/tag | Add a tag to a document
  *CollaborationApi* | [**add_group_member**](docs/CollaborationApi.md#add_group_member) | **POST** /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/member | Add a user to a group
  *CollaborationApi* | [**cancel_cloud_user_invitation**](docs/CollaborationApi.md#cancel_cloud_user_invitation) | **DELETE** /cloud/{cloud_pk}/invitation/{id} | Cancel a pending invitation
  *CollaborationApi* | [**cancel_project_user_invitation**](docs/CollaborationApi.md#cancel_project_user_invitation) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/invitation/{id} | Cancel a pending invitation
  *CollaborationApi* | [**check_access**](docs/CollaborationApi.md#check_access) | **GET** /cloud/{id}/check-access | Check app access from cloud
  *CollaborationApi* | [**check_project_access**](docs/CollaborationApi.md#check_project_access) | **GET** /cloud/{cloud_pk}/project/{id}/check-access | Check if the current token has access to the requested project
  *CollaborationApi* | [**close_visa**](docs/CollaborationApi.md#close_visa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/close | Close a visa of a document
  *CollaborationApi* | [**create_classification**](docs/CollaborationApi.md#create_classification) | **POST** /cloud/{cloud_pk}/project/{project_pk}/classification | Create a classification
  *CollaborationApi* | [**create_cloud**](docs/CollaborationApi.md#create_cloud) | **POST** /cloud | Create a cloud
  *CollaborationApi* | [**create_demo**](docs/CollaborationApi.md#create_demo) | **POST** /cloud/{id}/create-demo | Create a Demo project in a cloud
  *CollaborationApi* | [**create_dms_tree**](docs/CollaborationApi.md#create_dms_tree) | **POST** /cloud/{cloud_pk}/project/{id}/dms-tree | Create a complete DMS tree
  *CollaborationApi* | [**create_document**](docs/CollaborationApi.md#create_document) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document | Create a document
  *CollaborationApi* | [**create_folder**](docs/CollaborationApi.md#create_folder) | **POST** /cloud/{cloud_pk}/project/{project_pk}/folder | Create a folder
  *CollaborationApi* | [**create_manage_group**](docs/CollaborationApi.md#create_manage_group) | **POST** /cloud/{cloud_pk}/project/{project_pk}/group | Create a group
  *CollaborationApi* | [**create_project**](docs/CollaborationApi.md#create_project) | **POST** /cloud/{cloud_pk}/project | Create a project
  *CollaborationApi* | [**create_project_access_token**](docs/CollaborationApi.md#create_project_access_token) | **POST** /cloud/{cloud_pk}/project/{project_pk}/access-token | Create a token for this project
  *CollaborationApi* | [**create_tag**](docs/CollaborationApi.md#create_tag) | **POST** /cloud/{cloud_pk}/project/{project_pk}/tag | Create a tag
  *CollaborationApi* | [**create_validation**](docs/CollaborationApi.md#create_validation) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation | Add a validation to a visa
  *CollaborationApi* | [**create_visa**](docs/CollaborationApi.md#create_visa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa | Create a visa
  *CollaborationApi* | [**create_visa_comment**](docs/CollaborationApi.md#create_visa_comment) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment | Add a comment
  *CollaborationApi* | [**delete_all_document_history**](docs/CollaborationApi.md#delete_all_document_history) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/delete | Delete all document history
  *CollaborationApi* | [**delete_classification**](docs/CollaborationApi.md#delete_classification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Delete a classification
  *CollaborationApi* | [**delete_cloud**](docs/CollaborationApi.md#delete_cloud) | **DELETE** /cloud/{id} | Delete a cloud
  *CollaborationApi* | [**delete_cloud_user**](docs/CollaborationApi.md#delete_cloud_user) | **DELETE** /cloud/{cloud_pk}/user/{id} | Remove a user from a cloud
  *CollaborationApi* | [**delete_document**](docs/CollaborationApi.md#delete_document) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Delete the document
  *CollaborationApi* | [**delete_document_tag**](docs/CollaborationApi.md#delete_document_tag) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/tag/{id} | Delete a tag from a document
  *CollaborationApi* | [**delete_folder**](docs/CollaborationApi.md#delete_folder) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Delete a folder
  *CollaborationApi* | [**delete_group_member**](docs/CollaborationApi.md#delete_group_member) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/member/{id} | Delete a user from a group
  *CollaborationApi* | [**delete_manage_group**](docs/CollaborationApi.md#delete_manage_group) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/group/{id} | Delete a group
  *CollaborationApi* | [**delete_project**](docs/CollaborationApi.md#delete_project) | **DELETE** /cloud/{cloud_pk}/project/{id} | Delete a project
  *CollaborationApi* | [**delete_project_access_token**](docs/CollaborationApi.md#delete_project_access_token) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} | Delete a token
  *CollaborationApi* | [**delete_project_user**](docs/CollaborationApi.md#delete_project_user) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Remove a user from a project
  *CollaborationApi* | [**delete_tag**](docs/CollaborationApi.md#delete_tag) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/tag/{id} | Delete the tag
  *CollaborationApi* | [**delete_validation**](docs/CollaborationApi.md#delete_validation) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id} | Remove a validation
  *CollaborationApi* | [**delete_visa**](docs/CollaborationApi.md#delete_visa) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id} | Remove a visa
  *CollaborationApi* | [**delete_visa_comment**](docs/CollaborationApi.md#delete_visa_comment) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} | Remove a comment
  *CollaborationApi* | [**deny_user_invitation**](docs/CollaborationApi.md#deny_user_invitation) | **POST** /user/invitations/{id}/deny | Deny an invitation
  *CollaborationApi* | [**deny_validation**](docs/CollaborationApi.md#deny_validation) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/deny | Deny a validation
  *CollaborationApi* | [**get_classification**](docs/CollaborationApi.md#get_classification) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Retrieve a classification
  *CollaborationApi* | [**get_classifications**](docs/CollaborationApi.md#get_classifications) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification | Retrieve all classifications
  *CollaborationApi* | [**get_cloud**](docs/CollaborationApi.md#get_cloud) | **GET** /cloud/{id} | Retrieve one cloud
  *CollaborationApi* | [**get_cloud_invitations**](docs/CollaborationApi.md#get_cloud_invitations) | **GET** /cloud/{cloud_pk}/invitation | Retrieve all pending invitations in the cloud
  *CollaborationApi* | [**get_cloud_size**](docs/CollaborationApi.md#get_cloud_size) | **GET** /cloud/{id}/size | Get size of the cloud
  *CollaborationApi* | [**get_cloud_user**](docs/CollaborationApi.md#get_cloud_user) | **GET** /cloud/{cloud_pk}/user/{id} | Retrieve a user in a cloud
  *CollaborationApi* | [**get_cloud_users**](docs/CollaborationApi.md#get_cloud_users) | **GET** /cloud/{cloud_pk}/user | Retrieve all users in a cloud, or a list with a filter by email
  *CollaborationApi* | [**get_clouds**](docs/CollaborationApi.md#get_clouds) | **GET** /cloud | Retrieve all clouds
  *CollaborationApi* | [**get_document**](docs/CollaborationApi.md#get_document) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Retrieve a document
  *CollaborationApi* | [**get_document_histories**](docs/CollaborationApi.md#get_document_histories) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history | Retrieve all document histories
  *CollaborationApi* | [**get_documents**](docs/CollaborationApi.md#get_documents) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document | Retrieve all documents
  *CollaborationApi* | [**get_folder**](docs/CollaborationApi.md#get_folder) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Retrieve a folder
  *CollaborationApi* | [**get_folder_documents**](docs/CollaborationApi.md#get_folder_documents) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/document | Get all documents of a folder
  *CollaborationApi* | [**get_folder_project_users**](docs/CollaborationApi.md#get_folder_project_users) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/user | Retrieve all users in a project with the permission on the folder
  *CollaborationApi* | [**get_folders**](docs/CollaborationApi.md#get_folders) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder | Retrieve all folders
  *CollaborationApi* | [**get_group**](docs/CollaborationApi.md#get_group) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/group/{id} | Retrieve a group
  *CollaborationApi* | [**get_groups**](docs/CollaborationApi.md#get_groups) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/group | Retrieve all groups
  *CollaborationApi* | [**get_logs**](docs/CollaborationApi.md#get_logs) | **GET** /cloud/{cloud_pk}/project/{project_pk}/logs | Retrieve all logs of the project
  *CollaborationApi* | [**get_manage_group**](docs/CollaborationApi.md#get_manage_group) | **GET** /cloud/{cloud_pk}/project/{project_pk}/group/{id} | Retrieve a group
  *CollaborationApi* | [**get_manage_groups**](docs/CollaborationApi.md#get_manage_groups) | **GET** /cloud/{cloud_pk}/project/{project_pk}/group | Retrieve all groups
  *CollaborationApi* | [**get_project**](docs/CollaborationApi.md#get_project) | **GET** /cloud/{cloud_pk}/project/{id} | Retrieve a project
  *CollaborationApi* | [**get_project_access_token**](docs/CollaborationApi.md#get_project_access_token) | **GET** /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} | Retrieve one token created for this project
  *CollaborationApi* | [**get_project_access_tokens**](docs/CollaborationApi.md#get_project_access_tokens) | **GET** /cloud/{cloud_pk}/project/{project_pk}/access-token | Retrieve all tokens created for this project
  *CollaborationApi* | [**get_project_creator_visas**](docs/CollaborationApi.md#get_project_creator_visas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/creator | List visas created by user
  *CollaborationApi* | [**get_project_dms_tree**](docs/CollaborationApi.md#get_project_dms_tree) | **GET** /cloud/{cloud_pk}/project/{id}/dms-tree | Retrieve the complete DMS tree
  *CollaborationApi* | [**get_project_folder_tree**](docs/CollaborationApi.md#get_project_folder_tree) | **GET** /cloud/{cloud_pk}/project/{id}/folder-tree | Retrieve folder tree of the project
  *CollaborationApi* | [**get_project_invitations**](docs/CollaborationApi.md#get_project_invitations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/invitation | Retrieve all pending invitations in the project
  *CollaborationApi* | [**get_project_size**](docs/CollaborationApi.md#get_project_size) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all model files in the project
  *CollaborationApi* | [**get_project_tree**](docs/CollaborationApi.md#get_project_tree) | **GET** /cloud/{cloud_pk}/project/{id}/tree | Retrieve the complete DMS tree
  *CollaborationApi* | [**get_project_users**](docs/CollaborationApi.md#get_project_users) | **GET** /cloud/{cloud_pk}/project/{project_pk}/user | Retrieve all users in a project, or a list with a filter by email
  *CollaborationApi* | [**get_project_validator_visas**](docs/CollaborationApi.md#get_project_validator_visas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/validator | List visas where user is a validator
  *CollaborationApi* | [**get_projects**](docs/CollaborationApi.md#get_projects) | **GET** /cloud/{cloud_pk}/project | Retrieve all projects
  *CollaborationApi* | [**get_self_projects**](docs/CollaborationApi.md#get_self_projects) | **GET** /user/projects | List current user&#39;s projects
  *CollaborationApi* | [**get_self_user**](docs/CollaborationApi.md#get_self_user) | **GET** /user | Get info about the current user
  *CollaborationApi* | [**get_tag**](docs/CollaborationApi.md#get_tag) | **GET** /cloud/{cloud_pk}/project/{project_pk}/tag/{id} | Retrieve a tag
  *CollaborationApi* | [**get_tags**](docs/CollaborationApi.md#get_tags) | **GET** /cloud/{cloud_pk}/project/{project_pk}/tag | Retrieve all tags
  *CollaborationApi* | [**get_user_invitation**](docs/CollaborationApi.md#get_user_invitation) | **GET** /user/invitations/{id} | Retrieve an invitation
  *CollaborationApi* | [**get_user_invitations**](docs/CollaborationApi.md#get_user_invitations) | **GET** /user/invitations | List user&#39;s invitations
  *CollaborationApi* | [**get_validation**](docs/CollaborationApi.md#get_validation) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id} | Retrieve a validation to a visa
  *CollaborationApi* | [**get_validations**](docs/CollaborationApi.md#get_validations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation | List all validations to a visa
  *CollaborationApi* | [**get_visa**](docs/CollaborationApi.md#get_visa) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id} | Retrieve a visa of a document
  *CollaborationApi* | [**get_visa_comment**](docs/CollaborationApi.md#get_visa_comment) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} | Retrieve a comment
  *CollaborationApi* | [**get_visa_comments**](docs/CollaborationApi.md#get_visa_comments) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment | List all comment of a visa
  *CollaborationApi* | [**get_visas**](docs/CollaborationApi.md#get_visas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa | List all visas of a document
  *CollaborationApi* | [**import_from_project**](docs/CollaborationApi.md#import_from_project) | **POST** /cloud/{cloud_pk}/project/{id}/import_from | Import data from a project
  *CollaborationApi* | [**import_manage_group**](docs/CollaborationApi.md#import_manage_group) | **POST** /cloud/{cloud_pk}/project/{project_pk}/group/import | Import a group from another project
  *CollaborationApi* | [**invite_cloud_user**](docs/CollaborationApi.md#invite_cloud_user) | **POST** /cloud/{cloud_pk}/invitation | Invite a cloud member
  *CollaborationApi* | [**invite_project_user**](docs/CollaborationApi.md#invite_project_user) | **POST** /cloud/{cloud_pk}/project/{project_pk}/invitation | Invite a project member
  *CollaborationApi* | [**leave_project**](docs/CollaborationApi.md#leave_project) | **POST** /cloud/{cloud_pk}/project/{id}/leave | Leave the project
  *CollaborationApi* | [**leave_version_document_history**](docs/CollaborationApi.md#leave_version_document_history) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/{id}/leave | Leave the history version
  *CollaborationApi* | [**make_head_version_document_history**](docs/CollaborationApi.md#make_head_version_document_history) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/{id}/head-version | Make the head of the version
  *CollaborationApi* | [**pause_visa**](docs/CollaborationApi.md#pause_visa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/pause | Pause a visa of a document
  *CollaborationApi* | [**reset_validation**](docs/CollaborationApi.md#reset_validation) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/reset | Reset a validation
  *CollaborationApi* | [**resume_visa**](docs/CollaborationApi.md#resume_visa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/resume | Resume a visa of a document
  *CollaborationApi* | [**update_classification**](docs/CollaborationApi.md#update_classification) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Update some fields of a classification
  *CollaborationApi* | [**update_cloud**](docs/CollaborationApi.md#update_cloud) | **PATCH** /cloud/{id} | Update some fields of a cloud
  *CollaborationApi* | [**update_cloud_user**](docs/CollaborationApi.md#update_cloud_user) | **PATCH** /cloud/{cloud_pk}/user/{id} | Change the user role in the cloud
  *CollaborationApi* | [**update_document**](docs/CollaborationApi.md#update_document) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update some fields of the document
  *CollaborationApi* | [**update_folder**](docs/CollaborationApi.md#update_folder) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Update some fields of a folder
  *CollaborationApi* | [**update_group_folder**](docs/CollaborationApi.md#update_group_folder) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/group/{id} | Update the permission of a group on a folder. When propagate is set to True, the permission of all children in the folder will be updated.
  *CollaborationApi* | [**update_manage_group**](docs/CollaborationApi.md#update_manage_group) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/group/{id} | Update some fields of a group
  *CollaborationApi* | [**update_preview_file**](docs/CollaborationApi.md#update_preview_file) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id}/preview-file | Update preview of the document
  *CollaborationApi* | [**update_project**](docs/CollaborationApi.md#update_project) | **PATCH** /cloud/{cloud_pk}/project/{id} | Update some fields of a project
  *CollaborationApi* | [**update_project_user**](docs/CollaborationApi.md#update_project_user) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Change the user role in the cloud
  *CollaborationApi* | [**update_tag**](docs/CollaborationApi.md#update_tag) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/tag/{id} | Update some fields of the tag
  *CollaborationApi* | [**update_validation**](docs/CollaborationApi.md#update_validation) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id} | Update the validator of validation
  *CollaborationApi* | [**update_visa**](docs/CollaborationApi.md#update_visa) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id} | Update some fields of a visa
  *CollaborationApi* | [**update_visa_comment**](docs/CollaborationApi.md#update_visa_comment) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} | Update some fields of a comment
  *ModelApi* | [**add_model_errors**](docs/ModelApi.md#add_model_errors) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/errors | Add errors to model
  *ModelApi* | [**add_zone_space**](docs/ModelApi.md#add_zone_space) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/add | Add a space to a zone
  *ModelApi* | [**bulk_delete_model_classifications**](docs/ModelApi.md#bulk_delete_model_classifications) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/list_destroy | Remove all classifications from model&#39;s elements
  *ModelApi* | [**bulk_delete_model_properties**](docs/ModelApi.md#bulk_delete_model_properties) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_destroy | Delete many Property of a model
  *ModelApi* | [**bulk_delete_model_property_definitions**](docs/ModelApi.md#bulk_delete_model_property_definitions) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/bulk_destroy | Delete many PropertyDefinitions of a model
  *ModelApi* | [**bulk_delete_model_units**](docs/ModelApi.md#bulk_delete_model_units) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/bulk_destroy | Delete many Units of a model
  *ModelApi* | [**bulk_delete_property_set**](docs/ModelApi.md#bulk_delete_property_set) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/bulk_destroy | Delete many PropertySet of a model
  *ModelApi* | [**bulk_full_update_elements**](docs/ModelApi.md#bulk_full_update_elements) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/bulk_update | Update many elements at once (only changing fields may be defined)
  *ModelApi* | [**bulk_full_update_model_property**](docs/ModelApi.md#bulk_full_update_model_property) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_update | Update some fields of many properties of a model
  *ModelApi* | [**bulk_remove_classifications_of_element**](docs/ModelApi.md#bulk_remove_classifications_of_element) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification/bulk_destroy | Remove many classifications from an element
  *ModelApi* | [**bulk_remove_documents_of_element**](docs/ModelApi.md#bulk_remove_documents_of_element) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents/bulk_destroy | Remove many documents from an element
  *ModelApi* | [**bulk_remove_elements_from_classification**](docs/ModelApi.md#bulk_remove_elements_from_classification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element/bulk_destroy | Remove the classifications from all elements
  *ModelApi* | [**bulk_update_elements**](docs/ModelApi.md#bulk_update_elements) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/bulk_update | Update many elements at once (all field must be defined)
  *ModelApi* | [**bulk_update_model_property**](docs/ModelApi.md#bulk_update_model_property) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_update | Update all fields of many properties of a model
  *ModelApi* | [**create_access_token**](docs/ModelApi.md#create_access_token) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token | Create a token for this model
  *ModelApi* | [**create_building**](docs/ModelApi.md#create_building) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building | Create a building of a model
  *ModelApi* | [**create_building_plan**](docs/ModelApi.md#create_building_plan) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/add | Create a relation between a 2d model and a building
  *ModelApi* | [**create_classification_element_relations**](docs/ModelApi.md#create_classification_element_relations) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification-element | Create association between existing classification and existing element
  *ModelApi* | [**create_classifications_of_element**](docs/ModelApi.md#create_classifications_of_element) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification | Create one or many classifications to an element
  *ModelApi* | [**create_drawing**](docs/ModelApi.md#create_drawing) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing | Create a drawing in the model
  *ModelApi* | [**create_element**](docs/ModelApi.md#create_element) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element | Create an element in the model
  *ModelApi* | [**create_element_property_set**](docs/ModelApi.md#create_element_property_set) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset | Create a PropertySets to an element
  *ModelApi* | [**create_element_property_set_property**](docs/ModelApi.md#create_element_property_set_property) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property | Create a property to a PropertySet
  *ModelApi* | [**create_element_property_set_property_definition**](docs/ModelApi.md#create_element_property_set_property_definition) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition | Create a Definition to a Property
  *ModelApi* | [**create_element_property_set_property_definition_unit**](docs/ModelApi.md#create_element_property_set_property_definition_unit) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit | Create a Unit to a Definition
  *ModelApi* | [**create_layer**](docs/ModelApi.md#create_layer) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer | Create a layer in the model
  *ModelApi* | [**create_meta_building**](docs/ModelApi.md#create_meta_building) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-metabuilding | Create an empty 3D Model
  *ModelApi* | [**create_model**](docs/ModelApi.md#create_model) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-model | Make a PDF or Image file a Model
  *ModelApi* | [**create_model_property_definition**](docs/ModelApi.md#create_model_property_definition) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition | Create a PropertyDefinition on the model
  *ModelApi* | [**create_model_unit**](docs/ModelApi.md#create_model_unit) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit | Create a Unit on a model
  *ModelApi* | [**create_multi_page_model**](docs/ModelApi.md#create_multi_page_model) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/create-multipage-model | Create a multi page model
  *ModelApi* | [**create_photosphere**](docs/ModelApi.md#create_photosphere) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-photosphere | Create a photopshere model from an image file
  *ModelApi* | [**create_photosphere_building**](docs/ModelApi.md#create_photosphere_building) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-photosphere-building | Create an empty Photosphere Building Model
  *ModelApi* | [**create_property_set**](docs/ModelApi.md#create_property_set) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset | Create one or many PropertySet
  *ModelApi* | [**create_property_set_element_relations**](docs/ModelApi.md#create_property_set_element_relations) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset-element | Create association between PropertySet and element
  *ModelApi* | [**create_raw_elements**](docs/ModelApi.md#create_raw_elements) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/raw | Create elements in an optimized format
  *ModelApi* | [**create_space**](docs/ModelApi.md#create_space) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space | Create a space in the model
  *ModelApi* | [**create_storey**](docs/ModelApi.md#create_storey) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey | Create a storey of a model
  *ModelApi* | [**create_storey_plan**](docs/ModelApi.md#create_storey_plan) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/add | Create a relation between a 2d model and a storey
  *ModelApi* | [**create_system**](docs/ModelApi.md#create_system) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system | Create a system in the model
  *ModelApi* | [**create_tileset**](docs/ModelApi.md#create_tileset) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/tileset | Create the tileset of the model and upload all files
  *ModelApi* | [**create_xkt_file**](docs/ModelApi.md#create_xkt_file) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/xkt-file | Create an xkt file for the model. Overrides existing file with same version
  *ModelApi* | [**create_zone**](docs/ModelApi.md#create_zone) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone | Create a zone in the model
  *ModelApi* | [**create_zone_space**](docs/ModelApi.md#create_zone_space) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space | Create a space in a zone
  *ModelApi* | [**delete_access_token**](docs/ModelApi.md#delete_access_token) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token} | Delete a token
  *ModelApi* | [**delete_building**](docs/ModelApi.md#delete_building) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid} | Delete a building of a model
  *ModelApi* | [**delete_building_plan**](docs/ModelApi.md#delete_building_plan) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id} | Delete the relation between a 2d model and a building
  *ModelApi* | [**delete_drawing**](docs/ModelApi.md#delete_drawing) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} | Delete a drawing of a model
  *ModelApi* | [**delete_element**](docs/ModelApi.md#delete_element) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Delete an element of a model
  *ModelApi* | [**delete_layer**](docs/ModelApi.md#delete_layer) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Delete a layer of a model
  *ModelApi* | [**delete_model**](docs/ModelApi.md#delete_model) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id} | Delete a model
  *ModelApi* | [**delete_model_property**](docs/ModelApi.md#delete_model_property) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} | Delete a Property of a model
  *ModelApi* | [**delete_model_property_definition**](docs/ModelApi.md#delete_model_property_definition) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} | Delete a PropertyDefinitions of a model
  *ModelApi* | [**delete_model_unit**](docs/ModelApi.md#delete_model_unit) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id} | Delete a Unit of a model
  *ModelApi* | [**delete_model_without_doc**](docs/ModelApi.md#delete_model_without_doc) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/delete-model | Delete the Model without deleting the related document
  *ModelApi* | [**delete_property_set**](docs/ModelApi.md#delete_property_set) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id} | Delete a PropertySet of a model
  *ModelApi* | [**delete_space**](docs/ModelApi.md#delete_space) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id} | Delete a space
  *ModelApi* | [**delete_storey**](docs/ModelApi.md#delete_storey) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid} | Delete a storey of a model
  *ModelApi* | [**delete_storey_plan**](docs/ModelApi.md#delete_storey_plan) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id} | Delete the relation between a 2d model and a storey
  *ModelApi* | [**delete_system**](docs/ModelApi.md#delete_system) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} | Delete a system of a model
  *ModelApi* | [**delete_zone**](docs/ModelApi.md#delete_zone) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} | Delete a zone of a model
  *ModelApi* | [**delete_zone_space**](docs/ModelApi.md#delete_zone_space) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} | Delete the relation between a space and a zone
  *ModelApi* | [**export_ifc**](docs/ModelApi.md#export_ifc) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/export | Export IFC
  *ModelApi* | [**full_update_element**](docs/ModelApi.md#full_update_element) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Update all fields of an element
  *ModelApi* | [**get_access_token**](docs/ModelApi.md#get_access_token) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token} | Retrieve one token created for this model
  *ModelApi* | [**get_access_tokens**](docs/ModelApi.md#get_access_tokens) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token | Retrieve all tokens created for this model
  *ModelApi* | [**get_building**](docs/ModelApi.md#get_building) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid} | Retrieve a building of a model
  *ModelApi* | [**get_building_plan_positioning**](docs/ModelApi.md#get_building_plan_positioning) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id}/positioning | Retrieve the postioning of the plan in the building
  *ModelApi* | [**get_buildings**](docs/ModelApi.md#get_buildings) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building | Retrieve all buildings of a model
  *ModelApi* | [**get_classifications_of_element**](docs/ModelApi.md#get_classifications_of_element) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification | Retrieve all classifications of an element
  *ModelApi* | [**get_documents_of_element**](docs/ModelApi.md#get_documents_of_element) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents | Retrieve all documents of an element
  *ModelApi* | [**get_drawing**](docs/ModelApi.md#get_drawing) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} | Retrieve a drawing of a model
  *ModelApi* | [**get_drawings**](docs/ModelApi.md#get_drawings) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing | Retrieve all drawings of a model
  *ModelApi* | [**get_element**](docs/ModelApi.md#get_element) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Retrieve an element of a model
  *ModelApi* | [**get_element_linked_documents**](docs/ModelApi.md#get_element_linked_documents) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/documents | Retrieve all documents linked to any element
  *ModelApi* | [**get_element_property_set**](docs/ModelApi.md#get_element_property_set) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{id} | Retrieve a PropertySet of an element
  *ModelApi* | [**get_element_property_set_properties**](docs/ModelApi.md#get_element_property_set_properties) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property | Retrieve all Properties of a PropertySet
  *ModelApi* | [**get_element_property_set_property**](docs/ModelApi.md#get_element_property_set_property) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Retrieve a Property of a PropertySet
  *ModelApi* | [**get_element_property_set_property_definition**](docs/ModelApi.md#get_element_property_set_property_definition) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id} | Retrieve a Definition of a Property
  *ModelApi* | [**get_element_property_set_property_definition_unit**](docs/ModelApi.md#get_element_property_set_property_definition_unit) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit/{id} | Retrieve a Unit of a Definition
  *ModelApi* | [**get_element_property_set_property_definition_units**](docs/ModelApi.md#get_element_property_set_property_definition_units) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit | Retrieve all Units of a Definition
  *ModelApi* | [**get_element_property_set_property_definitions**](docs/ModelApi.md#get_element_property_set_property_definitions) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition | Retrieve all Definitions of a PropertySet
  *ModelApi* | [**get_element_property_sets**](docs/ModelApi.md#get_element_property_sets) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset | Retrieve all PropertySets of an element
  *ModelApi* | [**get_elements**](docs/ModelApi.md#get_elements) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element | Retrieve all elements of a model
  *ModelApi* | [**get_elements_from_classification**](docs/ModelApi.md#get_elements_from_classification) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element | Retrieve all elements with the classification
  *ModelApi* | [**get_layer**](docs/ModelApi.md#get_layer) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Retrieve a layer of a model
  *ModelApi* | [**get_layers**](docs/ModelApi.md#get_layers) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer | Retrieve all layers of a model
  *ModelApi* | [**get_material**](docs/ModelApi.md#get_material) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/material/{id} | Retrieve a material of a model
  *ModelApi* | [**get_materials**](docs/ModelApi.md#get_materials) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/material | Retrieve all materials of a model
  *ModelApi* | [**get_model**](docs/ModelApi.md#get_model) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{id} | Retrieve one model
  *ModelApi* | [**get_model_classifications**](docs/ModelApi.md#get_model_classifications) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification | Retrieve all classifications in a model
  *ModelApi* | [**get_model_material**](docs/ModelApi.md#get_model_material) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/material/{id} | Retrieve a material of a model
  *ModelApi* | [**get_model_materials**](docs/ModelApi.md#get_model_materials) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/material | Retrieve all materials of a model
  *ModelApi* | [**get_model_properties**](docs/ModelApi.md#get_model_properties) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property | Retrieve all Properties of a model
  *ModelApi* | [**get_model_property**](docs/ModelApi.md#get_model_property) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} | Retrieve a Property of a model
  *ModelApi* | [**get_model_property_definition**](docs/ModelApi.md#get_model_property_definition) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} | Retrieve a PropertyDefinition of a model
  *ModelApi* | [**get_model_property_definitions**](docs/ModelApi.md#get_model_property_definitions) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition | Retrieve all PropertyDefinitions of a model
  *ModelApi* | [**get_model_unit**](docs/ModelApi.md#get_model_unit) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id} | Retrieve a Unit of a model
  *ModelApi* | [**get_model_units**](docs/ModelApi.md#get_model_units) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit | Retrieve all Units of a model
  *ModelApi* | [**get_models**](docs/ModelApi.md#get_models) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model | Retrieve all models
  *ModelApi* | [**get_processor_handler**](docs/ModelApi.md#get_processor_handler) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler/{id} | Retrieve a processor handler
  *ModelApi* | [**get_processor_handlers**](docs/ModelApi.md#get_processor_handlers) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler | Get all processor handlers
  *ModelApi* | [**get_property_set**](docs/ModelApi.md#get_property_set) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id} | Retrieve a PropertySet of a model
  *ModelApi* | [**get_property_sets**](docs/ModelApi.md#get_property_sets) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset | Retrieve all PropertySets of a model
  *ModelApi* | [**get_raw_elements**](docs/ModelApi.md#get_raw_elements) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/raw | Retrieve all elements in a optimized format
  *ModelApi* | [**get_simple_element**](docs/ModelApi.md#get_simple_element) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid}/simple | Retrieve an element of a model with a simple value representation
  *ModelApi* | [**get_simple_elements**](docs/ModelApi.md#get_simple_elements) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/simple | Retrieve all elements of a model with a simple value representation
  *ModelApi* | [**get_space**](docs/ModelApi.md#get_space) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id} | Retrieve one space of the model
  *ModelApi* | [**get_spaces**](docs/ModelApi.md#get_spaces) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space | Retrieve all spaces of the model
  *ModelApi* | [**get_storey**](docs/ModelApi.md#get_storey) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid} | Retrieve a storey of a model
  *ModelApi* | [**get_storey_plan_positioning**](docs/ModelApi.md#get_storey_plan_positioning) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id}/positioning | Retrieve the postioning of the plan in the storey
  *ModelApi* | [**get_storeys**](docs/ModelApi.md#get_storeys) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey | Retrieve all storeys of a model
  *ModelApi* | [**get_system**](docs/ModelApi.md#get_system) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} | Retrieve a system of a model
  *ModelApi* | [**get_systems**](docs/ModelApi.md#get_systems) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system | Retrieve all systems of a model
  *ModelApi* | [**get_tileset**](docs/ModelApi.md#get_tileset) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/tileset | Retrieve the tileset of the model
  *ModelApi* | [**get_zone**](docs/ModelApi.md#get_zone) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} | Retrieve one zone of a model
  *ModelApi* | [**get_zone_space**](docs/ModelApi.md#get_zone_space) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} | Retrieve one space of a zone
  *ModelApi* | [**get_zone_spaces**](docs/ModelApi.md#get_zone_spaces) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space | Retrieve all spaces of a zone
  *ModelApi* | [**get_zones**](docs/ModelApi.md#get_zones) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone | Retrieve zones of a model
  *ModelApi* | [**link_documents_of_element**](docs/ModelApi.md#link_documents_of_element) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents | Link one or many documents to an element
  *ModelApi* | [**list_classification_element_relations**](docs/ModelApi.md#list_classification_element_relations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification-element | List all associations between classifications and elements
  *ModelApi* | [**merge_ifcs**](docs/ModelApi.md#merge_ifcs) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/merge | Merge IFC files
  *ModelApi* | [**optimize_ifc**](docs/ModelApi.md#optimize_ifc) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/optimize | Optimize the IFC
  *ModelApi* | [**remove_all_element_property_set**](docs/ModelApi.md#remove_all_element_property_set) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/all | Remove all property sets from element
  *ModelApi* | [**remove_classification_of_element**](docs/ModelApi.md#remove_classification_of_element) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification/{id} | Remove a classification from an element
  *ModelApi* | [**remove_document_of_element**](docs/ModelApi.md#remove_document_of_element) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents/{id} | Remove a documents from an element
  *ModelApi* | [**remove_element_property_set**](docs/ModelApi.md#remove_element_property_set) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{id} | Remove a PropertySet from an element
  *ModelApi* | [**remove_element_property_set_property**](docs/ModelApi.md#remove_element_property_set_property) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Remove a property from a PropertySet
  *ModelApi* | [**remove_element_property_set_property_definition**](docs/ModelApi.md#remove_element_property_set_property_definition) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id} | Delete a Definition to a Property
  *ModelApi* | [**remove_element_property_set_property_definition_unit**](docs/ModelApi.md#remove_element_property_set_property_definition_unit) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit/{id} | Remove a Unit from a Definition
  *ModelApi* | [**remove_elements_from_classification**](docs/ModelApi.md#remove_elements_from_classification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element/{uuid} | Remove the classification from all elements
  *ModelApi* | [**reprocess_model**](docs/ModelApi.md#reprocess_model) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/reprocess | Reprocess Model file
  *ModelApi* | [**update_access_token**](docs/ModelApi.md#update_access_token) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token} | Update some fields of a token
  *ModelApi* | [**update_building**](docs/ModelApi.md#update_building) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid} | Update some fields of a building
  *ModelApi* | [**update_building_plan_positioning**](docs/ModelApi.md#update_building_plan_positioning) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id}/positioning | Update the postioning of the plan in the building
  *ModelApi* | [**update_drawing**](docs/ModelApi.md#update_drawing) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} | Update some fields of a drawing
  *ModelApi* | [**update_element**](docs/ModelApi.md#update_element) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Update some fields of an element
  *ModelApi* | [**update_element_property_set_property**](docs/ModelApi.md#update_element_property_set_property) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Update a property from an element
  *ModelApi* | [**update_layer**](docs/ModelApi.md#update_layer) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Update some fields of a layer
  *ModelApi* | [**update_model**](docs/ModelApi.md#update_model) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{id} | Update some fields of a model
  *ModelApi* | [**update_model_files**](docs/ModelApi.md#update_model_files) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/files | Update models file (gltf, svg, structure, etc)
  *ModelApi* | [**update_model_property**](docs/ModelApi.md#update_model_property) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} | Update some fields of a Property
  *ModelApi* | [**update_model_property_definition**](docs/ModelApi.md#update_model_property_definition) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} | Update some fields of many PropertyDefinitions of a model
  *ModelApi* | [**update_model_unit**](docs/ModelApi.md#update_model_unit) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id} | Update some fields of a Unit of a model
  *ModelApi* | [**update_order_building_plan**](docs/ModelApi.md#update_order_building_plan) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/order | Update order of all plan of a building
  *ModelApi* | [**update_order_storey_plan**](docs/ModelApi.md#update_order_storey_plan) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/order | Update order of all plan of a storey
  *ModelApi* | [**update_order_storeys**](docs/ModelApi.md#update_order_storeys) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/order | Update order of all storey of a model
  *ModelApi* | [**update_processor_handler**](docs/ModelApi.md#update_processor_handler) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler/{id} | Update the status of a processor handler
  *ModelApi* | [**update_property_set**](docs/ModelApi.md#update_property_set) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id} | Update some fields of a PropertySet
  *ModelApi* | [**update_space**](docs/ModelApi.md#update_space) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id} | Update some fields of a space
  *ModelApi* | [**update_storey**](docs/ModelApi.md#update_storey) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid} | Update some fields of a storey
  *ModelApi* | [**update_storey_plan_positioning**](docs/ModelApi.md#update_storey_plan_positioning) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id}/positioning | Update the postioning of the plan in the storey
  *ModelApi* | [**update_system**](docs/ModelApi.md#update_system) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} | Update some fields of a system
  *ModelApi* | [**update_zone**](docs/ModelApi.md#update_zone) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} | Update some fields of a zone
  *ModelApi* | [**update_zone_space**](docs/ModelApi.md#update_zone_space) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} | Update some fields of a space
  *SsoApi* | [**accept_invitation**](docs/SsoApi.md#accept_invitation) | **POST** /identity-provider/invitation/{id}/accept | Accept an invitation
  *SsoApi* | [**create_user**](docs/SsoApi.md#create_user) | **POST** /identity-provider/user | Create a user
  *SsoApi* | [**delete_user**](docs/SsoApi.md#delete_user) | **DELETE** /identity-provider/user | Delete user from BIMData
  *SsoApi* | [**deny_invitation**](docs/SsoApi.md#deny_invitation) | **POST** /identity-provider/invitation/{id}/deny | Deny an invitation
  *SsoApi* | [**get_invitation**](docs/SsoApi.md#get_invitation) | **GET** /identity-provider/invitation/{id} | Retrieve an invitation
  *SsoApi* | [**get_invitations**](docs/SsoApi.md#get_invitations) | **GET** /identity-provider/invitation | Retrieve all invitations
  *WebhookApi* | [**create_web_hook**](docs/WebhookApi.md#create_web_hook) | **POST** /cloud/{cloud_pk}/webhook | Create a new Webhook
  *WebhookApi* | [**delete_web_hook**](docs/WebhookApi.md#delete_web_hook) | **DELETE** /cloud/{cloud_pk}/webhook/{id} | Delete a webhook
  *WebhookApi* | [**get_web_hook**](docs/WebhookApi.md#get_web_hook) | **GET** /cloud/{cloud_pk}/webhook/{id} | Retrieve one configured webhook
  *WebhookApi* | [**get_web_hooks**](docs/WebhookApi.md#get_web_hooks) | **GET** /cloud/{cloud_pk}/webhook | Retrieve all configured webhooks
  *WebhookApi* | [**ping_web_hook**](docs/WebhookApi.md#ping_web_hook) | **POST** /cloud/{cloud_pk}/webhook/{id}/ping | Test a webhook
  *WebhookApi* | [**update_web_hook**](docs/WebhookApi.md#update_web_hook) | **PATCH** /cloud/{cloud_pk}/webhook/{id} | Update some field of a webhook

   - [Auth](docs/Auth.md)
   - [BcfProject](docs/BcfProject.md)
   - [BcfProjectRequest](docs/BcfProjectRequest.md)
   - [Building](docs/Building.md)
   - [BuildingModelPlanRequest](docs/BuildingModelPlanRequest.md)
   - [CheckProjectAccess](docs/CheckProjectAccess.md)
   - [Classification](docs/Classification.md)
   - [ClassificationRequest](docs/ClassificationRequest.md)
   - [ClippingPlane](docs/ClippingPlane.md)
   - [ClippingPlaneRequest](docs/ClippingPlaneRequest.md)
   - [Cloud](docs/Cloud.md)
   - [CloudInvitation](docs/CloudInvitation.md)
   - [CloudInvitationRequest](docs/CloudInvitationRequest.md)
   - [CloudRequest](docs/CloudRequest.md)
   - [CloudRole](docs/CloudRole.md)
   - [Coloring](docs/Coloring.md)
   - [ColoringRequest](docs/ColoringRequest.md)
   - [Comment](docs/Comment.md)
   - [CommentRequest](docs/CommentRequest.md)
   - [Component](docs/Component.md)
   - [ComponentRequest](docs/ComponentRequest.md)
   - [ComponentsParent](docs/ComponentsParent.md)
   - [ComponentsParentRequest](docs/ComponentsParentRequest.md)
   - [CreateBuildingByNameRequest](docs/CreateBuildingByNameRequest.md)
   - [CreateModelRequest](docs/CreateModelRequest.md)
   - [CreateMultiPageModelRequest](docs/CreateMultiPageModelRequest.md)
   - [CreateUserRequest](docs/CreateUserRequest.md)
   - [DetailedExtensions](docs/DetailedExtensions.md)
   - [Direction](docs/Direction.md)
   - [DirectionRequest](docs/DirectionRequest.md)
   - [Document](docs/Document.md)
   - [DocumentPreviewFile](docs/DocumentPreviewFile.md)
   - [DocumentWithElementList](docs/DocumentWithElementList.md)
   - [Drawing](docs/Drawing.md)
   - [DrawingRequest](docs/DrawingRequest.md)
   - [Element](docs/Element.md)
   - [ElementClassificationRelation](docs/ElementClassificationRelation.md)
   - [ElementClassificationRelationRequest](docs/ElementClassificationRelationRequest.md)
   - [ElementPropertySetRelationRequest](docs/ElementPropertySetRelationRequest.md)
   - [ElementRequest](docs/ElementRequest.md)
   - [Extensions](docs/Extensions.md)
   - [Feature](docs/Feature.md)
   - [FeatureRequest](docs/FeatureRequest.md)
   - [Folder](docs/Folder.md)
   - [FolderTree](docs/FolderTree.md)
   - [FolderUserProject](docs/FolderUserProject.md)
   - [FolderWithoutChildren](docs/FolderWithoutChildren.md)
   - [FolderWithoutChildrenRequest](docs/FolderWithoutChildrenRequest.md)
   - [FullTopic](docs/FullTopic.md)
   - [FullTopicRequest](docs/FullTopicRequest.md)
   - [GeometryPoint](docs/GeometryPoint.md)
   - [GeometryPointRequest](docs/GeometryPointRequest.md)
   - [Group](docs/Group.md)
   - [GroupFolder](docs/GroupFolder.md)
   - [GroupFolderRead](docs/GroupFolderRead.md)
   - [GroupRequest](docs/GroupRequest.md)
   - [IfcAccessToken](docs/IfcAccessToken.md)
   - [IfcAccessTokenRequest](docs/IfcAccessTokenRequest.md)
   - [IfcExportRequest](docs/IfcExportRequest.md)
   - [IfcMergeRequest](docs/IfcMergeRequest.md)
   - [IfcOptimizeRequest](docs/IfcOptimizeRequest.md)
   - [ImportGroupRequest](docs/ImportGroupRequest.md)
   - [Invitation](docs/Invitation.md)
   - [Label](docs/Label.md)
   - [LabelRequest](docs/LabelRequest.md)
   - [Layer](docs/Layer.md)
   - [LayerElement](docs/LayerElement.md)
   - [LayerElementRequest](docs/LayerElementRequest.md)
   - [LayerRequest](docs/LayerRequest.md)
   - [LightDocument](docs/LightDocument.md)
   - [Line](docs/Line.md)
   - [LineRequest](docs/LineRequest.md)
   - [LogEntry](docs/LogEntry.md)
   - [MarketplaceAppImage](docs/MarketplaceAppImage.md)
   - [MarketplaceAppLight](docs/MarketplaceAppLight.md)
   - [MarketplaceAppLightRequest](docs/MarketplaceAppLightRequest.md)
   - [Material](docs/Material.md)
   - [MaterialListComponent](docs/MaterialListComponent.md)
   - [MaterialListComponentRequest](docs/MaterialListComponentRequest.md)
   - [MaterialOption](docs/MaterialOption.md)
   - [MaterialRequest](docs/MaterialRequest.md)
   - [Model](docs/Model.md)
   - [ModelErrors](docs/ModelErrors.md)
   - [ModelErrorsRequest](docs/ModelErrorsRequest.md)
   - [ModelFiles](docs/ModelFiles.md)
   - [ModelProperty](docs/ModelProperty.md)
   - [ModelSerializerWithoutChildren](docs/ModelSerializerWithoutChildren.md)
   - [ModelWithPositioningPlan](docs/ModelWithPositioningPlan.md)
   - [Organization](docs/Organization.md)
   - [OrganizationRequest](docs/OrganizationRequest.md)
   - [OrthogonalCamera](docs/OrthogonalCamera.md)
   - [OrthogonalCameraRequest](docs/OrthogonalCameraRequest.md)
   - [PatchedBcfProjectRequest](docs/PatchedBcfProjectRequest.md)
   - [PatchedClassificationRequest](docs/PatchedClassificationRequest.md)
   - [PatchedCloudRequest](docs/PatchedCloudRequest.md)
   - [PatchedCommentRequest](docs/PatchedCommentRequest.md)
   - [PatchedDocumentRequest](docs/PatchedDocumentRequest.md)
   - [PatchedDrawingRequest](docs/PatchedDrawingRequest.md)
   - [PatchedElementRequest](docs/PatchedElementRequest.md)
   - [PatchedFolderWithoutChildrenRequest](docs/PatchedFolderWithoutChildrenRequest.md)
   - [PatchedFullTopicRequest](docs/PatchedFullTopicRequest.md)
   - [PatchedGroupFolderRequest](docs/PatchedGroupFolderRequest.md)
   - [PatchedGroupRequest](docs/PatchedGroupRequest.md)
   - [PatchedIfcAccessTokenRequest](docs/PatchedIfcAccessTokenRequest.md)
   - [PatchedLabelRequest](docs/PatchedLabelRequest.md)
   - [PatchedLayerRequest](docs/PatchedLayerRequest.md)
   - [PatchedModelRequest](docs/PatchedModelRequest.md)
   - [PatchedPinRequest](docs/PatchedPinRequest.md)
   - [PatchedPositioningPlanRequest](docs/PatchedPositioningPlanRequest.md)
   - [PatchedPriorityRequest](docs/PatchedPriorityRequest.md)
   - [PatchedProcessorHandlerRequest](docs/PatchedProcessorHandlerRequest.md)
   - [PatchedProjectRequest](docs/PatchedProjectRequest.md)
   - [PatchedPropertyDefinitionRequest](docs/PatchedPropertyDefinitionRequest.md)
   - [PatchedPropertyRequest](docs/PatchedPropertyRequest.md)
   - [PatchedPropertySetRequest](docs/PatchedPropertySetRequest.md)
   - [PatchedSpaceRequest](docs/PatchedSpaceRequest.md)
   - [PatchedStageRequest](docs/PatchedStageRequest.md)
   - [PatchedStoreyBuildingRequest](docs/PatchedStoreyBuildingRequest.md)
   - [PatchedSystemRequest](docs/PatchedSystemRequest.md)
   - [PatchedTagRequest](docs/PatchedTagRequest.md)
   - [PatchedTopicRequest](docs/PatchedTopicRequest.md)
   - [PatchedTopicStatusRequest](docs/PatchedTopicStatusRequest.md)
   - [PatchedTopicTypeRequest](docs/PatchedTopicTypeRequest.md)
   - [PatchedUnitRequest](docs/PatchedUnitRequest.md)
   - [PatchedUserCloudUpdateRequest](docs/PatchedUserCloudUpdateRequest.md)
   - [PatchedUserProjectUpdateRequest](docs/PatchedUserProjectUpdateRequest.md)
   - [PatchedViewpointRequest](docs/PatchedViewpointRequest.md)
   - [PatchedVisaCommentRequest](docs/PatchedVisaCommentRequest.md)
   - [PatchedVisaRequest](docs/PatchedVisaRequest.md)
   - [PatchedVisaValidationRequest](docs/PatchedVisaValidationRequest.md)
   - [PatchedWebHookRequest](docs/PatchedWebHookRequest.md)
   - [PatchedZoneRequest](docs/PatchedZoneRequest.md)
   - [PatchedZoneSpaceRequest](docs/PatchedZoneSpaceRequest.md)
   - [PerspectiveCamera](docs/PerspectiveCamera.md)
   - [PerspectiveCameraRequest](docs/PerspectiveCameraRequest.md)
   - [Pin](docs/Pin.md)
   - [PinRequest](docs/PinRequest.md)
   - [Point](docs/Point.md)
   - [PointRequest](docs/PointRequest.md)
   - [PositioningPlan](docs/PositioningPlan.md)
   - [Priority](docs/Priority.md)
   - [PriorityRequest](docs/PriorityRequest.md)
   - [ProcessorHandler](docs/ProcessorHandler.md)
   - [Project](docs/Project.md)
   - [ProjectAccessToken](docs/ProjectAccessToken.md)
   - [ProjectAccessTokenRequest](docs/ProjectAccessTokenRequest.md)
   - [ProjectImportRequest](docs/ProjectImportRequest.md)
   - [ProjectInvitation](docs/ProjectInvitation.md)
   - [ProjectInvitationRequest](docs/ProjectInvitationRequest.md)
   - [ProjectRequest](docs/ProjectRequest.md)
   - [ProjectRole](docs/ProjectRole.md)
   - [ProjectSize](docs/ProjectSize.md)
   - [PropertyDefinition](docs/PropertyDefinition.md)
   - [PropertyDefinitionRequest](docs/PropertyDefinitionRequest.md)
   - [PropertyRequest](docs/PropertyRequest.md)
   - [PropertySet](docs/PropertySet.md)
   - [PropertySetRequest](docs/PropertySetRequest.md)
   - [PublicOrganization](docs/PublicOrganization.md)
   - [PublicOrganizationRequest](docs/PublicOrganizationRequest.md)
   - [RawClassification](docs/RawClassification.md)
   - [RawClassificationRequest](docs/RawClassificationRequest.md)
   - [RawDefinition](docs/RawDefinition.md)
   - [RawDefinitionRequest](docs/RawDefinitionRequest.md)
   - [RawElement](docs/RawElement.md)
   - [RawElementRequest](docs/RawElementRequest.md)
   - [RawElements](docs/RawElements.md)
   - [RawElementsRequest](docs/RawElementsRequest.md)
   - [RawLayer](docs/RawLayer.md)
   - [RawLayerRequest](docs/RawLayerRequest.md)
   - [RawMaterial](docs/RawMaterial.md)
   - [RawMaterialList](docs/RawMaterialList.md)
   - [RawMaterialListComponents](docs/RawMaterialListComponents.md)
   - [RawMaterialListComponentsRequest](docs/RawMaterialListComponentsRequest.md)
   - [RawMaterialListRequest](docs/RawMaterialListRequest.md)
   - [RawMaterialOptions](docs/RawMaterialOptions.md)
   - [RawMaterialOptionsRequest](docs/RawMaterialOptionsRequest.md)
   - [RawMaterialRequest](docs/RawMaterialRequest.md)
   - [RawProperty](docs/RawProperty.md)
   - [RawPropertyRequest](docs/RawPropertyRequest.md)
   - [RawPropertySet](docs/RawPropertySet.md)
   - [RawPropertySetRequest](docs/RawPropertySetRequest.md)
   - [RawSystem](docs/RawSystem.md)
   - [RawSystemRequest](docs/RawSystemRequest.md)
   - [RawUnit](docs/RawUnit.md)
   - [RawUnitRequest](docs/RawUnitRequest.md)
   - [RecursiveFolderChildren](docs/RecursiveFolderChildren.md)
   - [SelectUserRequest](docs/SelectUserRequest.md)
   - [SelfBcfUser](docs/SelfBcfUser.md)
   - [SelfUser](docs/SelfUser.md)
   - [ShortUser](docs/ShortUser.md)
   - [SimpleElement](docs/SimpleElement.md)
   - [Size](docs/Size.md)
   - [Snapshot](docs/Snapshot.md)
   - [SnapshotRequest](docs/SnapshotRequest.md)
   - [Space](docs/Space.md)
   - [SpaceRequest](docs/SpaceRequest.md)
   - [Stage](docs/Stage.md)
   - [StageRequest](docs/StageRequest.md)
   - [Storey](docs/Storey.md)
   - [StoreyBuildingRequest](docs/StoreyBuildingRequest.md)
   - [StoreyModelPlanRequest](docs/StoreyModelPlanRequest.md)
   - [System](docs/System.md)
   - [SystemRequest](docs/SystemRequest.md)
   - [Tag](docs/Tag.md)
   - [TagIdRequest](docs/TagIdRequest.md)
   - [TagRequest](docs/TagRequest.md)
   - [Topic](docs/Topic.md)
   - [TopicRequest](docs/TopicRequest.md)
   - [TopicStatus](docs/TopicStatus.md)
   - [TopicStatusRequest](docs/TopicStatusRequest.md)
   - [TopicType](docs/TopicType.md)
   - [TopicTypeRequest](docs/TopicTypeRequest.md)
   - [Unit](docs/Unit.md)
   - [UnitRequest](docs/UnitRequest.md)
   - [User](docs/User.md)
   - [UserInvitation](docs/UserInvitation.md)
   - [UserProject](docs/UserProject.md)
   - [UserProjectIdRequest](docs/UserProjectIdRequest.md)
   - [Version](docs/Version.md)
   - [ViewSetupHints](docs/ViewSetupHints.md)
   - [ViewSetupHintsRequest](docs/ViewSetupHintsRequest.md)
   - [Viewpoint](docs/Viewpoint.md)
   - [ViewpointRequest](docs/ViewpointRequest.md)
   - [Visa](docs/Visa.md)
   - [VisaAttachment](docs/VisaAttachment.md)
   - [VisaAttachmentRequest](docs/VisaAttachmentRequest.md)
   - [VisaComment](docs/VisaComment.md)
   - [VisaCommentRequest](docs/VisaCommentRequest.md)
   - [VisaRequest](docs/VisaRequest.md)
   - [VisaValidation](docs/VisaValidation.md)
   - [VisaValidationRequest](docs/VisaValidationRequest.md)
   - [VisaWithDocument](docs/VisaWithDocument.md)
   - [Visibility](docs/Visibility.md)
   - [VisibilityRequest](docs/VisibilityRequest.md)
   - [WebHook](docs/WebHook.md)
   - [WebHookRequest](docs/WebHookRequest.md)
   - [WriteFolderRequest](docs/WriteFolderRequest.md)
   - [XktFile](docs/XktFile.md)
   - [Zone](docs/Zone.md)
   - [ZoneRequest](docs/ZoneRequest.md)
   - [ZoneSpace](docs/ZoneSpace.md)
   - [ZoneSpaceRelationRequest](docs/ZoneSpaceRelationRequest.md)
   - [ZoneSpaceRequest](docs/ZoneSpaceRequest.md)


  - **Type**: API key
  - **API key parameter name**: Authorization
  - **Location**: HTTP header

  - **Type**: OAuth
  - **Flow**: implicit
  - **Authorization URL**: http://fakeurl.bimdata.example/realms/bimdata/protocol/openid-connect/auth
  - **Scopes**: N/A

  - **Type**: OAuth
  - **Flow**: application
  - **Authorization URL**:
  - **Scopes**: N/A

  - **Type**: API key
  - **API key parameter name**: Authorization
  - **Location**: HTTP header

  support@bimdata.io

  If the OpenAPI document is large, imports in bimdata_api_client.apis and bimdata_api_client.models may fail with a
  RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
  Solution 1:
  Use specific imports for apis and models like:
  - `from bimdata_api_client.api.default_api import DefaultApi`
  - `from bimdata_api_client.model.pet import Pet`
  Solution 2:
  Before importing the package, adjust the maximum recursion limit as shown below:
  ```
  import sys
  sys.setrecursionlimit(1500)
  import bimdata_api_client
  from bimdata_api_client.apis import *
  from bimdata_api_client.models import *
  ```


pkgId: ca52503d429f83e05b6bd5c8e5ef80685a07bfb2ec2e6f4424fdd6f2ab8633d6
name: python-bimmer-connected
arch: src
version: 0.16.3
epoch: 0
release: 1
summary: Library to read data from the BMW Connected Drive portal
url: https://github.com/bimmerconnected/bimmer_connected
rpm_license: Apache-2.0
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bimmer-connected-0.16.3-1.src.rpm
checksum_type: sha256
description:
  This is a simple library to query and control the status of your BMW, Mini, or Toyota Supra vehicle from
  the MyBMW portal.


pkgId: 4098ce826015f9f313d1cdafafa086a6799ad27a21d063883ccf954b1e3878e4
name: python-bin2cell
arch: src
version: 0.3.2
epoch: 0
release: 1
summary: Join subcellular Visium HD bins into cells
url: https://pypi.org/project/bin2cell/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bin2cell-0.3.2-1.src.rpm
checksum_type: sha256
description:
  Visium HD captures gene expression data at a subcellular 2um resolution. It should be possible to use this data to reconstruct cells more accurately than just using the next resolution up (8um), especially if additionally using the available high resolution morphology images.

  Bin2cell proposes 2um bin to cell groupings based on segmentation, which can be done on the morphology image and/or a visualisation of the gene expression. The package also corrects for a novel technical effect in the data stemming from variable bin dimensions. The end result is an object with cells, created from grouped 2um bins assigned to the same object after segmentation, carrying spatial information and sharper morphology images for visualisation. More details in the [demo notebook](https://nbviewer.org/github/Teichlab/bin2cell/blob/main/notebooks/demo.ipynb).

  <p align="center"><img src="https://github.com/Teichlab/bin2cell/blob/main/figure.jpg" alt="Label evolution" width="80%" ></p>



  ```bash
  pip install bin2cell
  ```

  Additionally, TensorFlow needs to be installed for [StarDist](https://github.com/stardist/stardist) to perform segmentation. The CPU version (installed via `pip install tensorflow`) should suffice for the scale of work performed here.



  **Please refer to the [demo notebook](https://nbviewer.org/github/Teichlab/bin2cell/blob/main/notebooks/demo.ipynb).** Function docstrings are available on [ReadTheDocs](https://bin2cell.readthedocs.io/en/latest/).

  The repository also has notebooks comparing bin2cell output to standard 8um SpaceRanger output:
  - Mouse brain [bin2cell](https://nbviewer.org/github/Teichlab/bin2cell/blob/main/notebooks/N1_demo_b2c_mouse_brain_submission.ipynb) and [downstream analysis](https://nbviewer.org/github/Teichlab/bin2cell/blob/main/notebooks/N2_demo_analysis_mouse_brain_submission.ipynb)
  - Human colorectal cancer [bin2cell](https://nbviewer.org/github/Teichlab/bin2cell/blob/main/notebooks/N1_demo_b2c_crc_submission.ipynb) and [downstream analysis](https://nbviewer.org/github/Teichlab/bin2cell/blob/main/notebooks/N2_demo_analysis_crc_public.ipynb)



  Please cite our [paper](https://doi.org/10.1093/bioinformatics/btae546).


pkgId: c0a1756cb50348e734afe72b8f39120e9a9dc1109c01b99d336b7afc2dc57b08
name: python-bin2coe
arch: src
version: 1.1.1
epoch: 0
release: 1
summary: A tool to convert binary files to COE files
url: https://github.com/anishathalye/bin2coe
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-bin2coe-1.1.1-1.src.rpm
checksum_type: sha256
description:
  Basic usage looks like this:
  ```bash
  bin2coe -i INPUT -w WIDTH -o OUTPUT
  ```
  Additionally, you can specify depth manually (rather than having it be
  inferred), specify a value to fill in empty words, and specify the radix. See
  `bin2coe --help` for more information.


pkgId: e0cec5abfc4025ffbca1c92e9fecb265e1a51b414e0bc2c285e8f849b3a8b6eb
name: python-binance-connector
arch: src
version: 3.9.0
epoch: 0
release: 1
summary: This is a lightweight library that works as a connector to Binance public API.
url: https://github.com/binance/binance-connector-python
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-binance-connector-3.9.0-1.src.rpm
checksum_type: sha256
description:
  [![PyPI version](https://img.shields.io/pypi/v/binance-connector)](https://pypi.python.org/pypi/binance-connector)
  [![Python version](https://img.shields.io/pypi/pyversions/binance-connector)](https://www.python.org/downloads/)
  [![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://binance-connector.readthedocs.io/en/stable/)
  [![Code Style](https://img.shields.io/badge/code_style-black-black)](https://black.readthedocs.io/en/stable/)
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

  This is a lightweight library that works as a connector to [Binance public API](https://github.com/binance/binance-spot-api-docs)

  - Supported APIs:
      - `/api/*`
      - `/sapi/*`
      - Spot Websocket Market Stream
      - Spot User Data Stream
      - Spot WebSocket API
  - Inclusion of test cases and examples
  - Customizable base URL, request timeout and HTTP proxy
  - Response metadata can be displayed



  ```bash
  pip install binance-connector
  ```



  [https://binance-connector.readthedocs.io](https://binance-connector.readthedocs.io)



  Usage examples:
  ```python
  from binance.spot import Spot

  client = Spot()


  print(client.time())

  print(client.klines("BTCUSDT", "1m"))

  print(client.klines("BNBUSDT", "1h", limit=10))


  client = Spot(api_key='<api_key>', api_secret='<api_secret>')


  print(client.account())


  params = {
      'symbol': 'BTCUSDT',
      'side': 'SELL',
      'type': 'LIMIT',
      'timeInForce': 'GTC',
      'quantity': 0.002,
      'price': 9500
  }

  response = client.new_order(**params)
  print(response)
  ```
  Please find `examples` folder to check for more endpoints.
  - In order to set your API and Secret Key for use of the examples, create a file `examples/config.ini` with your keys.
  - Eg:
      ```ini
      
      [keys]
      api_key=abc123456
      api_secret=cba654321
      ```



  Binance supports HMAC, RSA and ED25519 API authentication.

  ```python


  client = Client(api_key, api_secret)
  print(client.account())


  client = Client(api_key=api_key, private_key=private_key)
  print(client.account())


  api_key = ""
  private_key = "./private_key.pem"
  private_key_pass = "<password_if_applicable>"

  with open(private_key, 'rb') as f:
      private_key = f.read()

  spot_client = Client(api_key=api_key, private_key=private_key, private_key_pass=private_key_pass)


  client = Client(api_key=api_key, private_key=private_key, private_key_pass='password')
  print(client.account())
  ```
  Please find `examples/spot/wallet/account_snapshot.py` for more details on ED25519.
  Please find `examples/spot/trade/get_account.py` for more details on RSA.



  [Spot Testnet](https://testnet.binance.vision/) is available, it can be used to test `/api/*` endpoints.

  - `/sapi/*` endpoints are not available.
  - No UI.
  - Steps to setup testnet API key.  [https://dev.binance.vision/t/99](https://dev.binance.vision/t/99)

  To use testnet:
  ```python
  from binance.spot import Spot as Client

  client = Client(base_url='https://testnet.binance.vision')
  print(client.time())
  ```



  If `base_url` is not provided, it defaults to `api.binance.com`.<br/>
  It's recommended to pass in the `base_url` parameter, even in production as Binance provides alternative URLs
  in case of performance issues:
  - `https://api1.binance.com`
  - `https://api2.binance.com`
  - `https://api3.binance.com`



  PEP8 suggests _lowercase with words separated by underscores_, but for this connector,
  the methods' optional parameters should follow their exact naming as in the API documentation.

  ```python

  response = client.cancel_oco_order('BTCUSDT', orderListId=1)


  response = client.cancel_oco_order('BTCUSDT', order_list_id=1)
  ```



  Additional parameter `recvWindow` is available for endpoints requiring signature.<br/>
  It defaults to `5000` (milliseconds) and can be any value lower than `60000`(milliseconds).
  Anything beyond the limit will result in an error response from Binance server.

  ```python
  from binance.spot import Spot as Client

  client = Client(api_key, api_secret)
  response = client.get_order('BTCUSDT', orderId=11, recvWindow=10000)
  ```



  `timeout` is available to be assigned with the number of seconds you find most appropriate to wait for a server response.<br/>
  Please remember the value as it won't be shown in error message _no bytes have been received on the underlying socket for timeout seconds_.<br/>
  By default, `timeout` is None. Hence, requests do not time out.

  ```python
  from binance.spot import Spot as Client

  client= Client(timeout=1)
  ```



  Proxy is supported.

  ```python
  from binance.spot import Spot as Client

  proxies = { 'https': 'http://1.2.3.4:8080' }

  client= Client(proxies=proxies)
  ```




  The Binance API server provides weight usages in the headers of each response.
  You can display them by initializing the client with `show_limit_usage=True`:

  ```python
  from binance.spot import Spot as Client

  client = Client(show_limit_usage=True)
  print(client.time())
  ```
  returns:

  ```python
  {'data': {'serverTime': 1587990847650}, 'limit_usage': {'x-mbx-used-weight': '31', 'x-mbx-used-weight-1m': '31'}}
  ```
  You can also display full response metadata to help in debugging:

  ```python
  client = Client(show_header=True)
  print(client.time())
  ```

  returns:

  ```python
  {'data': {'serverTime': 1587990847650}, 'header': {'Context-Type': 'application/json;charset=utf-8', ...}}
  ```

  If `ClientError` is received, it'll display full response meta information.



  Setting the log level to `DEBUG` will log the request URL, payload and response text.



  There are 2 types of error returned from the library:
  - `binance.error.ClientError`
      - This is thrown when server returns `4XX`, it's an issue from client side.
      - It has 5 properties:
          - `status_code` - HTTP status code
          - `error_code` - Server's error code, e.g. `-1102`
          - `error_message` - Server's error message, e.g. `Unknown order sent.`
          - `header` - Full response header.
          - `error_data`* - Additional detailed data which supplements the `error_message`.
              - **Only applicable on select endpoints, eg. `cancelReplace`*
  - `binance.error.ServerError`
      - This is thrown when server returns `5XX`, it's an issue from server side.





  WebSocket can be established through either of the following types of connections:
  - WebSocket API (`https://github.com/binance/binance-spot-api-docs/blob/master/web-socket-api.md`)
  - WebSocket Stream (`https://github.com/binance/binance-spot-api-docs/blob/master/web-socket-streams.md`)

  ```python


  from binance.websocket.spot.websocket_api import SpotWebsocketAPIClient

  def message_handler(_, message):
      logging.info(message)

  my_client = SpotWebsocketAPIClient(on_message=message_handler)

  my_client.ticker(symbol="BNBBUSD", type="FULL")

  time.sleep(5)
  logging.info("closing ws connection")
  my_client.stop()
  ```

  ```python


  from binance.websocket.spot.websocket_stream import SpotWebsocketStreamClient

  def message_handler(_, message):
      logging.info(message)

  my_client = SpotWebsocketStreamClient(on_message=message_handler)


  my_client.agg_trade(symbol="bnbusdt")
  time.sleep(5)
  logging.info("closing ws connection")
  my_client.stop()
  ```



  Proxy is supported for both WebSocket API and WebSocket Stream.

  To use it, pass in the `proxies` parameter when initializing the client.

  The format of the `proxies` parameter is the same as the one used in the Spot RESTful API.

  It consists on a dictionary with the following format, where the key is the type of the proxy and the value is the proxy URL:

  For websockets, the proxy type is `http`.

  ```python
  proxies = { 'http': 'http://1.2.3.4:8080' }
  ```

  You can also use authentication for the proxy by adding the `username` and `password` parameters to the proxy URL:

  ```python
  proxies = { 'http': 'http://username:password@host:port' }
  ```


  ```python


  from binance.websocket.spot.websocket_api import SpotWebsocketAPIClient

  def message_handler(_, message):
      logging.info(message)

  proxies = { 'http': 'http://1.2.3.4:8080' }

  my_client = SpotWebsocketAPIClient(on_message=message_handler, proxies=proxies, timeout=10)

  my_client.ticker(symbol="BNBBUSD", type="FULL")

  time.sleep(5)
  logging.info("closing ws connection")
  my_client.stop()
  ```

  ```python


  from binance.websocket.spot.websocket_stream import SpotWebsocketStreamClient

  def message_handler(_, message):
      logging.info(message)

  proxies = { 'http': 'http://1.2.3.4:8080' }

  my_client = SpotWebsocketStreamClient(on_message=message_handler, proxies=proxies, timeout=10)


  my_client.agg_trade(symbol="bnbusdt")
  time.sleep(5)
  logging.info("closing ws connection")
  my_client.stop()
  ```



  Client can assign a request id to each request. The request id will be returned in the response message. Not mandatory in the library, it generates a uuid format string if not provided.

  ```python

  my_client.ping_connectivity(id="my_request_id")


  my_client.ping_connectivity()
  ```


  - If you set `is_combined` to `True`, `"/stream/"` will be appended to the `baseURL` to allow for Combining streams.
  - `is_combined` defaults to `False` and `"/ws/"` (raw streams) will be appended to the `baseURL`.

  More websocket examples are available in the `examples` folder.

  Example file "examples/websocket_api/app_demo.py" demonstrates how Websocket API and Websocket Stream can be used together.



  ```python
  from binance.websocket.spot.websocket_client import SpotWebsocketClient as WebsocketClient

  def message_handler(message):
      print(message)

  ws_client = WebsocketClient()
  ws_client.start()

  ws_client.mini_ticker(
      symbol='bnbusdt',
      id=1,
      callback=message_handler,
  )


  ws_client.instant_subscribe(
      stream=['bnbusdt@bookTicker', 'ethusdt@bookTicker'],
      callback=message_handler,
  )

  ws_client.stop()
  ```



  Once connected, the websocket server sends a ping frame every 3 minutes and requires a response pong frame back within
  a 10 minutes period. This package handles the pong responses automatically.



  ```python
  from binance.websocket.spot.websocket_client import SpotWebsocketClient as WebsocketClient

  ws_client = WebsocketClient(stream_url='wss://stream.testnet.binance.vision')
  ```



  ```python

  pip install -r requirements/requirements-test.txt

  python -m pytest tests/
  ```



  Futures and Vanilla Options APIs are not supported:
    - `/fapi/*`
    - `/dapi/*`
    - `/vapi/*`
    -  Associated Websocket Market and User Data Streams



  Contributions are welcome.<br/>
  If you've found a bug within this project, please open an issue to discuss what you would like to change.<br/>
  If it's an issue with the API, please open a topic at [Binance Developer Community](https://dev.binance.vision)


pkgId: f6336ccea36dfc616323066b4104e755e7da68ca9811f194c6fabd8190bc0132
name: python-binance-futures-connector
arch: src
version: 4.0.1
epoch: 0
release: 1
summary: This is a lightweight library that works as a connector to Binance Futures public API.
url: https://github.com/binance/binance-futures-connector-python
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-binance-futures-connector-4.0.1-1.src.rpm
checksum_type: sha256
description:
  [![Python version](https://img.shields.io/pypi/pyversions/binance-futures-connector)](https://www.python.org/downloads/)
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

  This is a lightweight library that works as a connector to [Binance Futures public API](https://developers.binance.com/docs/derivatives/Introduction)

  - Supported APIs:
      - USDT-M Futures `/fapi/*`
      - COIN-M Delivery `/dapi/*`
      - Futures/Delivery Websocket Market Stream
      - Futures/Delivery User Data Stream
  - Inclusion of examples
  - Customizable base URL, request timeout
  - Response metadata can be displayed



  ```bash
  pip install binance-futures-connector
  ```




  Usage examples:
  ```python

  from binance.cm_futures import CMFutures

  cm_futures_client = CMFutures()


  print(cm_futures_client.time())

  cm_futures_client = CMFutures(key='<api_key>', secret='<api_secret>')


  print(cm_futures_client.account())


  params = {
      'symbol': 'BTCUSDT',
      'side': 'SELL',
      'type': 'LIMIT',
      'timeInForce': 'GTC',
      'quantity': 0.002,
      'price': 59808
  }

  response = cm_futures_client.new_order(**params)
  print(response)
  ```
  Please find `examples` folder to check for more endpoints.


  Binance supports HMAC and RSA API authentication.

  ```python

  client = Client(api_key, api_secret)
  print(client.account())


  key = ""
  with open("/Users/john/private_key.pem", "r") as f: # Location of private key file
      private_key = f.read()
  private_key_passphrase = "" # Optional: only used for encrypted RSA key

  client = Client(key=key, private_key=private_key, private_key_passphrase=private_key_passphrase)
  print(client.account())
  ```
  Please see `examples/um_futures/trade/get_account.py` or `examples/cm_futures/trade/get_account.py` for more details.



  For USDT-M Futures, if `base_url` is not provided, it defaults to `fapi.binance.com`.<br/>
  For COIN-M Delivery, if `base_url` is not provided, it defaults to `dapi.binance.com`.<br/>
  It's recommended to pass in the `base_url` parameter, even in production as Binance provides alternative URLs



  PEP8 suggests _lowercase with words separated by underscores_, but for this connector,
  the methods' optional parameters should follow their exact naming as in the API documentation.

  ```python

  response = client.query_order('BTCUSDT', orderListId=1)


  response = client.query_order('BTCUSDT', order_list_id=1)
  ```



  Additional parameter `recvWindow` is available for endpoints requiring signature.<br/>
  It defaults to `5000` (milliseconds) and can be any value lower than `60000`(milliseconds).
  Anything beyond the limit will result in an error response from Binance server.

  ```python
  from binance.cm_futures import CMFutures

  cm_futures_client = CMFutures(key='<api_key>', secret='<api_secret>')
  response = cm_futures_client.query_order('BTCUSDT', orderId=11, recvWindow=10000)
  ```



  `timeout` is available to be assigned with the number of seconds you find most appropriate to wait for a server response.<br/>
  Please remember the value as it won't be shown in error message _no bytes have been received on the underlying socket for timeout seconds_.<br/>
  By default, `timeout` is None. Hence, requests do not time out.

  ```python
  from binance.cm_futures import CMFutures

  client= CMFutures(timeout=1)
  ```


  proxy is supported

  ```python
  from binance.cm_futures import CMFutures

  proxies = { 'https': 'http://1.2.3.4:8080' }

  client= CMFutures(proxies=proxies)
  ```



  The Binance API server provides weight usages in the headers of each response.
  You can display them by initializing the client with `show_limit_usage=True`:

  ```python
  from binance.cm_futures import CMFutures

  client = CMFutures(show_limit_usage=True)
  print(client.time())
  ```
  returns:

  ```python
  {'limit_usage': {'x-mbx-used-weight-1m': '1'}, 'data': {'serverTime': 1653563092778}}
  ```
  You can also display full response metadata to help in debugging:

  ```python
  client = Client(show_header=True)
  print(client.time())
  ```

  returns:

  ```python
  {'data': {'serverTime': 1587990847650}, 'header': {'Context-Type': 'application/json;charset=utf-8', ...}}
  ```

  If `ClientError` is received, it'll display full response meta information.



  Setting the log level to `DEBUG` will log the request URL, payload and response text.



  There are 2 types of error returned from the library:
  - `binance.error.ClientError`
      - This is thrown when server returns `4XX`, it's an issue from client side.
      - It has 4 properties:
          - `status_code` - HTTP status code
          - `error_code` - Server's error code, e.g. `-1102`
          - `error_message` - Server's error message, e.g. `Unknown order sent.`
          - `header` - Full response header.
  - `binance.error.ServerError`
      - This is thrown when server returns `5XX`, it's an issue from server side.





  WebSocket can be established through the following connections:
  - USD-M WebSocket Stream (`https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-market-streams/Connect`)
  - COIN-M WebSocket Stream (`https://developers.binance.com/docs/derivatives/coin-margined-futures/websocket-market-streams/Connect`)

  ```python

  import time
  from binance.websocket.um_futures.websocket_client import UMFuturesWebsocketClient

  def message_handler(_, message):
      logging.info(message)

  my_client = UMFuturesWebsocketClient(on_message=message_handler)


  my_client.agg_trade(symbol="bnbusdt")
  time.sleep(5)
  logging.info("closing ws connection")
  my_client.stop()
  ```



  Client can assign a request id to each request. The request id will be returned in the response message. Not mandatory in the library, it generates a uuid format string if not provided.

  ```python

  my_client.agg_trade(symbol="bnbusdt", id="my_request_id")


  my_client.agg_trade(symbol="bnbusdt")
  ```


  Proxy is supported for both WebSocket CM futures and UM futures.

  To use it, pass in the `proxies` parameter when initializing the client.

  The format of the `proxies` parameter is the same as the one used in the Spot RESTful API.

  It consists on a dictionary with the following format, where the key is the type of the proxy and the value is the proxy URL:

  For websockets, the proxy type is `http`.

  ```python
  proxies = { 'http': 'http://1.2.3.4:8080' }
  ```

  You can also use authentication for the proxy by adding the `username` and `password` parameters to the proxy URL:

  ```python
  proxies = { 'http': 'http://username:password@host:port' }
  ```

  ```python

  import time
  from binance.websocket.um_futures.websocket_client import UMFuturesWebsocketClient

  proxies = {'http': 'http://1.2.3.4:8080'}

  def message_handler(_, message):
      logging.info(message)

  my_client = UMFuturesWebsocketClient(on_message=message_handler, proxies=proxies)


  my_client.agg_trade(symbol="bnbusdt")
  time.sleep(5)
  logging.info("closing ws connection")
  my_client.stop()
  ```



  - If you set `is_combined` to `True`, `"/stream/"` will be appended to the `baseURL` to allow for Combining streams.
  - `is_combined` defaults to `False` and `"/ws/"` (raw streams) will be appended to the `baseURL`.

  More websocket examples are available in the `examples` folder



  ```python
  import time
  from binance.websocket.um_futures.websocket_client import UMFuturesWebsocketClient

  def message_handler(message):
      print(message)

  my_client = UMFuturesWebsocketClient(on_message=message_handler)


  my_client.agg_trade(symbol="bnbusdt")
  time.sleep(5)
  print("closing ws connection")
  my_client.stop()

  ```



  Once connected, the websocket server sends a ping frame every 3 minutes and requires a response pong frame back within
  a 10 minutes period. This package handles the pong responses automatically.


  MIT


pkgId: 049b5d305d861b0873f414831d1be4f5c4d45579a0d5a4d8116633a2bda2966e
name: python-binance-interface
arch: src
version: 2.0.5
epoch: 0
release: 1
summary: Python Binance API Interface and Advanced APP Packaging Methods
url: https://github.com/pyted/binance_interface
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-binance-interface-2.0.5-1.src.rpm
checksum_type: sha256
description:
  安装：

  ```cmd
  pip3 install binance_interface==2.0.3
  ```



  使用教程请参考examples

  - 1.1 Binance_Interface安装与介绍
  - 1.2 API函数接口总览
  - 1.3 API 现货行情接口.ipynb
  - 1.4 API U本位合约行情.ipynb
  - 1.5 API 币本位合约行情.ipynb
  - 1.6 API 现货交易账户.ipynb
  - 1.7 API U本位合约交易账户.ipynb
  - 1.8 API 币本位合约交易账户.ipynb
  - 2.1 APP 现货交易账户.ipynb
  - 2.2 APP 现货行情-交易规则信息.ipynb
  - 2.3 APP 现货行情-实时行情.ipynb
  - 2.4 APP 现货行情-历史K线.ipynb
  - 2.5 APP 现货交易-基础订单.ipynb
  - 2.6 APP 现货交易-价格与数量.ipynb
  - 2.7 APP 现货交易-限价单开仓.ipynb
  - 2.8 APP 现货交易-市价单开仓.ipynb
  - 2.9 APP 现货交易-限单价平仓.ipynb
  - 2.10 APP 现货交易-市单价平仓.ipynb
  - 3.1 APP U本位合约交易账户.ipynb
  - 3.2 APP U本位合约行情-交易规则信息.ipynb
  - 3.3 APP U本位合约行情-实时行情.ipynb
  - 3.4 APP U本位合约行情-历史K线.ipynb
  - 3.5 APP U本位合约交易-基础订单.ipynb
  - 3.6 APP U本位合约交易-价格与数量.ipynb
  - 3.7 APP U本位合约交易-限价单开仓.ipynb
  - 3.8 APP U本位合约交易-市价单开仓.ipynb
  - 3.9 APP U本位合约交易-限单价平仓.ipynb
  - 3.10 APP U本位合约交易-市单价平仓.ipynb
  - 4.1 APP 币本位合约交易账户.ipynb
  - 4.2 APP 币本位合约行情-交易规则信息.ipynb
  - 4.3 APP 币本位合约行情-实时行情.ipynb
  - 4.4 APP 币本位合约行情-历史K线.ipynb
  - 4.5 APP 币本位合约交易-基础订单.ipynb
  - 4.6 APP 币本位合约交易-价格与数量.ipynb
  - 4.7 APP 币本位合约交易-限价单开仓.ipynb
  - 4.8 APP 币本位合约交易-市价单开仓.ipynb
  - 4.9 APP 币本位合约交易-限单价平仓.ipynb
  - 4.10 APP 币本位合约交易-市单价平仓.ipynb
  - 5.1 APP K线服务 下载历史K线.ipynb
  - 5.2 APP K线服务 每日定时下载昨日历史K线.ipynb
  - 5.3 APP K线服务 维护实时历史K线.ipynb



  - 更新日期：2024-02-08
  - 同步官方文档全部Rest接口
  - 添加代理IP与代理服务器转发功能



  - 修正candle_map实时K线服务因各个产品的最新K线数据更新时间的不同而造成的candle验证误删。


pkgId: 3b6d9e25ef2d2fee449311b684e6f344c323fe89ad49f370e8dae6f6f81148b1
name: python-binance-klines
arch: src
version: 0.1.1
epoch: 0
release: 1
url: https://pypi.org/project/binance-klines/
rpm_license: UNKNOWN
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-binance-klines-0.1.1-1.src.rpm
checksum_type: sha256
summary:
  BinanceKlines - A tool to download OHLCV candlestick data (K-Lines) from Binance. Written in Python.

description:
  BinanceKlines downloader is a simple command line tool and Python library used to download OHLCV k-lines from Binance. It works asynchronously to download candlestick market data from multiple symbols concurrently.




  ```console
  $ git clone git@github.com:fievelk/binance-klines.git  # Clone the project
  $ cd binance-klines/
  $ pip install .
  ```



  BinanceKlines can be used both as command line tool and Python module. The tool fetches data from Binance's [`GET /api/v3/klines`](https://binance-docs.github.io/apidocs/spot/en/#kline-candlestick-data) endpoint.




  You can check all the available options using `binance-klines --help`.

  ```console
  $ binance-klines --help
  usage: binance-klines [-h] [-v] --start-date START_DATE [--end-date END_DATE] [-o OUTPUT_DIR]
                        [--timeframe {1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,1M}]
                        symbols [symbols ...]

  positional arguments:
    symbols               The list of currencies whose OHLCV will be fetched.

  options:
    -h, --help            show this help message and exit
    -v, --verbose         Increase output verbosity. -v: INFO, -vv: DEBUG.
                          Default: WARNING.
    --start-date START_DATE
                          (Required) Start downloading data from this date. E.g.: 2019-01-24 00:00:00
    --end-date END_DATE   Download data up to this date. E.g.: 2020-05-30 00:00:00.
                          Default: now.
    -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                          The data directory to store the output CSV files.
                          Default: the current directory.
    --timeframe {1m,3m,5m,15m,30m,1h,2h,4h,6h,8h,12h,1d,3d,1w,1M}
                          The frequency of the OHLCV data to be downloaded.
                          Default: 1h.
  ```

  Here is an example of how to download 1-minutes candlestick data for BTC/USDT and ETH/USDT from 18th July 2022 to 20th July 2022:

  ```console
  $ binance-klines --start-date "2022-07-18 00:00:00" \
      --end-date "2022-07-20 23:59:00" --timeframe '1m' --output-dir .data/ \
      --symbols BTC/USDT ETH/USDT
  ```



  ```py
  import asyncio
  import datetime

  import pytz

  from binance_klines.downloader import BinanceKLinesDownloader


  async def main():
      downloader = BinanceKLinesDownloader()
      start_date = datetime.datetime(2020, 9, 1).replace(tzinfo=pytz.utc)
      end_date = datetime.datetime(2020, 9, 2).replace(tzinfo=pytz.utc)

      
      results = await downloader.fetch_klines(
          symbols=["BTC/USDT", "ETH/USDT"],
          start_date=start_date,
          end_date=end_date,
          timeframe="30m",
      )

      
      
      btc_batches = results[0]
      eth_batches = results[1]


  if __name__ == "__main__":
      asyncio.run(main())
  ```



  Tests are written using `pytest`. To test compatibility among several Python versions, install the dev dependencies using Poetry and run tests using tox:

  ```console
  $ poetry install --with dev  # Install dependencies
  $ poetry shell  # Activate Poetry environment
  $ tox
  ```



  You are welcome to contribute by opening a PR with your improvements. Please make sure to run the Black linter before you do. You can use `tox` for this:

  ```console
  $ tox -e lint
  ```




  - [ ] Change logging of utils.timeit to DEBUG
  - [ ] Remove ccxt and use aiohttp directly


