Skip to content

Commit b5aaae0

Browse files
committed
add more docstrings, update version
1 parent 9ce53f0 commit b5aaae0

9 files changed

Lines changed: 76 additions & 113 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
## 7.0.0 (Unreleased)
3+
## 7.0.0 (2025-05-17)
44

55
- `WikiClient` is no longer a "static class", an instance must now be created in order to better reuse HTTP sessions.
66
- General model changes:

docs/api/models/book.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ exclude = [
6767
"docs/",
6868
"images/",
6969
"logs/",
70-
"tibiawikisql/__main__.py"
70+
"tibiawikisql/__main__.py",
71+
"tibiawikisql/server.py",
7172
]
7273

7374

@@ -119,6 +120,7 @@ ignore = [
119120
"PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
120121
"PLR0913", # Too many arguments in function definition ({c_args} > {max_args})
121122
"D105", # Missing docstring in magic method
123+
"PERF203", # `try`-`except` within a loop incurs performance overhead
122124
]
123125

124126
[tool.ruff.lint.per-file-ignores]

tests/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
RESOURCES_PATH = os.path.join(BASE_PATH, "resources/")
55

66

7-
def load_resource(resource):
7+
def load_resource(resource: str):
88
with open(os.path.join(RESOURCES_PATH, resource)) as f:
99
return f.read()

tibiawikisql/__init__.py

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,7 @@
1-
# Copyright 2021 Allan Galarza
2-
#
3-
# Licensed under the Apache License, Version 2.0 (the "License");
4-
# you may not use this file except in compliance with the License.
5-
# You may obtain a copy of the License at
6-
#
7-
# http://www.apache.org/licenses/LICENSE-2.0
8-
#
9-
# Unless required by applicable law or agreed to in writing, software
10-
# distributed under the License is distributed on an "AS IS" BASIS,
11-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12-
# See the License for the specific language governing permissions and
13-
# limitations under the License.
14-
151
"""API that reads and parses information from `TibiaWiki <https://tibiawiki.fandom.com>`_."""
162

173
__author__ = "Allan Galarza"
18-
__copyright__ = "Copyright 2024 Allan Galarza"
4+
__copyright__ = "Copyright 2025 Allan Galarza"
195

206
__license__ = "Apache 2.0"
21-
__version__ = "7.0.0-alpha"
7+
__version__ = "7.0.0"

tibiawikisql/models/__init__.py

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

173
from tibiawikisql.models.achievement import Achievement

tibiawikisql/parsers/__init__.py

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,3 @@
1-
# Copyright (c) 2025.
2-
#
3-
# Licensed under the Apache License, Version 2.0 (the "License");
4-
# you may not use this file except in compliance with the License.
5-
# You may obtain a copy of the License at
6-
#
7-
# http://www.apache.org/licenses/LICENSE-2.0
8-
#
9-
# Unless required by applicable law or agreed to in writing, software
10-
# distributed under the License is distributed on an "AS IS" BASIS,
11-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12-
# See the License for the specific language governing permissions and
13-
# limitations under the License.
14-
#
15-
# Licensed under the Apache License, Version 2.0 (the "License");
16-
# you may not use this file except in compliance with the License.
17-
# You may obtain a copy of the License at
18-
#
19-
# http://www.apache.org/licenses/LICENSE-2.0
20-
#
21-
# Unless required by applicable law or agreed to in writing, software
22-
# distributed under the License is distributed on an "AS IS" BASIS,
23-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
24-
# See the License for the specific language governing permissions and
25-
# limitations under the License.
26-
#
27-
# Licensed under the Apache License, Version 2.0 (the "License");
28-
# you may not use this file except in compliance with the License.
29-
# You may obtain a copy of the License at
30-
#
31-
# http://www.apache.org/licenses/LICENSE-2.0
32-
#
33-
# Unless required by applicable law or agreed to in writing, software
34-
# distributed under the License is distributed on an "AS IS" BASIS,
35-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
36-
# See the License for the specific language governing permissions and
37-
# limitations under the License.
38-
#
39-
# Licensed under the Apache License, Version 2.0 (the "License");
40-
# you may not use this file except in compliance with the License.
41-
# You may obtain a copy of the License at
42-
#
43-
# http://www.apache.org/licenses/LICENSE-2.0
44-
#
45-
# Unless required by applicable law or agreed to in writing, software
46-
# distributed under the License is distributed on an "AS IS" BASIS,
47-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
48-
# See the License for the specific language governing permissions and
49-
# limitations under the License.
50-
511
from tibiawikisql.parsers.base import BaseParser, AttributeParser
522
from tibiawikisql.parsers.achievement import AchievementParser
533
from tibiawikisql.parsers.charm import CharmParser

0 commit comments

Comments
 (0)