Data

Tools

Indexes

Applications

Experiments

Open Source Science

geest

Gender Enabling Environments Spatial Tool (GEEST)

https://github.com/worldbank/geest

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 10 committers (10.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.9%) to scientific vocabulary

Keywords

energy gender labor worldbank worldbank-gost

Keywords from Contributors

interactive particle rivers mesh projection embedded genomics observability autograding hacking
Last synced: 6 months ago · JSON representation

Repository

Gender Enabling Environments Spatial Tool (GEEST)

Basic Info
Statistics
  • Stars: 7
  • Watchers: 20
  • Forks: 6
  • Open Issues: 13
  • Releases: 10
Topics
energy gender labor worldbank worldbank-gost
Created about 2 years ago · Last pushed 7 months ago
Metadata Files
Readme Contributing License Code of conduct

README-dev.md

Developer Guide for GEEST

Welcome to the GEEST Developer Guide! This document is your one-stop resource for contributing to the project. Whether you're setting up your environment, debugging, or preparing a release, we've got you covered. Let's dive in!

Table of Contents

  1. Checking Out the Code
  2. Setting Up Your Development Environment
  3. Understanding admin.py
  4. Debugging the Plugin
  5. Making a Patch or Pull Request
  6. Running Tests
  7. Tagging a Release
  8. Coding Standards
  9. Credits and Notes

Checking Out the Code

What You'll Learn

In this section, you'll learn how to clone the repository and prepare it for development.

Steps

  1. Fork the Repository: Start by forking the GEEST repository on GitHub.
  2. Clone Your Fork: bash git clone https://github.com/your-username/GEEST.git
  3. Set Up the Plugin Path:
    • Open QGIS.
    • Navigate to Plugins > Manage and Install Plugins > Settings > Plugin Paths.
    • Add the path to your local GEEST folder.

Setting Up Your Development Environment

Prerequisites

  • Python 3.8 or later
  • QGIS 3.22 or later
  • pip and virtualenv

Steps

  1. Create a Virtual Environment: bash python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate
  2. Install Dependencies: bash pip install -r requirements-dev.txt

Understanding admin.py

The admin.py script provides various commands for managing the plugin, such as building, installing, and generating metadata.

Key Commands

  • Build the Plugin: bash python admin.py build
  • Install the Plugin: bash python admin.py install
  • Generate Metadata: bash python admin.py generate-metadata

Debugging the Plugin

Steps

  1. Enable Debugging in QGIS:
    • Go to Settings > Options > System > Environment.
    • Add PYTHONDEBUG=1.
  2. Use Logs:
    • Check the QGIS log panel for messages tagged with Geest.

Making a Patch or Pull Request

Steps

  1. Create a New Branch: bash git checkout -b feature/your-feature-name
  2. Make Changes and Commit: bash git add . git commit -m "Describe your changes"
  3. Push and Create a Pull Request: bash git push origin feature/your-feature-name

Running Tests

Steps

  1. Run Unit Tests: bash pytest
  2. Check Code Coverage: bash pytest --cov=geest

Tagging a Release

Steps

  1. Update config.json:
    • Increment the version number.
  2. Create a Git Tag: bash git tag vX.Y.Z git push origin vX.Y.Z

Coding Standards

To ensure consistency and maintainability, please follow the coding standards outlined in the CODING.md file. This document provides guidelines on formatting, naming conventions, and best practices for contributing to the GEEST project.

Credits and Notes

  • Maintainers: Timlinux and Contributors
  • License: MIT License

Owner

  • Name: World Bank Group
  • Login: worldbank
  • Kind: organization
  • Email: github@worldbank.org

World Bank Repository for Data Products and tools. Content does not necessarily represent official World Bank Group positions, policies, recommendations, etc.

GitHub Events

Total
  • Create event: 29
  • Issues event: 35
  • Release event: 8
  • Watch event: 3
  • Delete event: 3
  • Member event: 2
  • Issue comment event: 30
  • Push event: 648
  • Pull request event: 52
  • Fork event: 1
Last Year
  • Create event: 29
  • Issues event: 35
  • Release event: 8
  • Watch event: 3
  • Delete event: 3
  • Member event: 2
  • Issue comment event: 30
  • Push event: 648
  • Pull request event: 52
  • Fork event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 1,575
  • Total Committers: 10
  • Avg Commits per committer: 157.5
  • Development Distribution Score (DDS): 0.519
Past Year
  • Commits: 1,575
  • Committers: 10
  • Avg Commits per committer: 157.5
  • Development Distribution Score (DDS): 0.519
