gitstore 0.2.1__tar.gz → 0.2.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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: gitstore
3
- Version: 0.2.1
3
+ Version: 0.2.2
4
4
  Summary: Utilities to encrypt files/directories with utilitz and exchange them through GitHub repositories.
5
5
  Author: artitzco
6
6
  License: MIT
@@ -109,7 +109,7 @@ folder/documento
109
109
  from gitstore import restore_from_github
110
110
 
111
111
  output_path = restore_from_github(
112
- github_url="https://github.com/USER/REPO/blob/main/vault/documento_ventas_q2.asc",
112
+ github_raw_url="https://raw.githubusercontent.com/USER/REPO/main/vault/documento_ventas_q2.asc",
113
113
  password=None, # default: uses GITSTORE_PASSWORD
114
114
  output_path=None, # default: restores in the current working directory
115
115
  overwrite=False, # default
@@ -138,7 +138,8 @@ Tip:
138
138
 
139
139
  Download behavior:
140
140
 
141
- - accepts normal GitHub file URLs (`github.com/.../blob/...`) and raw URLs
141
+ - expects RAW GitHub URLs (`raw.githubusercontent.com/...`) as primary input
142
+ - also accepts `github.com/.../blob/...` and normalizes automatically
142
143
  - skips download when `output_path` already exists and matches the remote `source_hash` in `vault/index.json`
143
144
  - set `force_download=True` to download even when the local output appears aligned
144
145
  - downloads the encrypted `.asc` file to a temporary location
@@ -98,7 +98,7 @@ folder/documento
98
98
  from gitstore import restore_from_github
99
99
 
100
100
  output_path = restore_from_github(
101
- github_url="https://github.com/USER/REPO/blob/main/vault/documento_ventas_q2.asc",
101
+ github_raw_url="https://raw.githubusercontent.com/USER/REPO/main/vault/documento_ventas_q2.asc",
102
102
  password=None, # default: uses GITSTORE_PASSWORD
103
103
  output_path=None, # default: restores in the current working directory
104
104
  overwrite=False, # default
@@ -127,7 +127,8 @@ Tip:
127
127
 
128
128
  Download behavior:
129
129
 
130
- - accepts normal GitHub file URLs (`github.com/.../blob/...`) and raw URLs
130
+ - expects RAW GitHub URLs (`raw.githubusercontent.com/...`) as primary input
131
+ - also accepts `github.com/.../blob/...` and normalizes automatically
131
132
  - skips download when `output_path` already exists and matches the remote `source_hash` in `vault/index.json`
132
133
  - set `force_download=True` to download even when the local output appears aligned
133
134
  - downloads the encrypted `.asc` file to a temporary location
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "gitstore"
7
- version = "0.2.1"
7
+ version = "0.2.2"
8
8
  description = "Utilities to encrypt files/directories with utilitz and exchange them through GitHub repositories."
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.10"
@@ -97,7 +97,7 @@ def _hmac_source(path: Path, secret: str) -> str:
97
97
 
98
98
 
99
99
  def restore_from_github(
100
- github_url: str,
100
+ github_raw_url: str,
101
101
  password: str | None = None,
102
102
  output_path: str | None = None,
103
103
  overwrite: bool = False,
@@ -107,7 +107,7 @@ def restore_from_github(
107
107
  ) -> str:
108
108
  resolved_password = _resolve_password(password, password_env_var)
109
109
  config = GitStoreConfig(password=resolved_password, request_timeout=request_timeout)
110
- raw_url = normalize_github_file_url(github_url)
110
+ raw_url = normalize_github_file_url(github_raw_url)
111
111
  if output_path is not None and not overwrite and not force_download:
112
112
  existing_output = Path(output_path).expanduser().resolve()
113
113
  if existing_output.exists():
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: gitstore
3
- Version: 0.2.1
3
+ Version: 0.2.2
4
4
  Summary: Utilities to encrypt files/directories with utilitz and exchange them through GitHub repositories.
5
5
  Author: artitzco
6
6
  License: MIT
@@ -109,7 +109,7 @@ folder/documento
109
109
  from gitstore import restore_from_github
110
110
 
111
111
  output_path = restore_from_github(
112
- github_url="https://github.com/USER/REPO/blob/main/vault/documento_ventas_q2.asc",
112
+ github_raw_url="https://raw.githubusercontent.com/USER/REPO/main/vault/documento_ventas_q2.asc",
113
113
  password=None, # default: uses GITSTORE_PASSWORD
114
114
  output_path=None, # default: restores in the current working directory
115
115
  overwrite=False, # default
@@ -138,7 +138,8 @@ Tip:
138
138
 
139
139
  Download behavior:
140
140
 
141
- - accepts normal GitHub file URLs (`github.com/.../blob/...`) and raw URLs
141
+ - expects RAW GitHub URLs (`raw.githubusercontent.com/...`) as primary input
142
+ - also accepts `github.com/.../blob/...` and normalizes automatically
142
143
  - skips download when `output_path` already exists and matches the remote `source_hash` in `vault/index.json`
143
144
  - set `force_download=True` to download even when the local output appears aligned
144
145
  - downloads the encrypted `.asc` file to a temporary location
File without changes