qdown 1.0.5__tar.gz → 1.1.0__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.
qdown-1.1.0/PKG-INFO ADDED
@@ -0,0 +1,133 @@
1
+ Metadata-Version: 2.1
2
+ Name: qdown
3
+ Version: 1.1.0
4
+ Summary: Client for QualitegDrive
5
+ Home-page: https://github.com/qualiteg/qdown
6
+ Author: Qualiteg Inc.
7
+ Author-email: qualiteger@qualiteg.com
8
+ Classifier: Development Status :: 3 - Alpha
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: License :: OSI Approved :: MIT License
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Programming Language :: Python :: 3.7
13
+ Classifier: Programming Language :: Python :: 3.8
14
+ Classifier: Programming Language :: Python :: 3.9
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Requires-Python: >=3.7
17
+ Description-Content-Type: text/markdown
18
+
19
+ # qdown
20
+
21
+ A Python client for downloading files from QualitegDrive operated by Qualiteg Inc.
22
+
23
+ [Japanese](README.ja.md)
24
+
25
+ ## Install
26
+
27
+ ```
28
+ pip install qdown
29
+ ```
30
+
31
+ or
32
+
33
+ ```
34
+ pip install git+https://github.com/qualiteg/qdown.git
35
+ ```
36
+
37
+ ## Usage
38
+
39
+ ```
40
+ qdown ID [options]
41
+
42
+ Options:
43
+ -O FILENAME Specify output filename
44
+ -o DIR Specify output directory
45
+ -s SERVER Specify server URL (default: https://drive.qualiteg.com)
46
+ -q, --quiet Hide progress display
47
+ --skip-check Skip file existence check (fastest download)
48
+ --use-head Use HEAD request (legacy behavior)
49
+ -h, --help Display help
50
+ ```
51
+
52
+ ### New Features (v1.1+)
53
+
54
+ Enhanced support for large files and improved performance:
55
+
56
+ **New Options:**
57
+ - `--skip-check`: Skip file existence verification for fastest download (recommended for large files)
58
+ - `--use-head`: Use HEAD request method (default is disabled to prevent timeouts)
59
+
60
+ **Improvements:**
61
+ - HEAD requests are now skipped by default (resolves timeout issues with large files)
62
+ - File existence verification via `/file/{id}` endpoint (more reliable)
63
+
64
+ ## Download Examples
65
+
66
+ ### Example 1: Basic Download
67
+ ```
68
+ qdown xxxxxxxxxxxxx -O my_file.txt
69
+ ```
70
+
71
+ ### Example 2: From Your Original HTTP Server
72
+ ```
73
+ qdown xxxxxxxxxxxxx -O my_file.txt -s http://host.docker.internal:3000
74
+ ```
75
+
76
+ ### Example 3: Fast Download for Large Files (v1.1+)
77
+ ```
78
+ # Skip all checks for maximum speed
79
+ qdown xxxxxxxxxxxxx -O large_file.zip --skip-check
80
+
81
+ # Silent mode with skip check
82
+ qdown xxxxxxxxxxxxx -O huge_file.zip --skip-check -q
83
+ ```
84
+
85
+ ### Example 4: Legacy Behavior (v1.1+)
86
+ ```
87
+ # Use traditional HEAD request (if needed for compatibility)
88
+ qdown xxxxxxxxxxxxx -O file.txt --use-head
89
+ ```
90
+
91
+ ## Python API
92
+
93
+ ```python
94
+ import qdown
95
+
96
+ # Basic download
97
+ file_path = qdown.download("file_id_here")
98
+
99
+ # Download with output filename
100
+ file_path = qdown.download("file_id_here", output_path="my_file.txt")
101
+
102
+ # Download from custom server
103
+ file_path = qdown.download(
104
+ "file_id_here",
105
+ output_path="my_file.txt",
106
+ server_url="http://localhost:3000"
107
+ )
108
+
109
+ # Fast download for large files (v1.1+)
110
+ file_path = qdown.download(
111
+ "file_id_here",
112
+ output_path="large_file.zip",
113
+ skip_exists_check=True, # Skip existence check
114
+ skip_head=True, # Skip HEAD request (default)
115
+ quiet=True # Silent mode
116
+ )
117
+
118
+ # Use legacy behavior (v1.1+)
119
+ file_path = qdown.download(
120
+ "file_id_here",
121
+ skip_head=False # Enable HEAD request
122
+ )
123
+ ```
124
+
125
+ ### New Parameters (v1.1+)
126
+ - `skip_exists_check`: Skip file existence verification (default: False)
127
+ - `skip_head`: Skip HEAD request (default: True)
128
+
129
+ ## Uninstall
130
+
131
+ ```
132
+ pip uninstall qdown -y
133
+ ```
qdown-1.1.0/README.md ADDED
@@ -0,0 +1,115 @@
1
+ # qdown
2
+
3
+ A Python client for downloading files from QualitegDrive operated by Qualiteg Inc.
4
+
5
+ [Japanese](README.ja.md)
6
+
7
+ ## Install
8
+
9
+ ```
10
+ pip install qdown
11
+ ```
12
+
13
+ or
14
+
15
+ ```
16
+ pip install git+https://github.com/qualiteg/qdown.git
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ ```
22
+ qdown ID [options]
23
+
24
+ Options:
25
+ -O FILENAME Specify output filename
26
+ -o DIR Specify output directory
27
+ -s SERVER Specify server URL (default: https://drive.qualiteg.com)
28
+ -q, --quiet Hide progress display
29
+ --skip-check Skip file existence check (fastest download)
30
+ --use-head Use HEAD request (legacy behavior)
31
+ -h, --help Display help
32
+ ```
33
+
34
+ ### New Features (v1.1+)
35
+
36
+ Enhanced support for large files and improved performance:
37
+
38
+ **New Options:**
39
+ - `--skip-check`: Skip file existence verification for fastest download (recommended for large files)
40
+ - `--use-head`: Use HEAD request method (default is disabled to prevent timeouts)
41
+
42
+ **Improvements:**
43
+ - HEAD requests are now skipped by default (resolves timeout issues with large files)
44
+ - File existence verification via `/file/{id}` endpoint (more reliable)
45
+
46
+ ## Download Examples
47
+
48
+ ### Example 1: Basic Download
49
+ ```
50
+ qdown xxxxxxxxxxxxx -O my_file.txt
51
+ ```
52
+
53
+ ### Example 2: From Your Original HTTP Server
54
+ ```
55
+ qdown xxxxxxxxxxxxx -O my_file.txt -s http://host.docker.internal:3000
56
+ ```
57
+
58
+ ### Example 3: Fast Download for Large Files (v1.1+)
59
+ ```
60
+ # Skip all checks for maximum speed
61
+ qdown xxxxxxxxxxxxx -O large_file.zip --skip-check
62
+
63
+ # Silent mode with skip check
64
+ qdown xxxxxxxxxxxxx -O huge_file.zip --skip-check -q
65
+ ```
66
+
67
+ ### Example 4: Legacy Behavior (v1.1+)
68
+ ```
69
+ # Use traditional HEAD request (if needed for compatibility)
70
+ qdown xxxxxxxxxxxxx -O file.txt --use-head
71
+ ```
72
+
73
+ ## Python API
74
+
75
+ ```python
76
+ import qdown
77
+
78
+ # Basic download
79
+ file_path = qdown.download("file_id_here")
80
+
81
+ # Download with output filename
82
+ file_path = qdown.download("file_id_here", output_path="my_file.txt")
83
+
84
+ # Download from custom server
85
+ file_path = qdown.download(
86
+ "file_id_here",
87
+ output_path="my_file.txt",
88
+ server_url="http://localhost:3000"
89
+ )
90
+
91
+ # Fast download for large files (v1.1+)
92
+ file_path = qdown.download(
93
+ "file_id_here",
94
+ output_path="large_file.zip",
95
+ skip_exists_check=True, # Skip existence check
96
+ skip_head=True, # Skip HEAD request (default)
97
+ quiet=True # Silent mode
98
+ )
99
+
100
+ # Use legacy behavior (v1.1+)
101
+ file_path = qdown.download(
102
+ "file_id_here",
103
+ skip_head=False # Enable HEAD request
104
+ )
105
+ ```
106
+
107
+ ### New Parameters (v1.1+)
108
+ - `skip_exists_check`: Skip file existence verification (default: False)
109
+ - `skip_head`: Skip HEAD request (default: True)
110
+
111
+ ## Uninstall
112
+
113
+ ```
114
+ pip uninstall qdown -y
115
+ ```