Skip to content

Commit 52e1286

Browse files
authored
Add python binding layout (#15)
* Init Python bindings * fix layout * add gitignore
1 parent 30990ce commit 52e1286

File tree

11 files changed

+2011
-2
lines changed

11 files changed

+2011
-2
lines changed

python/.gitignore

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
146+
# Pyre type checker
147+
.pyre/
148+
149+
# pytype static type analyzer
150+
.pytype/
151+
152+
# Cython debug symbols
153+
cython_debug/
154+
155+
# PyCharm
156+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158+
# and can be added to the global gitignore or merged into this file. For a more nuclear
159+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160+
#.idea/

python/Cargo.toml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[package]
2+
name = "async-tiff"
3+
version = "0.1.0-beta.1"
4+
authors = ["Kyle Barron <kyle@developmentseed.org>"]
5+
edition = "2021"
6+
# description = "Fast, memory-efficient 2D spatial indexes for Python."
7+
readme = "README.md"
8+
repository = "https://github.com/developmentseed/async-tiff"
9+
license = "MIT OR Apache-2.0"
10+
keywords = ["python", "geospatial"]
11+
categories = ["science::geo"]
12+
rust-version = "1.75"
13+
14+
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
15+
[lib]
16+
name = "_async_tiff"
17+
crate-type = ["cdylib"]
18+
19+
[dependencies]
20+
async-tiff = { path = "../" }
21+
bytes = "1.8"
22+
pyo3 = { version = "0.23.0", features = ["macros"] }
23+
pyo3-bytes = "0.1.2"
24+
thiserror = "1"
25+
26+
[profile.release]
27+
lto = true
28+
codegen-units = 1

python/DEVELOP.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
```
2+
uv sync --no-install-package async-tiff
3+
uv run --no-project maturin develop
4+
uv run --no-project mkdocs serve
5+
```

python/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# async-tiff
2+
3+
<!-- [![PyPI][pypi_badge]][pypi_link]
4+
5+
[pypi_badge]: https://badge.fury.io/py/geoindex-rs.svg
6+
[pypi_link]: https://pypi.org/project/geoindex-rs/ -->
7+
8+
Fast, async TIFF and GeoTIFF reader for Python.
9+
10+
<!-- This documentation is for the Python bindings. [Refer here for the Rust crate documentation](https://docs.rs/geo-index). -->
11+

python/pyproject.toml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
[build-system]
2+
requires = ["maturin>=1.4.0,<2.0"]
3+
build-backend = "maturin"
4+
5+
[project]
6+
name = "async-tiff"
7+
requires-python = ">=3.9"
8+
dependencies = []
9+
dynamic = ["version"]
10+
classifiers = [
11+
"Programming Language :: Rust",
12+
"Programming Language :: Python :: Implementation :: CPython",
13+
"Programming Language :: Python :: Implementation :: PyPy",
14+
]
15+
16+
[tool.maturin]
17+
features = ["pyo3/extension-module"]
18+
module-name = "async_tiff._async_tiff"
19+
python-source = "python"
20+
21+
[tool.uv]
22+
dev-dependencies = [
23+
"griffe-inherited-docstrings>=1.0.1",
24+
"ipykernel>=6.29.5",
25+
"maturin>=1.7.4",
26+
"mike>=2.1.3",
27+
"mkdocs-material[imaging]>=9.5.40",
28+
"mkdocs>=1.6.1",
29+
"mkdocstrings-python>=1.13.0",
30+
"mkdocstrings>=0.27.0",
31+
"numpy>=1",
32+
"pip>=24.2",
33+
"pytest>=8.3.3",
34+
"ruff>=0.8.4",
35+
]

python/python/async_tiff/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
from ._async_tiff import ___version
2+
3+
__version__: str = ___version()

python/python/async_tiff/_async_tiff.pyi

Whitespace-only changes.

python/python/async_tiff/py.typed

Whitespace-only changes.

python/src/lib.rs

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
#![deny(clippy::undocumented_unsafe_blocks)]
2+
3+
use pyo3::prelude::*;
4+
5+
const VERSION: &str = env!("CARGO_PKG_VERSION");
6+
7+
#[pyfunction]
8+
fn ___version() -> &'static str {
9+
VERSION
10+
}
11+
12+
/// Raise RuntimeWarning for debug builds
13+
#[pyfunction]
14+
fn check_debug_build(_py: Python) -> PyResult<()> {
15+
#[cfg(debug_assertions)]
16+
{
17+
use pyo3::exceptions::PyRuntimeWarning;
18+
use pyo3::intern;
19+
use pyo3::types::PyTuple;
20+
21+
let warnings_mod = _py.import(intern!(_py, "warnings"))?;
22+
let warning = PyRuntimeWarning::new_err(
23+
"async-tiff has not been compiled in release mode. Performance will be degraded.",
24+
);
25+
let args = PyTuple::new(_py, vec![warning])?;
26+
warnings_mod.call_method1(intern!(_py, "warn"), args)?;
27+
}
28+
29+
Ok(())
30+
}
31+
32+
#[pymodule]
33+
fn _async_tiff(py: Python, m: &Bound<PyModule>) -> PyResult<()> {
34+
check_debug_build(py)?;
35+
36+
m.add_wrapped(wrap_pyfunction!(___version))?;
37+
38+
Ok(())
39+
}

0 commit comments

Comments
 (0)