sharex-cli 0.0.1__tar.gz → 0.0.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. {sharex_cli-0.0.1 → sharex_cli-0.0.2}/PKG-INFO +29 -33
  2. {sharex_cli-0.0.1 → sharex_cli-0.0.2}/README.md +28 -32
  3. {sharex_cli-0.0.1 → sharex_cli-0.0.2}/pyproject.toml +5 -4
  4. sharex_cli-0.0.2/src/sharex/_version.py +2 -0
  5. sharex_cli-0.0.1/src/sharex/_version.py +0 -2
  6. {sharex_cli-0.0.1 → sharex_cli-0.0.2}/.gitignore +0 -0
  7. {sharex_cli-0.0.1 → sharex_cli-0.0.2}/LICENSE +0 -0
  8. {sharex_cli-0.0.1 → sharex_cli-0.0.2}/src/sharex/__init__.py +0 -0
  9. {sharex_cli-0.0.1 → sharex_cli-0.0.2}/src/sharex/api.py +0 -0
  10. {sharex_cli-0.0.1 → sharex_cli-0.0.2}/src/sharex/cli.py +0 -0
  11. {sharex_cli-0.0.1 → sharex_cli-0.0.2}/src/sharex/py.typed +0 -0
  12. {sharex_cli-0.0.1 → sharex_cli-0.0.2}/src/sharex/utils.py +0 -0
{sharex_cli-0.0.1 → sharex_cli-0.0.2}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sharex-cli
3
- Version: 0.0.1
3
+ Version: 0.0.2
4
4
  Summary: CLI to Upload Files to a ShareX Server using a ShareX Custom Uploader (.sxcu) Configuration File.
5
5
  Project-URL: Changelog, https://github.com/cssnr/sharex-cli/releases
6
6
  Project-URL: Discord, https://discord.gg/wXy6m2X8wY
@@ -54,16 +54,16 @@ Description-Content-Type: text/markdown
54
54
 
