Skip to content
This repository was archived by the owner on Dec 24, 2025. It is now read-only.

Commit 2187e3a

Browse files
committed
initial commit
1 parent ed7ddcc commit 2187e3a

21 files changed

Lines changed: 715 additions & 384 deletions

.github/workflows/docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
push:
55
branches:
66
- main
7+
- dev
78
paths:
89
- 'LICENSE'
910
- 'CHANGELOG.md'

.gitignore

Lines changed: 132 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,135 @@
1-
*.egg-info/
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
211
build/
312
develop-eggs/
413
dist/
5-
.DS_store
6-
.venv/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
uv.lock
94+
95+
# celery beat schedule file
96+
celerybeat-schedule
97+
98+
# SageMath parsed files
99+
*.sage.py
100+
101+
# Environments
102+
.env
103+
.venv
104+
env/
105+
venv/
106+
ENV/
107+
env.bak/
108+
venv.bak/
109+
110+
# Spyder project settings
111+
.spyderproject
112+
.spyproject
113+
114+
# Rope project settings
115+
.ropeproject
116+
117+
# mkdocs documentation
118+
/site
119+
120+
# mypy
121+
.mypy_cache/
122+
.dmypy.json
123+
dmypy.json
124+
125+
# Pyre type checker
126+
.pyre/
127+
128+
# VS Code
129+
.vscode/
130+
131+
# PDM
132+
.pdm.toml
133+
__pypackages__/
134+
135+
.DS_Store

.pre-commit-config.yaml

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,27 @@
11
repos:
2-
- repo: https://github.com/pycqa/isort
3-
rev: 5.13.2
2+
- repo: https://github.com/astral-sh/ruff-pre-commit
3+
rev: v0.12.5
44
hooks:
5-
- id: isort
6-
- repo: https://github.com/ambv/black
7-
rev: 22.12.0
5+
# Run the linter.
6+
- id: ruff
7+
args: [ --fix ]
8+
# Run the formatter.
9+
- id: ruff-format
10+
11+
- repo: https://github.com/executablebooks/mdformat
12+
rev: 0.7.22
813
hooks:
9-
- id: black
14+
- id: mdformat
15+
additional_dependencies:
16+
- mdformat-ruff
17+
18+
- repo: https://github.com/pre-commit/pre-commit-hooks
19+
rev: v5.0.0
20+
hooks:
21+
- id: end-of-file-fixer
22+
- id: trailing-whitespace
23+
24+
- repo: https://github.com/aio-libs/sort-all
25+
rev: v1.3.0
26+
hooks:
27+
- id: sort-all
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
::: flet_map.types.AttributionAlignment
1+
::: flet_map.types.AttributionAlignment
2+
options:
3+
separate_signature: false
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
::: flet_map.types.CursorRotationBehaviour
2+
options:
3+
separate_signature: false

docs/types/pattern_fit.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
::: flet_map.types.PatternFit
1+
::: flet_map.types.PatternFit
2+
options:
3+
separate_signature: false
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
::: flet_map.types.TileLayerEvictErrorTileStrategy
1+
::: flet_map.types.TileLayerEvictErrorTileStrategy
2+
options:
3+
separate_signature: false

mkdocs.yml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ plugins:
140140
# - footnotes
141141
- search:
142142
lang: en
143+
- open-in-new-tab
143144
- mike:
144145
alias_type: symlink
145146
- glightbox
@@ -164,21 +165,16 @@ plugins:
164165
show_labels: false
165166
show_if_no_docstring: true
166167
docstring_section_style: spacy
168+
separate_signature: true
167169
inherited_members: true
168170
preload_modules: [ flet ]
169171
filters:
170172
- "!^_" # Exclude private members starting with only one underscore
171-
- "!before_update"
172-
- "!before_event"
173-
- "!clean"
174-
- "!did_mount"
175-
- "!init"
176-
- "!is_isolated"
177-
- "!update"
178-
- "!will_unmount"
179173
extensions:
180174
- griffe_modernized_annotations
175+
- griffe_warnings_deprecated
181176
inventories:
177+
- url: https://docs.flet.dev/objects.inv
182178
- url: https://docs.python.org/3/objects.inv
183179
domains: [ py, std ]
184180
- url: https://typing-extensions.readthedocs.io/en/latest/objects.inv

