geo-explorer 0.3.0

Explore geodata interactively.

geo-explorer

Explore geodata interactively.

Opprettet av: ort [e-mail]

---

To install, use one of:

poetry add ssb-sgis
pip install ssb-sgis

GeoExplorer

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:

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. 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 is used for dependency management. Install poetry and run the command below from the root directory to install the dependencies.

poetry install -E test --no-root

Tests

Use the following command from the root directory to run the tests:

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.

Code quality

Run 'ruff' on all files with safe fixes:

poetry run ruff check --fix .

Formatting

Format the code with black and isort by running the following command from the root directory:

poetry run black .
poetry run isort .

Pre-commit hooks

We are using pre-commit hooks 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:

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:

poetry run pre-commit run --all-files

Documentation

To generate the API-documentation locally, run the following command from the root directory:

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:

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, 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.