rdblue commented on code in PR #5672: URL: https://github.com/apache/iceberg/pull/5672#discussion_r962038342
########## docs/python-quickstart.md: ########## @@ -26,45 +26,431 @@ menu: --> -# Python API Quickstart +# Python CLI Quickstart -## Installation +Pyiceberg ships with a CLI that's available after installing the package. -Iceberg python is currently in development, for development and testing purposes the best way to install the library is to perform the following steps: +```sh +➜ pyiceberg --help +Usage: pyiceberg [OPTIONS] COMMAND [ARGS]... + +Options: + --catalog TEXT + --verbose BOOLEAN + --output [text|json] + --uri TEXT + --credential TEXT + --help Show this message and exit. + +Commands: + describe Describes a namespace xor table + drop Operations to drop a namespace or table + list Lists tables or namespaces + location Returns the location of the table + properties Properties on tables/namespaces + rename Renames a table + schema Gets the schema of the table + spec Returns the partition spec of the table + uuid Returns the UUID of the table +``` + +Browsing the catalog + +```sh +➜ pyiceberg --uri thrift://localhost:9083 list +default +nyc +``` + +```sh +➜ pyiceberg --uri thrift://localhost:9083 list nyc +nyc.taxis ``` -git clone https://github.com/apache/iceberg.git -cd iceberg/python -pip install -e . + +```sh +➜ pyiceberg --uri thrift://localhost:9083 list nyc Review Comment: What do you think about having a section early on for the config file so that we can avoid having `--uri` in every command? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
