uber/h3-py

Example repo for a cython package that cimports h3-py

Open

#373 opened on May 19, 2024

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Python (142 forks)github user discovery
help wanted

Repository metrics

Stars
 (1,021 stars)
PR merge metrics
 (Avg merge 24d 19h) (3 merged PRs in 30d)

Description

I think it would be helpful to provide a demo repository for setting up a Python package that cimports the Cython bits of h3-py. We have an example of doing this for a single file in https://github.com/uber/h3-py/blob/master/tests/test_cython/cython_example.pyx

Having an example for a package would help users who want to write fast Cython code with h3 functions outside of the main h3-py repo.

Contributor guide

Research direction
Visit the existing test example at https://github.com/uber/h3 py/blob/master/tests/test cython/cython example.pyx and create a similar setup for a standalone package, including a setup.py or pyproject.toml that builds the cython extension with h3 py as a dependency.
Tech stack
python
Domain
data
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGitCython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60