geospatial_examples
Just some scripts/examples in python for geospatial data. Also a repo for testing some news features at Python 3.10
Repo organization
- At example_module has a package to test something as a package.
- At examples has scripts to test different things using the example_module and also some scripts tests.
- At annotations has annotations (why and how it was done) for different scripts and modules at the package.
Some things used to organize the codes
- Black as code formatter. Configs at ./.config/pyproject_black.toml
- Flake8 as code style enforcement. Configs at ./.config/flake8.cfg
- Pylint as a linter.
- Numpy Docstrings as the pattern to write the documentations of the code. These documentations are used to auto-generate the docs available at gh-pages of this repo.
- Docs generation, to generate the docs in a local environment see ./annotations/generating_docs.md
- Sphinx to generate/setup the docs
- sphinx-action to automate with gh actions the generation and deploy of the docs to gh pages
The ./.vscode/
I know the setup (and also IDE) is a personal choice, so, this ./.vscode/settings.json is just a suggestion that works well for me.
Also, at ./annotations/setup/vscode.md have some explains about these configs and some extensions for vscode that can help someone.