Skip to content

Commit f1f184b

Browse files
tivaliytivaliy
committed
Prepare v1.1.0 release: update docs and remove license headers
- Update README.md configuration section to use environment variables instead of deprecated settings.yaml - Add v1.1.0 entry to ChangeLog documenting breaking config change - Remove license headers from 42 source files (license in LICENSE file) This is a breaking change: users must migrate from settings.yaml to environment variables or .env files for configuration.
1 parent 40146a9 commit f1f184b

44 files changed

Lines changed: 35 additions & 649 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎ChangeLog‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
CHANGES
22
=======
33

4+
1.1.0
5+
-----
6+
7+
Breaking Changes:
8+
9+
* Migrate configuration from YAML to Pydantic-settings
10+
* Remove settings.yaml - configuration now uses environment variables
11+
* Users must migrate to environment variables or .env files
12+
13+
Configuration:
14+
15+
* Add pydantic-settings>=2.0 dependency
16+
* Configuration loaded from GERRIT_URL, GERRIT_AUTH_TYPE, GERRIT_USERNAME, GERRIT_PASSWORD
17+
* Support for .env files in current directory
18+
* Add .env.example template
19+
20+
Code Quality:
21+
22+
* Remove license headers from source files (license in LICENSE file)
23+
424
1.0.0
525
-----
626

‎README.md‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,22 @@ CLI tool and Python API wrapper for Gerrit Code Review
2727
cd python-gerritclient
2828
```
2929

30-
3. Configure `settings.yaml` file (in `gerritclient/settings.yaml`):
31-
```yaml
32-
url: http://review.example.com
33-
auth_type: basic
34-
username: admin
35-
password: "1234567890aaWmmflSl+ZlOPs23Dffn"
30+
3. Configure environment variables (create a `.env` file or export directly):
31+
```bash
32+
# Option A: Create a .env file
33+
cp .env.example .env
34+
# Edit .env with your settings
35+
36+
# Option B: Export directly
37+
export GERRIT_URL=https://review.example.com
38+
export GERRIT_AUTH_TYPE=basic
39+
export GERRIT_USERNAME=admin
40+
export GERRIT_PASSWORD="your-http-password"
3641
```
3742

38-
* `url` - Gerrit server URL in format `<scheme>://<host>:<port>` (e.g., `https://review.openstack.org`)
39-
* `auth_type` - HTTP authentication scheme (`basic` or `digest`), omit for anonymous access
40-
* `username` and `password` - user credentials from Gerrit (Settings → HTTP Password)
43+
* `GERRIT_URL` - Gerrit server URL (e.g., `https://review.openstack.org`)
44+
* `GERRIT_AUTH_TYPE` - HTTP authentication scheme (`basic` or `digest`), omit for anonymous access
45+
* `GERRIT_USERNAME` and `GERRIT_PASSWORD` - user credentials from Gerrit (Settings → HTTP Password)
4146

4247
4. Install dependencies and run:
4348
```bash
@@ -59,7 +64,7 @@ CLI tool and Python API wrapper for Gerrit Code Review
5964
cd python-gerritclient
6065
```
6166

62-
2. Configure `settings.yaml` (same as above)
67+
2. Configure environment variables (same as step 3 above)
6368

