diff --git a/.gitattributes b/.gitattributes index c252504..4f4b785 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,3 +1,4 @@ +.github/** export-ignore .gitattributes export-ignore .gitignore export-ignore README.md export-ignore diff --git a/README.md b/README.md index a4b7e26..228b253 100644 --- a/README.md +++ b/README.md @@ -44,19 +44,19 @@ proxy=http://127.0.0.1:3128 All possible options for configuration file ----- -| Option | Default | Possible value | -|--------|---------|---------| -server | https://paste.i2pd.xyz/ | Domain ending with slash | -mirrors | None | Domains separated with comma, like `http://privatebin.ygg/,http://privatebin.i2p/` | -proxy | None | Proxy address starting with scheme `http://` or `socks5://` | -short | False | True / False | -short_api | None | `tinyurl`, `clckru`, `isgd`, `vgd`, `cuttly`, `yourls`, `custom` | -short_url | None | Domain name of shortener service for `yourls`, or sortener URL (with required parameters) for `custom` | -short_user | None | Used only in `yourls` | -short_pass | None | Used only in `yourls` | -short_token | None | Used only in `yourls` | -no_check_certificate | False | True / False | -no_insecure_warning | False | True / False | +| Option | Default | Possible value | +|----------------------|-------------------------|----------------| +| server | https://paste.i2pd.xyz/ | Domain ending with slash | +| mirrors | None | Domains separated with comma, like `http://privatebin.ygg/,http://privatebin.i2p/` | +| proxy | None | Proxy address starting with scheme `http://` or `socks5://` | +| short | False | True / False | +| short_api | None | `tinyurl`, `clckru`, `isgd`, `vgd`, `cuttly`, `yourls`, `custom` | +| short_url | None | Domain name of shortener service for `yourls`, or sortener URL (with required parameters) for `custom` | +| short_user | None | Used only in `yourls` | +| short_pass | None | Used only in `yourls` | +| short_token | None | Used only in `yourls` | +| no_check_certificate | False | True / False | +| no_insecure_warning | False | True / False | Usage ===== @@ -91,7 +91,7 @@ pbincli send -f info.pdf -t "I'm sending my document." pbincli send -q -f info.pdf ``` -__*Note*__: It is possible to set-up paste parameters such as burning after reading, expiritaion time, formatting, enabling discussions, and changing compression algorithm. Please refer to `pbincli send -h` output for more information. +*Note*: It is possible to set-up paste parameters such as burning after reading, expiritaion time, formatting, enabling discussions, and changing compression algorithm. Please refer to `pbincli send -h` output for more information. Receiving ----- @@ -141,5 +141,4 @@ Call it by running `pastei2p` in terminal. License ===== -This project is licensed under the MIT license, which can be found in the file -[LICENSE](https://github.com/r4sas/PBinCLI/blob/master/LICENSE) in the root of the project source code. +This project is licensed under the MIT license, which can be found in the file [LICENSE](https://github.com/r4sas/PBinCLI/blob/master/LICENSE) in the root of the project source code. diff --git a/README.rst b/README.rst index 0bd59f8..409d244 100644 --- a/README.rst +++ b/README.rst @@ -65,21 +65,41 @@ All possible options for configuration file * - Option - Default - Possible value - * - + * - server + - https://paste.i2pd.xyz/ + - Domain ending with slash + * - mirrors + - None + - Domains separated with comma, like ``http://privatebin.ygg/,http://privatebin.i2p/`` + * - proxy + - None + - Proxy address starting with scheme ``http://`` or ``socks5://`` + * - short + - False + - True / False + * - short_api + - None + - ``tinyurl``\ , ``clckru``\ , ``isgd``\ , ``vgd``\ , ``cuttly``\ , ``yourls``\ , ``custom`` + * - short_url + - None + - Domain name of shortener service for ``yourls``\ , or sortener URL (with required parameters) for ``custom`` + * - short_user + - None + - Used only in ``yourls`` + * - short_pass + - None + - Used only in ``yourls`` + * - short_token + - None + - Used only in ``yourls`` + * - no_check_certificate + - False + - True / False + * - no_insecure_warning + - False + - True / False -server | https://paste.i2pd.xyz/ | Domain ending with slash | -mirrors | None | Domains separated with comma, like ``http://privatebin.ygg/,http://privatebin.i2p/`` | -proxy | None | Proxy address starting with scheme ``http://`` or ``socks5://`` | -short | False | True / False | -short_api | None | ``tinyurl``\ , ``clckru``\ , ``isgd``\ , ``vgd``\ , ``cuttly``\ , ``yourls``\ , ``custom`` | -short_url | None | Domain name of shortener service for ``yourls``\ , or sortener URL (with required parameters) for ``custom`` | -short_user | None | Used only in ``yourls`` | -short_pass | None | Used only in ``yourls`` | -short_token | None | Used only in ``yourls`` | -no_check_certificate | False | True / False | -no_insecure_warning | False | True / False | - Usage ===== @@ -123,7 +143,7 @@ Sending pbincli send -q -f info.pdf -**\ *Note*\ **\ : It is possible to set-up paste parameters such as burning after reading, expiritaion time, formatting, enabling discussions, and changing compression algorithm. Please refer to ``pbincli send -h`` output for more information. +*Note*\ : It is possible to set-up paste parameters such as burning after reading, expiritaion time, formatting, enabling discussions, and changing compression algorithm. Please refer to ``pbincli send -h`` output for more information. Receiving --------- @@ -177,5 +197,4 @@ Call it by running ``pastei2p`` in terminal. License ======= -This project is licensed under the MIT license, which can be found in the file -`LICENSE `_ in the root of the project source code. +This project is licensed under the MIT license, which can be found in the file `LICENSE `_ in the root of the project source code. diff --git a/pbincli/__init__.py b/pbincli/__init__.py index a31e423..c119273 100644 --- a/pbincli/__init__.py +++ b/pbincli/__init__.py @@ -2,6 +2,6 @@ # -*- coding: utf-8 -*- __author__ = "R4SAS " -__version__ = "0.3.2b1" +__version__ = "0.3.2" __copyright__ = "Copyright (c) R4SAS" __license__ = "MIT" diff --git a/pbincli/cli.py b/pbincli/cli.py index 0c9d7e8..0492bd0 100755 --- a/pbincli/cli.py +++ b/pbincli/cli.py @@ -31,7 +31,7 @@ def read_config(filename): return settings def main(): - parser = argparse.ArgumentParser() + parser = argparse.ArgumentParser(description='Full-featured PrivateBin command-line client') subparsers = parser.add_subparsers(title="actions", help="List of commands") # a send command