geo-explorer 0.1.7__tar.gz

geo_explorer-0.1.7/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Statistics Norway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

geo_explorer-0.1.7/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Statistics Norway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

geo_explorer-0.1.7/PKG-INFO

@@ -0,0 +1,191 @@
+Metadata-Version: 2.1
+Name: geo-explorer
+Version: 0.1.7
+Summary: Explore geodata interactively.
+Home-page: https://github.com/statisticsnorway/geo-explorer
+License: MIT
+Author: Morten Letnes
+Author-email: morten.letnes@ssb.no
+Requires-Python: >=3.11,<4
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Dist: dash (>=3.1.1)
+Requires-Dist: dash-bootstrap-components (>=2.0.3)
+Requires-Dist: dash-leaflet (>=1.1.3)
+Requires-Dist: fsspec (>=2025.5.1)
+Requires-Dist: geopandas (>=0.14.0)
+Requires-Dist: jenkspy (>=0.3.2)
+Requires-Dist: matplotlib (>=3.7.0)
+Requires-Dist: numpy (>=1.26.4)
+Requires-Dist: pandas (>=2.2.1)
+Requires-Dist: pyarrow (>=20.0.0)
+Requires-Dist: pyproj (>=3.6.1)
+Requires-Dist: rtree (>=1.0.1)
+Requires-Dist: shapely (>=2.0.1)
+Requires-Dist: ssb-sgis (>=1.2.10)
+Requires-Dist: typing-extensions (>=4.11.0)
+Project-URL: Changelog, https://github.com/statisticsnorway/geo-explorer/releases
+Project-URL: Documentation, https://statisticsnorway.github.io/geo-explorer
+Project-URL: Repository, https://github.com/statisticsnorway/geo-explorer
+Description-Content-Type: text/markdown
+
+# geo-explorer
+
+Explore geodata interactively.
+
+Opprettet av:
+ort <ort@ssb.no>
+
+---
+
+To install, use one of:
+
+```shell
+poetry add ssb-sgis
+pip install ssb-sgis
+```
+
+## GeoExplorer
+
+
+```python
+from geo_explorer import GeoExplorer
+from geo_explorer import LocalFileSystem
+explorer = GeoExplorer(
+    start_dir="C:/users/ort/OneDrive - Statistisk sentralbyrå/data",
+    file_system=LocalFileSystem(),
+    port=8055,
+)
+explorer.run(debug=True)
+```
+
+Run locally:
+
+```python
+from geo_explorer import GeoExplorer
+from geo_explorer import LocalFileSystem
+explorer = GeoExplorer(
+    start_dir="C:/users/user/data",
+    file_system=LocalFileSystem(),
+    port=None,
+)
+explorer.run()
+```
+
+
+## Developer information
+
+### Git LFS
+
+The data in the testdata directory is stored with [Git LFS](https://git-lfs.com/).
+Make sure `git-lfs` is installed and that you have run the command `git lfs install`
+at least once. You only need to run this once per user account.
+
+### Dependencies
+
+[Poetry](https://python-poetry.org/) is used for dependency management. Install
+poetry and run the command below from the root directory to install the dependencies.
+
+```shell
+poetry install -E test --no-root
+```
+
+### Tests
+
+Use the following command from the root directory to run the tests:
+
+```shell
+poetry run pytest  # from root directory
+```
+
+For VS Code there are extensions for opening a python script as Jupyter Notebook,
+for example:
+[Jupytext for Notebooks](https://marketplace.visualstudio.com/items?itemName=donjayamanne.vscode-jupytext).
+
+### Code quality
+
+Run 'ruff' on all files with safe fixes:
+
+```shell
+poetry run ruff check --fix .
+```
+
+### Formatting
+
+Format the code with `black` and `isort` by running the following command from the
+root directory:
+
+```shell
+poetry run black .
+poetry run isort .
+```
+
+### Pre-commit hooks
+
+We are using [pre-commit hooks](https://pre-commit.com/) to make sure the code is
+correctly formatted and consistent before committing. Use the following command from
+the root directory in the repo to install the pre-commit hooks:
+
+```shell
+poetry run pre-commit install
+```
+
+It then checks the changed files before committing. You can run the pre-commit checks
+on all files by using this command:
+
+```shell
+poetry run pre-commit run --all-files
+```
+
+### Documentation
+
+To generate the API-documentation locally, run the following command from the root
+directory:
+
+```shell
+poetry run sphinx-build -W docs docs/_build
+```
+
+Then open the file `docs/_build/index.html`.
+
+To check and run the docstrings examples, run this command:
+
+```shell
+poetry run xdoctest --command=all ./src/sgis
+```
+
+## Contributing
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
+
+## License
+
+Distributed under the terms of the [MIT license][license],
+_SSB sgis_ is free and open source software.
+
+## Issues
+
+If you encounter any problems,
+please [file an issue] along with a detailed description.
+
+## Credits
+
+This project was generated from [Statistics Norway]'s [SSB PyPI Template].
+
+[statistics norway]: https://www.ssb.no/en
+[pypi]: https://pypi.org/
+[ssb pypi template]: https://github.com/statisticsnorway/ssb-pypitemplate
+[file an issue]: https://github.com/statisticsnorway/ssb-sgis/issues
+[pip]: https://pip.pypa.io/
+
+<!-- github-only -->
+
+[license]: https://github.com/statisticsnorway/ssb-sgis/blob/main/LICENSE
+[contributor guide]: https://github.com/statisticsnorway/ssb-sgis/blob/main/CONTRIBUTING.md
+[reference guide]: https://statisticsnorway.github.io/ssb-sgis/reference.html
+

geo_explorer-0.1.7/README.md

@@ -0,0 +1,155 @@
+# geo-explorer
+
+Explore geodata interactively.
+
+Opprettet av:
+ort <ort@ssb.no>
+
+---
+
+To install, use one of:
+
+```shell
+poetry add ssb-sgis
+pip install ssb-sgis
+```
+
+## GeoExplorer
+
+
+```python
+from geo_explorer import GeoExplorer
+from geo_explorer import LocalFileSystem
+explorer = GeoExplorer(
+    start_dir="C:/users/ort/OneDrive - Statistisk sentralbyrå/data",
+    file_system=LocalFileSystem(),
+    port=8055,
+)
+explorer.run(debug=True)
+```
+
+Run locally:
+
+```python
+from geo_explorer import GeoExplorer
+from geo_explorer import LocalFileSystem
+explorer = GeoExplorer(
+    start_dir="C:/users/user/data",
+    file_system=LocalFileSystem(),
+    port=None,
+)
+explorer.run()
+```
+
+
+## Developer information
+
+### Git LFS
+
+The data in the testdata directory is stored with [Git LFS](https://git-lfs.com/).
+Make sure `git-lfs` is installed and that you have run the command `git lfs install`
+at least once. You only need to run this once per user account.
+
+### Dependencies
+
+[Poetry](https://python-poetry.org/) is used for dependency management. Install
+poetry and run the command below from the root directory to install the dependencies.
+
+```shell
+poetry install -E test --no-root
+```
+
+### Tests
+
+Use the following command from the root directory to run the tests:
+
+```shell
+poetry run pytest  # from root directory
+```
+
+For VS Code there are extensions for opening a python script as Jupyter Notebook,
+for example:
+[Jupytext for Notebooks](https://marketplace.visualstudio.com/items?itemName=donjayamanne.vscode-jupytext).
+
+### Code quality
+
+Run 'ruff' on all files with safe fixes:
+
+```shell
+poetry run ruff check --fix .
+```
+
+### Formatting
+
+Format the code with `black` and `isort` by running the following command from the
+root directory:
+
+```shell
+poetry run black .
+poetry run isort .
+```
+
+### Pre-commit hooks
+
+We are using [pre-commit hooks](https://pre-commit.com/) to make sure the code is
+correctly formatted and consistent before committing. Use the following command from
+the root directory in the repo to install the pre-commit hooks:
+
+```shell
+poetry run pre-commit install
+```
+
+It then checks the changed files before committing. You can run the pre-commit checks
+on all files by using this command:
+
+```shell
+poetry run pre-commit run --all-files
+```
+
+### Documentation
+
+To generate the API-documentation locally, run the following command from the root
+directory:
+
+```shell
+poetry run sphinx-build -W docs docs/_build
+```
+
+Then open the file `docs/_build/index.html`.
+
+To check and run the docstrings examples, run this command:
+
+```shell
+poetry run xdoctest --command=all ./src/sgis
+```
+
+## Contributing
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
+
+## License
+
+Distributed under the terms of the [MIT license][license],
+_SSB sgis_ is free and open source software.
+
+## Issues
+
+If you encounter any problems,
+please [file an issue] along with a detailed description.
+
+## Credits
+
+This project was generated from [Statistics Norway]'s [SSB PyPI Template].
+
+[statistics norway]: https://www.ssb.no/en
+[pypi]: https://pypi.org/
+[ssb pypi template]: https://github.com/statisticsnorway/ssb-pypitemplate
+[file an issue]: https://github.com/statisticsnorway/ssb-sgis/issues
+[pip]: https://pip.pypa.io/
+
+<!-- github-only -->
+
+[license]: https://github.com/statisticsnorway/ssb-sgis/blob/main/LICENSE
+[contributor guide]: https://github.com/statisticsnorway/ssb-sgis/blob/main/CONTRIBUTING.md
+[reference guide]: https://statisticsnorway.github.io/ssb-sgis/reference.html

geo_explorer-0.1.7/pyproject.toml

@@ -0,0 +1,199 @@
+[tool.poetry]
+name = "geo-explorer"
+version = "0.1.7"
+description = "Explore geodata interactively."
+authors = ["Morten Letnes <morten.letnes@ssb.no>"]
+license = "MIT"
+readme = "README.md"
+homepage = "https://github.com/statisticsnorway/geo-explorer"
+repository = "https://github.com/statisticsnorway/geo-explorer"
+documentation = "https://statisticsnorway.github.io/geo-explorer"
+packages = [{ include = "geo_explorer", from = "src" }]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Topic :: Scientific/Engineering :: GIS",
+]
+
+[tool.poetry.urls]
+Changelog = "https://github.com/statisticsnorway/geo-explorer/releases"
+
+[tool.poetry.dependencies]
+python = ">=3.11,<4"
+geopandas = ">=0.14.0"
+ssb-sgis = ">=1.2.10"
+jenkspy = ">=0.3.2"
+matplotlib = ">=3.7.0"
+numpy = ">=1.26.4"
+pandas = ">=2.2.1"
+pyarrow = ">=20.0.0"
+pyproj = ">=3.6.1"
+rtree = ">=1.0.1"
+shapely = ">=2.0.1"
+typing-extensions = ">=4.11.0"
+dash = ">=3.1.1"
+dash-bootstrap-components = ">=2.0.3"
+dash-leaflet = ">=1.1.3"
+fsspec = ">=2025.5.1"
+
+[tool.poetry.group.dev.dependencies]
+pygments = ">=2.10.0"
+black = { extras = ["jupyter"], version = ">=23.1.0" }
+coverage = { extras = ["toml"], version = ">=6.2" }
+darglint = ">=1.8.1"
+furo = ">=2021.11.12"
+mypy = ">=0.930"
+pre-commit = ">=2.16.0"
+pre-commit-hooks = ">=4.1.0"
+ruff = ">=0.0.284"
+owslib = ">=0.34.0"
+pillow = ">=11.0.0"
+pytest = ">=6.2.5"
+sphinx = ">=6.2.1"
+sphinx-autobuild = ">=2021.3.14"
+sphinx-autodoc-typehints = ">=1.24.0"
+sphinx-click = ">=3.0.2"
+typeguard = ">=2.13.3"
+xdoctest = { extras = ["colors"], version = ">=0.15.10" }
+myst-parser = { version = ">=0.16.1" }
+deptry = ">=0.8.0"
+isort = ">=5.13.2"
+jupyter = ">=1.0.0"
+jupytext = ">=1.16.1"
+pytest-cov = ">=5.0.0"
+pandas-stubs = ">=2.2.1.240316"
+types-requests = ">=2.31.0.20240406"
+# bitsandbytes not released for macos for version > 0.42
+bitsandbytes = { version = "0.42.0", markers = "sys_platform == 'darwin'" }
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+[tool.coverage.paths]
+source = ["src", "*/site-packages"]
+tests = ["tests", "*/tests"]
+
+[tool.coverage.run]
+branch = true
+source = ["geo-explorer", "tests"]
+relative_files = true
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 50
+
+[tool.mypy]
+strict = false
+warn_unreachable = true
+pretty = true
+show_column_numbers = true
+show_error_context = true
+
+[[tool.mypy.overrides]]
+module = [
+    "geopandas.*",
+    "jenkspy.*",
+    "pyarrow.*",
+    "shapely.*",
+    "sklearn.neighbors.*",
+    "xyzservices.*",
+]
+ignore_missing_imports = true
+
+[tool.ruff]
+force-exclude = true  # Apply excludes to pre-commit
+show-fixes = true
+src = ["src", "tests"]
+target-version = "py311"  # Minimum Python version supported
+include = ["*.py", "*.pyi", "**/pyproject.toml", "*.ipynb"]
+extend-exclude = [
+    "__pycache__",
+    "old",
+    ".ipynb_checkpoints",
+    "noxfile.py",
+    "docs/conf.py",
+]
+
+# Ruff rules may be customized as desired: https://docs.astral.sh/ruff/rules/
+[tool.ruff.lint]
+select = [
+    "A",    # prevent using keywords that clobber python builtins
+    "ANN",  # check type annotations
+    "B",    # bugbear: security warnings
+    "D",    # documentation
+    "E",    # pycodestyle
+    "F",    # pyflakes
+    "ISC",  # implicit string concatenation
+    "UP",   # alert you when better syntax is available in your python version
+    "RUF",  # the ruff developer's own rules
+]
+ignore = [
+    "ANN002", # Typehint *args
+    "ANN003", # Typehint **kwargs
+    "ANN101", # Supress missing-type-self.
+    "ANN102", # Supress missing-type-cls.
+    "ANN202", # Don't requiere return type annotation for private functions.
+    "ANN401", # Allow type annotation with type Any.
+    "D100",   # Supress undocumented-public-module. Only doc of public api required.
+    "E402",   # Supress module-import-not-at-top-of-file, needed in jupyter notebooks.
+    "E501",   # Supress line-too-long warnings: trust black's judgement on this one.
+    "D104",   # Missing docstring in public package
+    "RUF018", # Avoid assignment expressions in `assert` statements
+    "RUF005", # Consider `["_cluster", *by]` instead of concatenation
+    "F841",   # Local variable is assigned to but never used
+    "B019",   # Use of `functools.lru_cache` or `functools.cache` on methods can lead to memory leaks
+    "UP038",  # Use `X | Y` in `isinstance` call instead of `(X, Y)`
+    "B023",   # Function definition does not bind loop variable
+    "ANN001", # TODO temporary. Missing type annotation for function argument ...
+    "D103",   # TODO temporary. Missing docstring in public function
+    "B018",   # Found useless expression
+    "E712",   # Avoid equality comparisons to `True`; use `if x:` for truth checks (because 'is' doesn't work with numpy/pandas)
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[tool.ruff.lint.mccabe]
+max-complexity = 15
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"  # You can also use "numpy".
+
+[tool.ruff.lint.pep8-naming]
+classmethod-decorators = ["classmethod", "validator", "root_validator", "pydantic.validator"]
+
+[tool.ruff.lint.per-file-ignores]
+"*/__init__.py" = ["F401"]
+"**/tests/*" = [
+    "ANN001",  # type annotations don't add value for test functions
+    "ANN002",  # type annotations don't add value for test functions
+    "ANN003",  # type annotations don't add value for test functions
+    "ANN201",  # type annotations don't add value for test functions
+    "ANN204",  # type annotations don't add value for test functions
+    "ANN205",  # type annotations don't add value for test functions
+    "ANN206",  # type annotations don't add value for test functions
+    "D100",    # docstrings are overkill for test functions
+    "D101",
+    "D102",
+    "D103",
+    "S101",    # asserts are encouraged in pytest
+]
+
+[tool.jupytext]
+formats = "ipynb,auto:percent"
+notebook_metadata_filter = "jupytext.text_representation,-jupytext.text_representation.jupytext_version,-widgets,-varInspector,-kernelspec"
+cell_metadata_filter = "-all"
+
+[tool.isort]
+profile = "black"
+force_single_line = true
+skip_gitignore = true
+# The line below is needed for jupyter notebooks stored as .py in percent format.
+# See https://github.com/PyCQA/isort/issues/1338 for details
+treat_comments_as_code = ["# %%"]
+
+[tool.deptry.per_rule_ignores]
+DEP001 = ["geo-explorer", "nox", "nox_poetry"]  # packages available by default
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

geo_explorer-0.1.7/src/geo_explorer/__init__.py

@@ -0,0 +1,2 @@
+from .fs import LocalFileSystem
+from .geo_explorer import GeoExplorer