Top Committers
Name Email Commits
Tim Sutton t****m@k****m 758
dragosgontariu 1****u 563
Jeff Osundwa j****f@k****m 197
hennie-k h****e@k****m 39
elbeejay j****n@u****u 6
Clara Ivanescu c****u@g****m 6
dependabot[bot] 4****] 2
Michelle von Maltitz m****e@k****m 2
Samweli s****6@g****m 1
hennie h****e@x****m 1
Committer Domains (Top 20 + Academic)
kartoza.com: 4 xaisim.com: 1 utexas.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 40
  • Total pull requests: 79
  • Average time to close issues: 17 days
  • Average time to close pull requests: 5 days
  • Total issue authors: 4
  • Total pull request authors: 6
  • Average comments per issue: 0.55
  • Average comments per pull request: 0.08
  • Merged pull requests: 59
  • Bot issues: 0
  • Bot pull requests: 13
Past Year
  • Issues: 38
  • Pull requests: 69
  • Average time to close issues: 20 days
  • Average time to close pull requests: 5 days
  • Issue authors: 3
  • Pull request authors: 3
  • Average comments per issue: 0.58
  • Average comments per pull request: 0.09
  • Merged pull requests: 51
  • Bot issues: 0
  • Bot pull requests: 13
View more stats
Top Authors
Issue Authors
  • mvmaltitz (24)
  • timlinux (12)
  • dragosgontariu (2)
  • g4brielvs (2)
Pull Request Authors
  • timlinux (54)
  • dependabot[bot] (13)
  • elbeejay (6)
  • Samweli (2)
  • ClaraIV (2)
  • javaftw (2)
Top Labels
Issue Labels
documentation (2) bug (1)
Pull Request Labels
dependencies (13) python (5) documentation (2)

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 18
proxy.golang.org: github.com/worldbank/GEEST
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
proxy.golang.org: github.com/worldbank/geest
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

Dependencies

.github/workflows/gh-pages.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/black-python-code-linter.yml actions
  • actions/checkout v2 composite
  • psf/black stable composite
.github/workflows/build-docs.yml actions
  • actions/checkout v2 composite
.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
.github/workflows/release.yml actions
  • actions/checkout v2 composite
  • actions/create-release v1 composite
  • actions/setup-python v4 composite
  • actions/upload-release-asset v1 composite
docker-compose.yml docker
  • ${IMAGE} ${QGIS_VERSION_TAG}
docs/requirements.txt pypi
  • docutils ==0.17.1
  • jupyter-book ==1.0.0
requirements-dev.txt pypi
  • Jinja2 ==3.1.5 development
  • Markdown ==3.7 development
  • MarkupSafe ==2.1.5 development
  • PyQt5 ==5.15.11 development
  • PyQt5-Qt5 ==5.15.15 development
  • PyQt5_sip ==12.15.0 development
  • PyYAML ==6.0.2 development
  • Pygments ==2.18.0 development
  • attrs ==23.2.0 development
  • babel ==2.16.0 development
  • black ==24.4.0 development
  • certifi ==2024.8.30 development
  • charset-normalizer ==3.3.2 development
  • click ==8.0.4 development
  • colorama ==0.4.6 development
  • debugpy ==1.8.1 development
  • distlib ==0.3.8 development
  • filelock ==3.13.4 development
  • ghp-import ==2.1.0 development
  • h11 ==0.12.0 development
  • httpcore ==0.13.7 development
  • httpx ==0.20.0 development
  • idna ==3.8 development
  • iniconfig ==2.0.0 development
  • jsonschema ==4.21.1 development
  • jsonschema-specifications ==2023.12.1 development
  • mergedeep ==1.3.4 development
  • mkdocs ==1.6.1 development
  • mkdocs-autorefs ==1.2.0 development
  • mkdocs-get-deps ==0.2.0 development
  • mkdocs-material ==9.5.34 development
  • mkdocs-material-extensions ==1.3.1 development
  • mkdocstrings ==0.26.1 development
  • mypy_extensions ==1.0.0 development
  • numpy ==1.26.4 development
  • packaging ==24.0 development
  • paginate ==0.5.7 development
  • pathspec ==0.12.1 development
  • platformdirs ==4.2.0 development
  • pluggy ==1.4.0 development
  • pymdown-extensions ==10.9 development
  • pytest ==8.1.1 development
  • pytest-qt ==4.4.0 development
  • python-dateutil ==2.9.0.post0 development
  • pyyaml_env_tag ==0.1 development
  • referencing ==0.34.0 development
  • regex ==2024.7.24 development
  • requests ==2.32.3 development
  • rpds-py ==0.17.1 development
  • six ==1.16.0 development
  • toml ==0.10.2 development
  • typer ==0.4.0 development
  • urllib3 ==2.2.2 development
  • virtualenv ==20.26.6 development
  • watchdog ==5.0.2 development