55
55
  - [Features](#features)
56
56
  - [Install](#install)
57
- - [Setup](#setup)
57
+ - [Configure](#configure)
58
58
  - [Usage](#usage)
59
59
  - [Support](#support)
60
60
  - [Contributing](#contributing)
61
61
 
62
- Command Line Interface to Upload Files to a ShareX Server using a ShareX Custom Uploader `.sxcu` configuration file.
62
+ Command Line Interface to Upload Files to a ShareX Server using a ShareX Custom Uploader `.sxcu` configuration.
63
63
 
64
64
  Upload any file, multiple files, directories, use globs, create archives and much more...
65
65
 
66
- To get started [Install](#install) the app and view the [Usage](#usage).
66
+ To get started [Install](#install) the app, [Configure](#configure) your server and view the [Usage](#usage).
67
67
 
68
68
  If you run into any issues or have any questions, [support](#support) is available.
69
69
 
@@ -89,80 +89,76 @@ From PyPI: <https://pypi.org/p/sharex-cli>
89
89
  pip install sharex-cli
90
90
  ```
91
91
 
92
- From GitHub.
92
+ ```shell
93
+ uv tool install sharex-cli
94
+ ```
95
+
96
+ From GitHub: [https://github.com/cssnr/sharex-cli](https://github.com/cssnr/sharex-cli?tab=readme-ov-file#readme)
93
97
 
94
98
  ```shell
95
99
  pip install git+https://github.com/cssnr/sharex-cli.git
96
100
  ```
97
101
 
98
- From source.
99
-
100
102
  ```shell
101
- git clone https://github.com/cssnr/sharex-cli.git
102
- pip install sharex-cli
103
+ uv tool install git+https://github.com/cssnr/sharex-cli.git
103
104
  ```
104
105
 
105
106
  [![View Install Guide](https://img.shields.io/badge/view_install_guide-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/sharex-cli/cli/#install)
106
107
 
107
- ## Setup<a id="setup"></a>
108
+ ## Configure<a id="configure"></a>
108
109
 
109
110
  To configure you need your server's ShareX Custom Uploader `*.sxcu` configuration JSON.
110
111
 
111
- The app will automatically enter configuration on the first run.
112
+ The `--config` command allows you to enter the file path, or open a text editor.
112
113
 
113
114
  ```shell
114
- sharex
115
+ sharex --config
115
116
  ```
116
117
 
117
- This allows you to enter a file path, or open a text editor to enter the contents.
118
-
119
- You can reconfigure with `--config` and pass a path to the config file.
118
+ Or pass the config path directly to `--config`.
120
119
 
121
120
  ```shell
122
121
  sharex --config path/to/config.sxcu
123
122
  ```
124
123
 
125
- [![View Setup Guide](https://img.shields.io/badge/view_setup_guide-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/sharex-cli/cli/#setup)
124
+ [![View Configure Guide](https://img.shields.io/badge/view_configure_guide-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/sharex-cli/cli/#configure)
126
125
 
127
126
  ## Usage<a id="usage"></a>
128
127
 
129
- Once the configuration is saved you can upload a file, or multiple.
128
+ To use run the `sharex` command with the path to the file to upload.
130
129
 
131
130
  ```shell
132
- sharex file1.txt /path/to/file2.txt
131
+ sharex file.txt
132
+ sharex file1.txt file2.txt
133
+ sharex file.txt -n name.txt
133
134
  ```
134
135
 
135
- You can upload the contents of a directory, default glob is `*`.
136
+ Directories can be uploaded as files using a glob (default `*`) or as an archive.
136
137
 
137
138
  ```shell
138
- sharex dir1
139
+ sharex dir1 # non-recursive
140
+ sharex dir1 -g '**' # recursive
141
+ sharex dir1 -a # create an archive
139
142
  ```
140
143
 
141
- Or create an archive of the directory (no glob support).
142
-
143
- ```shell
144
- sharex /path/to/dir2 -a
145
- ```
144
+ Tip: you will be shown a confirmation before files are uploaded.
146
145
 
147
- [![View Uploading Guide](https://img.shields.io/badge/view_usage_examples-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/sharex-cli/cli/#uploading)
146
+ [![View Upload Guide](https://img.shields.io/badge/view_upload_guide-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/sharex-cli/cli/#upload)
148
147
 
149
148
  ## Support<a id="support"></a>
150
149
 
151
- For general help or to request a feature, see:
150
+ If you run into any issues or need help getting started, please do one of the following:
152
151
 
152
+ - Report an Issue: <https://github.com/cssnr/sharex-cli/issues>
153
153
  - Q&A Discussion: <https://github.com/cssnr/sharex-cli/discussions/categories/q-a>
154
154
  - Request a Feature: <https://github.com/cssnr/sharex-cli/issues/new?template=1-feature.yaml>
155
- - Chat with us on Discord: <https://discord.gg/wXy6m2X8wY>
156
-
157
- If you are experiencing an issue/bug or getting unexpected results, you can:
158
-
159
- - Report an Issue: <https://github.com/cssnr/sharex-cli/issues>
155
+ - Request Server Support: <https://github.com/cssnr/sharex-cli/issues/new?template=2-server.yaml>
160
156
  - Chat with us on Discord: <https://discord.gg/wXy6m2X8wY>
161
157
 
162
158
  [![Features](https://img.shields.io/badge/features-brightgreen?style=for-the-badge&logo=googleanalytics&logoColor=white)](https://github.com/cssnr/sharex-cli/issues/new?template=1-feature.yaml)
163
159
  [![Issues](https://img.shields.io/badge/issues-red?style=for-the-badge&logo=southwestairlines&logoColor=white)](https://github.com/cssnr/sharex-cli/issues)
164
160
  [![Discussions](https://img.shields.io/badge/discussions-blue?style=for-the-badge&logo=rocketdotchat&logoColor=white)](https://github.com/cssnr/sharex-cli/discussions)
165
- [![Discord](https://img.shields.io/badge/discord-%235865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/wXy6m2X8wY)
161
+ [![Discord](https://img.shields.io/badge/discord-yellow?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/wXy6m2X8wY)
166
162
 
167
163
  ## Contributing<a id="contributing"></a>
168
164
 
{sharex_cli-0.0.1 → sharex_cli-0.0.2}/README.md RENAMED
@@ -27,16 +27,16 @@
27
27
 
28
28
  - [Features](#features)
29
29
  - [Install](#install)
30
- - [Setup](#setup)
30
+ - [Configure](#configure)
31
31
  - [Usage](#usage)
32
32
  - [Support](#support)
33
33
  - [Contributing](#contributing)
34
34
 
35
- Command Line Interface to Upload Files to a ShareX Server using a ShareX Custom Uploader `.sxcu` configuration file.
35
+ Command Line Interface to Upload Files to a ShareX Server using a ShareX Custom Uploader `.sxcu` configuration.
36
36
 
37
37
  Upload any file, multiple files, directories, use globs, create archives and much more...
38
38
 
39
- To get started [Install](#install) the app and view the [Usage](#usage).
39
+ To get started [Install](#install) the app, [Configure](#configure) your server and view the [Usage](#usage).
40
40
 
41
41
  If you run into any issues or have any questions, [support](#support) is available.
42
42
 
@@ -62,80 +62,76 @@ From PyPI: <https://pypi.org/p/sharex-cli>
62
62
  pip install sharex-cli
63
63
  ```
64
64
 
65
- From GitHub.
65
+ ```shell
66
+ uv tool install sharex-cli
67
+ ```
68
+
69
+ From GitHub: [https://github.com/cssnr/sharex-cli](https://github.com/cssnr/sharex-cli?tab=readme-ov-file#readme)
66
70
 
67
71
  ```shell
68
72
  pip install git+https://github.com/cssnr/sharex-cli.git
69
73
  ```
70
74
 
71
- From source.
72
-
73
75
  ```shell
74
- git clone https://github.com/cssnr/sharex-cli.git
75
- pip install sharex-cli
76
+ uv tool install git+https://github.com/cssnr/sharex-cli.git
76
77
  ```
77
78
 
78
79
  [![View Install Guide](https://img.shields.io/badge/view_install_guide-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/sharex-cli/cli/#install)
79
80
 
80
- ## Setup<a id="setup"></a>
81
+ ## Configure<a id="configure"></a>
81
82
 
82
83
  To configure you need your server's ShareX Custom Uploader `*.sxcu` configuration JSON.
83
84
 
84
- The app will automatically enter configuration on the first run.
85
+ The `--config` command allows you to enter the file path, or open a text editor.
85
86
 
86
87
  ```shell
87
- sharex
88
+ sharex --config
88
89
  ```
89
90
 
90
- This allows you to enter a file path, or open a text editor to enter the contents.
91
-
92
- You can reconfigure with `--config` and pass a path to the config file.
91
+ Or pass the config path directly to `--config`.
93
92
 
94
93
  ```shell
95
94
  sharex --config path/to/config.sxcu
96
95
  ```
97
96
 
98
- [![View Setup Guide](https://img.shields.io/badge/view_setup_guide-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/sharex-cli/cli/#setup)
97
+ [![View Configure Guide](https://img.shields.io/badge/view_configure_guide-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/sharex-cli/cli/#configure)
99
98
 
100
99
  ## Usage<a id="usage"></a>
101
100
 
102
- Once the configuration is saved you can upload a file, or multiple.
101
+ To use run the `sharex` command with the path to the file to upload.
103
102
 
104
103
  ```shell
105
- sharex file1.txt /path/to/file2.txt
104
+ sharex file.txt
105
+ sharex file1.txt file2.txt
106
+ sharex file.txt -n name.txt
106
107
  ```
107
108
 
108
- You can upload the contents of a directory, default glob is `*`.
109
+ Directories can be uploaded as files using a glob (default `*`) or as an archive.
109
110
 
110
111
  ```shell
111
- sharex dir1
112
+ sharex dir1 # non-recursive
113
+ sharex dir1 -g '**' # recursive
114
+ sharex dir1 -a # create an archive
112
115
  ```
113
116
 
114
- Or create an archive of the directory (no glob support).
115
-
116
- ```shell
117
- sharex /path/to/dir2 -a
118
- ```
117
+ Tip: you will be shown a confirmation before files are uploaded.
119
118
 
120
- [![View Uploading Guide](https://img.shields.io/badge/view_usage_examples-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/sharex-cli/cli/#uploading)
119
+ [![View Upload Guide](https://img.shields.io/badge/view_upload_guide-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/sharex-cli/cli/#upload)
121
120
 
122
121
  ## Support<a id="support"></a>
123
122
 
124
- For general help or to request a feature, see:
123
+ If you run into any issues or need help getting started, please do one of the following:
125
124
 
125
+ - Report an Issue: <https://github.com/cssnr/sharex-cli/issues>
126
126
  - Q&A Discussion: <https://github.com/cssnr/sharex-cli/discussions/categories/q-a>
127
127
  - Request a Feature: <https://github.com/cssnr/sharex-cli/issues/new?template=1-feature.yaml>
128
- - Chat with us on Discord: <https://discord.gg/wXy6m2X8wY>
129
-
130
- If you are experiencing an issue/bug or getting unexpected results, you can:
131
-
132
- - Report an Issue: <https://github.com/cssnr/sharex-cli/issues>
128
+ - Request Server Support: <https://github.com/cssnr/sharex-cli/issues/new?template=2-server.yaml>
133
129
  - Chat with us on Discord: <https://discord.gg/wXy6m2X8wY>
134
130
 
135
131
  [![Features](https://img.shields.io/badge/features-brightgreen?style=for-the-badge&logo=googleanalytics&logoColor=white)](https://github.com/cssnr/sharex-cli/issues/new?template=1-feature.yaml)
136
132
  [![Issues](https://img.shields.io/badge/issues-red?style=for-the-badge&logo=southwestairlines&logoColor=white)](https://github.com/cssnr/sharex-cli/issues)
137
133
  [![Discussions](https://img.shields.io/badge/discussions-blue?style=for-the-badge&logo=rocketdotchat&logoColor=white)](https://github.com/cssnr/sharex-cli/discussions)
138
- [![Discord](https://img.shields.io/badge/discord-%235865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/wXy6m2X8wY)
134
+ [![Discord](https://img.shields.io/badge/discord-yellow?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/wXy6m2X8wY)
139
135
 
140
136
  ## Contributing<a id="contributing"></a>
141
137
 
{sharex_cli-0.0.1 → sharex_cli-0.0.2}/pyproject.toml RENAMED
@@ -32,6 +32,7 @@ Issues = "https://github.com/cssnr/sharex-cli/issues"
32
32
 
33
33
  [project.scripts]
34
34
  sharex = "sharex.cli:app"
35
+ sharex-cli = "sharex.cli:app"
35
36
 
36
37
  [dependency-groups]
37
38
  dev = [
@@ -42,10 +43,10 @@ dev = [
42
43
  "isort>=7.0.0",
43
44
  "mypy>=1.19.1",
44
45
  "pytest>=9.0.2",
45
- "ruff>=0.14.9",
46
- "tombi>=0.7.7",
47
- "ty>=0.0.2",
48
- "typer>=0.20.0",
46
+ "ruff>=0.14.10",
47
+ "tombi>=0.7.8",
48
+ "ty>=0.0.4",
49
+ "typer>=0.20.1",
49
50
  "types-pyperclip>=1.9.0.20250801",
50
51
  "types-requests>=2.32.4.20250913",
51
52
  "validate-pyproject[all]>=0.24.1",
sharex_cli-0.0.2/src/sharex/_version.py ADDED
@@ -0,0 +1,2 @@
1
+ # The string "0.0.2" is used in .github/workflows/build.yaml
2
+ __version__ = "0.0.2"
sharex_cli-0.0.1/src/sharex/_version.py DELETED
@@ -1,2 +0,0 @@
1
- # The string "0.0.1" is used in .github/workflows/build.yaml
2
- __version__ = "0.0.1"
{sharex_cli-0.0.1 → sharex_cli-0.0.2}/.gitignore RENAMED
File without changes
{sharex_cli-0.0.1 → sharex_cli-0.0.2}/LICENSE RENAMED
File without changes
{sharex_cli-0.0.1 → sharex_cli-0.0.2}/src/sharex/api.py RENAMED
File without changes
{sharex_cli-0.0.1 → sharex_cli-0.0.2}/src/sharex/cli.py RENAMED
File without changes