pyproject.toml

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,40 @@ Issues = "https://github.com/flet-dev/flet-map/issues"
2020
"flutter.flet_map" = ["**/*"]
2121

2222
[dependency-groups]
23+
test = [
24+
"pytest >=7.2.0",
25+
]
2326
dev = [
24-
"pre-commit>=4.2.0",
25-
"ruff>=0.11.7",
27+
"pre-commit >=4.2.0",
28+
"ruff >=0.11.7",
29+
{ include-group = 'test' },
30+
]
31+
docs-coverage = [
32+
"docstr-coverage >=2.3.2",
2633
]
2734
docs = [
28-
"mkdocs",
29-
"mkdocs-material",
30-
"mkdocstrings[python]",
31-
"mkdocstrings-python-xref",
32-
"mike",
33-
"markdown>=3.6",
34-
"pymdown-extensions",
35-
"mkdocs-glightbox",
36-
"mkdocs-section-index",
37-
"griffe-modernized-annotations",
38-
"pygments>=2.16",
35+
"mkdocs >=1.6.1",
36+
"mkdocs-material >=9.6.15",
37+
"mkdocstrings-python >=1.16.12",
38+
"mkdocstrings-python-xref >=1.16.3",
39+
"mike >=2.1.3",
40+
"markdown >=3.6",
41+
"pymdown-extensions >=10.16",
42+
"mkdocs-exclude >=1.0.2",
43+
"mkdocs-glightbox >=0.4.0",
44+
"mkdocs-open-in-new-tab >=1.0.8",
45+
"mkdocs-section-index >=0.3.10",
46+
"griffe-modernized-annotations >=1.0.8",
47+
"griffe-warnings-deprecated >=1.1.0",
48+
"pygments >=2.16",
49+
"markdown-exec[ansi] >=1.11.0",
50+
"pydocstyle >=6.3.0",
51+
"linkcheckmd >=1.4.0",
52+
{ include-group = 'docs-coverage' },
53+
]
54+
all = [
55+
{ include-group = 'dev' },
56+
{ include-group = 'docs' },
3957
]
4058

4159
[build-system]
@@ -64,6 +82,7 @@ select = [
6482
"I"
6583
]
6684
preview = true
85+
pydocstyle = { convention = 'google' }
6786

6887
[tool.ruff.format]
6988
quote-style = "double"

src/flet_map/__init__.py

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,47 @@
3939
TileDisplay,
4040
TileLayerEvictErrorTileStrategy,
4141
)
42+
43+
__all__ = [
44+
"AttributionAlignment",
45+
"Camera",
46+
"CameraFit",
47+
"CircleLayer",
48+
"CircleMarker",
49+
"CursorKeyboardRotationConfiguration",
50+
"CursorRotationBehaviour",
51+
"DashedStrokePattern",
52+
"DottedStrokePattern",
53+
"FadeInTileDisplay",
54+
"ImageSourceAttribution",
55+
"InstantaneousTileDisplay",
56+
"InteractionConfiguration",
57+
"InteractionFlag",
58+
"KeyboardConfiguration",
59+
"Map",
60+
"MapEvent",
61+
"MapEventSource",
62+
"MapHoverEvent",
63+
"MapLatitudeLongitude",
64+
"MapLatitudeLongitudeBounds",
65+
"MapPointerEvent",
66+
"MapPositionChangeEvent",
67+
"MapTapEvent",
68+
"Marker",
69+
"MarkerLayer",
70+
"MultiFingerGesture",
71+
"PatternFit",
72+
"PolygonLayer",
73+
"PolygonMarker",
74+
"PolylineLayer",
75+
"PolylineMarker",
76+
"RichAttribution",
77+
"SimpleAttribution",
78+
"SolidStrokePattern",
79+
"SourceAttribution",
80+
"StrokePattern",
81+
"TextSourceAttribution",
82+
"TileDisplay",
83+
"TileLayer",
84+
"TileLayerEvictErrorTileStrategy",
85+
]

0 commit comments

Comments
 (0)