6469
3. Install with pip:
6570
```bash

‎docs/source/conf.py‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
#
2-
# Copyright 2017 Vitalii Kulanov
3-
#
4-
# Licensed under the Apache License, Version 2.0 (the "License"); you may
5-
# not use this file except in compliance with the License. You may obtain
6-
# a copy of the License at
7-
#
8-
# http://www.apache.org/licenses/LICENSE-2.0
9-
#
10-
# Unless required by applicable law or agreed to in writing, software
11-
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12-
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13-
# License for the specific language governing permissions and limitations
14-
# under the License.
15-
161
# -- Project information -----------------------------------------------------
172
project = "python-gerritclient"
183
copyright = "2017-2025, Vitalii Kulanov"

‎gerritclient/__init__.py‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1 @@
1-
#
2-
# Copyright 2017 Vitalii Kulanov
3-
#
4-
# Licensed under the Apache License, Version 2.0 (the "License"); you may
5-
# not use this file except in compliance with the License. You may obtain
6-
# a copy of the License at
7-
#
8-
# http://www.apache.org/licenses/LICENSE-2.0
9-
#
10-
# Unless required by applicable law or agreed to in writing, software
11-
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12-
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13-
# License for the specific language governing permissions and limitations
14-
# under the License.
15-
161
from gerritclient import v1

‎gerritclient/client.py‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
#
2-
# Copyright 2017 Vitalii Kulanov
3-
#
4-
# Licensed under the Apache License, Version 2.0 (the "License"); you may
5-
# not use this file except in compliance with the License. You may obtain
6-
# a copy of the License at
7-
#
8-
# http://www.apache.org/licenses/LICENSE-2.0
9-
#
10-
# Unless required by applicable law or agreed to in writing, software
11-
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12-
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13-
# License for the specific language governing permissions and limitations
14-
# under the License.
15-
161
import json
172

183
import requests

‎gerritclient/commands/account.py‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
#
2-
# Copyright 2017 Vitalii Kulanov
3-
#
4-
# Licensed under the Apache License, Version 2.0 (the "License"); you may
5-
# not use this file except in compliance with the License. You may obtain
6-
# a copy of the License at
7-
#
8-
# http://www.apache.org/licenses/LICENSE-2.0
9-
#
10-
# Unless required by applicable law or agreed to in writing, software
11-
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12-
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13-
# License for the specific language governing permissions and limitations
14-
# under the License.
15-
161
import abc
172
import argparse
183

‎gerritclient/commands/base.py‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
#
2-
# Copyright 2017 Vitalii Kulanov
3-
#
4-
# Licensed under the Apache License, Version 2.0 (the "License"); you may
5-
# not use this file except in compliance with the License. You may obtain
6-
# a copy of the License at
7-
#
8-
# http://www.apache.org/licenses/LICENSE-2.0
9-
#
10-
# Unless required by applicable law or agreed to in writing, software
11-
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12-
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13-
# License for the specific language governing permissions and limitations
14-
# under the License.
15-
161
import abc
172
import argparse
183
import os

‎gerritclient/commands/change.py‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
#
2-
# Copyright 2017 Vitalii Kulanov
3-
#
4-
# Licensed under the Apache License, Version 2.0 (the "License"); you may
5-
# not use this file except in compliance with the License. You may obtain
6-
# a copy of the License at
7-
#
8-
# http://www.apache.org/licenses/LICENSE-2.0
9-
#
10-
# Unless required by applicable law or agreed to in writing, software
11-
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12-
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13-
# License for the specific language governing permissions and limitations
14-
# under the License.
15-
161
import abc
172
import argparse
183

‎gerritclient/commands/group.py‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
#
2-
# Copyright 2017 Vitalii Kulanov
3-
#
4-
# Licensed under the Apache License, Version 2.0 (the "License"); you may
5-
# not use this file except in compliance with the License. You may obtain
6-
# a copy of the License at
7-
#
8-
# http://www.apache.org/licenses/LICENSE-2.0
9-
#
10-
# Unless required by applicable law or agreed to in writing, software
11-
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12-
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13-
# License for the specific language governing permissions and limitations
14-
# under the License.
15-
161
import abc
172

183
from gerritclient.commands import base

‎gerritclient/commands/plugin.py‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
#
2-
# Copyright 2017 Vitalii Kulanov
3-
#
4-
# Licensed under the Apache License, Version 2.0 (the "License"); you may
5-
# not use this file except in compliance with the License. You may obtain
6-
# a copy of the License at
7-
#
8-
# http://www.apache.org/licenses/LICENSE-2.0
9-
#
10-
# Unless required by applicable law or agreed to in writing, software
11-
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12-
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13-
# License for the specific language governing permissions and limitations
14-
# under the License.
15-
161
import argparse
172
import os
183

0 commit comments

Comments
 (0)